search menu icon-carat-right cmu-wordmark

Documenting Software Architectures: Organization of Documentation Package

Technical Note
This comprehensive handbook outlines how to produce high-quality documentation for software architectures.
Publisher

Software Engineering Institute

CMU/SEI Report Number
CMU/SEI-2001-TN-010

Abstract

This report represents a milestone of a work in progress. That work is a comprehensive handbook on how to produce high-quality documentation for software architectures. The handbook, tentatively entitled Documenting Software Architectures, will be published in early 2002 by Addison Wesley Longman as part of the SEI Series on Software Engineering. Since this report is a snapshot of current work, the material described here may change before the handbook is published. 

The theme of the report is that documenting an architecture entails documenting the set of relevant views of that architecture, and then completing the picture by documenting information that transcends any single view. The audience for Documenting Software Architectures is the community of practicing architects, apprentice architects, and developers who receive architectural documentation.

Cite This Technical Note

Bachmann, F., Bass, L., Clements, P., Garlan, D., Ivers, J., Little, R., Nord, R., & Stafford, J. (2001, August 1). Documenting Software Architectures: Organization of Documentation Package. (Technical Note CMU/SEI-2001-TN-010). Retrieved May 21, 2024, from https://insights.sei.cmu.edu/library/documenting-software-architectures-organization-of-documentation-package/.

@techreport{bachmann_2001,
author={Bachmann, Felix and Bass, Len and Clements, Paul and Garlan, David and Ivers, James and Little, Reed and Nord, Robert and Stafford, Judith},
title={Documenting Software Architectures: Organization of Documentation Package},
month={Aug},
year={2001},
number={CMU/SEI-2001-TN-010},
howpublished={Carnegie Mellon University, Software Engineering Institute's Digital Library},
url={https://insights.sei.cmu.edu/library/documenting-software-architectures-organization-of-documentation-package/},
note={Accessed: 2024-May-21}
}

Bachmann, Felix, Len Bass, Paul Clements, David Garlan, James Ivers, Reed Little, Robert Nord, and Judith Stafford. "Documenting Software Architectures: Organization of Documentation Package." (CMU/SEI-2001-TN-010). Carnegie Mellon University, Software Engineering Institute's Digital Library. Software Engineering Institute, August 1, 2001. https://insights.sei.cmu.edu/library/documenting-software-architectures-organization-of-documentation-package/.

F. Bachmann, L. Bass, P. Clements, D. Garlan, J. Ivers, R. Little, R. Nord, and J. Stafford, "Documenting Software Architectures: Organization of Documentation Package," Carnegie Mellon University, Software Engineering Institute's Digital Library. Software Engineering Institute, Technical Note CMU/SEI-2001-TN-010, 1-Aug-2001 [Online]. Available: https://insights.sei.cmu.edu/library/documenting-software-architectures-organization-of-documentation-package/. [Accessed: 21-May-2024].

Bachmann, Felix, Len Bass, Paul Clements, David Garlan, James Ivers, Reed Little, Robert Nord, and Judith Stafford. "Documenting Software Architectures: Organization of Documentation Package." (Technical Note CMU/SEI-2001-TN-010). Carnegie Mellon University, Software Engineering Institute's Digital Library, Software Engineering Institute, 1 Aug. 2001. https://insights.sei.cmu.edu/library/documenting-software-architectures-organization-of-documentation-package/. Accessed 21 May. 2024.

Bachmann, Felix; Bass, Len; Clements, Paul; Garlan, David; Ivers, James; Little, Reed; Nord, Robert; & Stafford, Judith. Documenting Software Architectures: Organization of Documentation Package. CMU/SEI-2001-TN-010. Software Engineering Institute. 2001. https://insights.sei.cmu.edu/library/documenting-software-architectures-organization-of-documentation-package/