Documenting Software Architectures: Organization of Documentation Package
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.
This report is related to the following area(s) of work:
Software ArchitectureTechnical Note
CMU/SEI-2001-TN-010
August 2001
Cite This Report
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://www.sei.cmu.edu/library/abstracts/reports/01tn010.cfm
IEEE:
F. Bachmann, L. Bass, P. Clements, D. Garlan, J. Ivers, M. Little, R. Nord, and J. Stafford, "Documenting Software Architectures: Organization of Documentation Package," Software Engineering Institute, Carnegie Mellon University, Pittsburgh, Pennsylvania, Technical Note CMU/SEI-2001-TN-010, 2001. http://www.sei.cmu.edu/library/abstracts/reports/01tn010.cfm
APA:
Bachmann, F., Bass, L., Clements, P., Garlan, D., Ivers, J., Little, M., Nord, R., & Stafford, J. (2001). Documenting Software Architectures: Organization of Documentation Package (CMU/SEI-2001-TN-010). Retrieved May 22, 2013, from the Software Engineering Institute, Carnegie Mellon University website: http://www.sei.cmu.edu/library/abstracts/reports/01tn010.cfm
CHI:
Bachmann, Felix, Len Bass, Paul Clements, David Garlan, James Ivers, M. Little, Robert Nord, and Judith Stafford. Documenting Software Architectures: Organization of Documentation Package (CMU/SEI-2001-TN-010). Pittsburgh, PA: Software Engineering Institute, Carnegie Mellon University, 2001. http://www.sei.cmu.edu/library/abstracts/reports/01tn010.cfm
MLA:
Bachmann, F., Bass, L., Clements, P., Garlan, D., Ivers, J., Little, M., Nord, R., & Stafford, J. 2001. Documenting Software Architectures: Organization of Documentation Package (Technical Report CMU/SEI-2001-TN-010). Pittsburgh: Software Engineering Institute, Carnegie Mellon University. http://www.sei.cmu.edu/library/abstracts/reports/01tn010.cfm
Find Us Here
Share This Page
For more information
