Advanced Search

Content Type

Topics

Publication Date

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

  • Author(s): Judith A. Stafford
  • Publish Date:
  • Publisher: Software Engineering Institute
  • SEI Identifier: CMU/SEI-2004-TN-037
  • Type: Technical Note
  • Topics: Software Architecture
  • Description: 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.

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 Report

Show Citation Formats

SEI

Stafford, Judith. Creating and Using Software Architecture Documentation Using Web-Based Tool Support (CMU/SEI-2004-TN-037). Software Engineering Institute, Carnegie Mellon University, 2004. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=6997

IEEE

Stafford. Judith, "Creating and Using Software Architecture Documentation Using Web-Based Tool Support," Software Engineering Institute, Carnegie Mellon University, Pittsburgh, Pennsylvania, Technical Note CMU/SEI-2004-TN-037, 2004. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=6997

APA

Stafford, Judith. (2004). Creating and Using Software Architecture Documentation Using Web-Based Tool Support (CMU/SEI-2004-TN-037). Retrieved November 28, 2014, from the Software Engineering Institute, Carnegie Mellon University website: http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=6997

CHI

Judith Stafford. Creating and Using Software Architecture Documentation Using Web-Based Tool Support (CMU/SEI-2004-TN-037). Pittsburgh, PA: Software Engineering Institute, Carnegie Mellon University, 2004. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=6997

MLA

Stafford, Judith. 2004. Creating and Using Software Architecture Documentation Using Web-Based Tool Support (Technical Report CMU/SEI-2004-TN-037). Pittsburgh: Software Engineering Institute, Carnegie Mellon University. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=6997