Advanced Search

Content Type

Topics

Publication Date

Documenting Software Architectures: Organization of Documentation Package

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 Report

Show Citation Formats

SEI

Bachmann, Felix; Bass, Len; Clements, Paul; Garlan, David; Ivers, James; Little, M.; Nord, Robert; & Stafford, Judith. Documenting Software Architectures: Organization of Documentation Package (CMU/SEI-2001-TN-010). Software Engineering Institute, Carnegie Mellon University, 2001. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5471

IEEE

Bachmann. Felix, Bass. Len, Clements. Paul, Garlan. David, Ivers. James, Little. M., Nord. Robert, and Stafford. Judith, "Documenting Software Architectures: Organization of Documentation Package," Software Engineering Institute, Carnegie Mellon University, Pittsburgh, Pennsylvania, Technical Note CMU/SEI-2001-TN-010, 2001. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5471

APA

Bachmann, Felix., Bass, Len., Clements, Paul., Garlan, David., Ivers, James., Little, M.., Nord, Robert., & Stafford, Judith. (2001). Documenting Software Architectures: Organization of Documentation Package (CMU/SEI-2001-TN-010). Retrieved July 28, 2014, from the Software Engineering Institute, Carnegie Mellon University website: http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5471

CHI

Felix Bachmann, Len Bass, Paul Clements, David Garlan, James Ivers, M. Little, Robert Nord, & Judith Stafford. Documenting Software Architectures: Organization of Documentation Package (CMU/SEI-2001-TN-010). Pittsburgh, PA: Software Engineering Institute, Carnegie Mellon University, 2001. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5471

MLA

Bachmann, Felix., Bass, Len., Clements, Paul., Garlan, David., Ivers, James., Little, M.., Nord, Robert., & Stafford, Judith. 2001. Documenting Software Architectures: Organization of Documentation Package (Technical Report CMU/SEI-2001-TN-010). Pittsburgh: Software Engineering Institute, Carnegie Mellon University. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=5471