Software Engineering Institute | Carnegie Mellon University
Software Engineering Institute | Carnegie Mellon University

Digital Library

Javascript is currently disabled for your browser. For an optimal search experience, please enable javascript.

Advanced Search

Basic Search

Content Type

Topics

Publication Date

Technical Note

Documenting Software Architecture: Documenting Behavior

  • Abstract

    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 books 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.

  • Download

Cite This Report

SEI

Bachmann, Felix; Bass, Len; Clements, Paul; Garlan, David; Ivers, James; Little, M.; Nord, Robert; & Stafford, Judith. Documenting Software Architecture: Documenting Behavior (CMU/SEI-2002-TN-001 ). Software Engineering Institute, Carnegie Mellon University, 2002. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5847

IEEE

Bachmann. Felix, Bass. Len, Clements. Paul, Garlan. David, Ivers. James, Little. M., Nord. Robert, and Stafford. Judith, "Documenting Software Architecture: Documenting Behavior," Software Engineering Institute, Carnegie Mellon University, Pittsburgh, Pennsylvania, Technical Note CMU/SEI-2002-TN-001 , 2002. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5847

APA

Bachmann, Felix., Bass, Len., Clements, Paul., Garlan, David., Ivers, James., Little, M.., Nord, Robert., & Stafford, Judith. (2002). Documenting Software Architecture: Documenting Behavior (CMU/SEI-2002-TN-001 ). Retrieved December 20, 2014, from the Software Engineering Institute, Carnegie Mellon University website: http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5847

CHI

Felix Bachmann, Len Bass, Paul Clements, David Garlan, James Ivers, M. Little, Robert Nord, & Judith Stafford. Documenting Software Architecture: Documenting Behavior (CMU/SEI-2002-TN-001 ). Pittsburgh, PA: Software Engineering Institute, Carnegie Mellon University, 2002. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5847

MLA

Bachmann, Felix., Bass, Len., Clements, Paul., Garlan, David., Ivers, James., Little, M.., Nord, Robert., & Stafford, Judith. 2002. Documenting Software Architecture: Documenting Behavior (Technical Report CMU/SEI-2002-TN-001 ). Pittsburgh: Software Engineering Institute, Carnegie Mellon University. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5847