search menu icon-carat-right cmu-wordmark

Creating and Using Software Architecture Documentation Using Web-Based Tool Support

Technical Note
This report describes a design prototype that demonstrates a web-based approach to creating, communicating, and using software architecture throughout the life of the system.
Publisher

Software Engineering Institute

CMU/SEI Report Number
CMU/SEI-2004-TN-037

Abstract

Documenting software architecture (DSA) is a crucial facet in the development of a software system, yet often it is carried out in a haphazard fashion, if at all. Lack of attention to the documentation results from insufficient guidance about what should be documented and when and how to capture the information so that system stakeholders find it useful. The book Documenting Software Architectures: Views and Beyond provides such guidance in the DSA approach, and this report describes the conceptual design for a documentation system based on that approach. A system is envisioned that enables the architect to capture architectural decisions and related artifacts as a living repository that can communicate information to stakeholders who might be both geographically and temporally distributed. The system must communicate in a way that allows each stakeholder quick and easy access to information relevant to the person's role in the software development process. This report describes a design prototype that demonstrates a Web-based approach to creating, communicating, and using software architecture throughout the life of the system.

Cite This Technical Note

Stafford, J. (2004, September 1). Creating and Using Software Architecture Documentation Using Web-Based Tool Support. (Technical Note CMU/SEI-2004-TN-037). Retrieved February 29, 2024, from https://insights.sei.cmu.edu/library/creating-and-using-software-architecture-documentation-using-web-based-tool-support/.

@techreport{stafford_2004,
author={Stafford, Judith},
title={Creating and Using Software Architecture Documentation Using Web-Based Tool Support},
month={Sep},
year={2004},
number={CMU/SEI-2004-TN-037},
howpublished={Carnegie Mellon University, Software Engineering Institute's Digital Library},
url={https://insights.sei.cmu.edu/library/creating-and-using-software-architecture-documentation-using-web-based-tool-support/},
note={Accessed: 2024-Feb-29}
}

Stafford, Judith. "Creating and Using Software Architecture Documentation Using Web-Based Tool Support." (CMU/SEI-2004-TN-037). Carnegie Mellon University, Software Engineering Institute's Digital Library. Software Engineering Institute, September 1, 2004. https://insights.sei.cmu.edu/library/creating-and-using-software-architecture-documentation-using-web-based-tool-support/.

J. Stafford, "Creating and Using Software Architecture Documentation Using Web-Based Tool Support," Carnegie Mellon University, Software Engineering Institute's Digital Library. Software Engineering Institute, Technical Note CMU/SEI-2004-TN-037, 1-Sep-2004 [Online]. Available: https://insights.sei.cmu.edu/library/creating-and-using-software-architecture-documentation-using-web-based-tool-support/. [Accessed: 29-Feb-2024].

Stafford, Judith. "Creating and Using Software Architecture Documentation Using Web-Based Tool Support." (Technical Note CMU/SEI-2004-TN-037). Carnegie Mellon University, Software Engineering Institute's Digital Library, Software Engineering Institute, 1 Sep. 2004. https://insights.sei.cmu.edu/library/creating-and-using-software-architecture-documentation-using-web-based-tool-support/. Accessed 29 Feb. 2024.

Stafford, Judith. Creating and Using Software Architecture Documentation Using Web-Based Tool Support. CMU/SEI-2004-TN-037. Software Engineering Institute. 2004. https://insights.sei.cmu.edu/library/creating-and-using-software-architecture-documentation-using-web-based-tool-support/