DeepRead
Cover of Documenting Software Architectures

Documenting Software Architectures

Paul Clements · 2002

Programming and computer science › Electronics and computer architecture

#10,673 most recommended

About the book

Software architecture documentation: how to record the structures, components, and relationships of a software system so that the people who build, maintain, and use it can understand it. It covers choosing which architectural views to document, how to present each one, and how to organize the complete document for its readers. Architecture is best documented as a set of views, each showing one structure of the system, such as module, component-and-connector, or allocation structures, because no single view captures everything a stakeholder needs. Each view must be supplemented with information that lies beyond the views itself, including element and interface details, behavior, the rationale behind decisions, and the system's context. The authors argue that documentation should be driven by the needs of its stakeholders rather than by completeness for its own sake, and that it should be kept sufficient, consistent, and reviewed.

Written by Claude from what it knows of this book.

What Hacker News says 67% recommend · 0% critical

012202020212022202320242024 peak · 2
This bookAverage book in Electronics and computer architecture

In the commenters’ own words

What Open Library readers say

No Open Library reader has rated it yet.

  • 10 want to read
  • 1 reading
  • 0 have read

Open Library’s page for the book

What critics say, via Wikipedia

No Wikipedia article about this book yet, so no critics to quote.

Reddit communities — coming later

Details

First published
2002
ISBN
9780321552686
Editions known
4 at Open Library
Open Library
OL16919500W

Computer architectureComputer software, developmentElectronic data processing documentationSoftware documentation

Explore in the mosaic

Read next: its neighbours on the mosaic