This report represents another milestone of a work in progress: a comprehensive handbook on
how to produce high-quality documentation for software architectures. The handbook, tentatively titled Documenting Software Architectures, will be published in early 2002 by
Addison-Wesley as part of the Software Engineering Institute (SEI) Series on Software Engineering.
The book is intended to address a lack of language-independent guidance about how to capture an architecture in a written form that can provide a unified design vision to all of the stakeholders on a development project.
A central precept of the book is that documenting an architecture entails two essential steps:
(1) documenting the set of relevant views of that architecture, and then completing the picture
by (2) documenting information that transcends any single view. The book’s audience is the
community of practicing architects, apprentice architects, and developers who receive architectural documentation.
This technical note describes ways to document an important but often overlooked aspect of
software architecture: the behavior of systems, subsystems, and components.
- 11 Aug 2006
- HTML online version
- Please feel free to discuss this article directly on this page. Constructive comments are welcomed! Please sign your TWiki name.
| Title || Documenting Software Architecture: Documenting Behavior |
| Authors || F. Bachmann, L. Bass, P. Clements, D. Garlan, J. Ivers, R. Little, R. Nord, and J. Stafford |
| Type || Other |
| Conference/Journal Title || |
| Volume/Number || TECHNICAL NOTE CMU/SEI-2002-TN-001 |
| Editors || |
| Publisher || |
| Month || January |
| Year || 2002 |
| Pages || 52 |
| Keywords || Software Architecture, UML, Collaboration Diagrams, MetaH, MSC, Rapide, SDL, Sequence Diagrams, Statecharts, Use Case Maps, Z |