search menu icon-carat-right cmu-wordmark

A Structured Approach for Reviewing Architecture Documentation

Technical Note
This technical note proposes a structured approach for reviewing architecture documentation that is centered on the documentation's stakeholders and engages them in a guided manner so as to ensure that the documentation will be ultimately useful to them.
Publisher

Software Engineering Institute

CMU/SEI Report Number
CMU/SEI-2009-TN-030
DOI (Digital Object Identifier)
10.1184/R1/6571757.v1

Abstract

This technical note proposes a structured approach for reviewing architecture documentation. Given the critical importance of architecture to software project success, it follows that the architecture cannot be effective unless it is effectively captured in documentation that allows the architecture's stakeholders to understand and use the architecture in the way it was intended. The approach does not assume a particular architecture methodology or a particular architecture documentation practice, although it was conceived in the context of the International Organization for Standardization (ISO) Recommended Practice for Architecture Description of Software-Intensive Systems and the SEI Views and Beyond approach to documenting software architectures. Like both of them, our approach is centered on the stakeholders of the artifact, engaging them in a focused, guided way to ensure that the documentation carries sufficient quality to enable them to do their jobs and to help them point out gaps and weaknesses. Our approach is not intended as a complete framework for architecture evaluation; rather, it is meant to be used within such a framework, when one is available.

Part of a Collection

Views and Beyond Collection

Cite This Technical Note

Nord, R., Clements, P., Emery, D., & Hilliard, R. (2009, December 1). A Structured Approach for Reviewing Architecture Documentation. (Technical Note CMU/SEI-2009-TN-030). Retrieved February 27, 2024, from https://doi.org/10.1184/R1/6571757.v1.

@techreport{nord_2009,
author={Nord, Robert and Clements, Paul and Emery, David and Hilliard, Rich},
title={A Structured Approach for Reviewing Architecture Documentation},
month={Dec},
year={2009},
number={CMU/SEI-2009-TN-030},
howpublished={Carnegie Mellon University, Software Engineering Institute's Digital Library},
url={https://doi.org/10.1184/R1/6571757.v1},
note={Accessed: 2024-Feb-27}
}

Nord, Robert, Paul Clements, David Emery, and Rich Hilliard. "A Structured Approach for Reviewing Architecture Documentation." (CMU/SEI-2009-TN-030). Carnegie Mellon University, Software Engineering Institute's Digital Library. Software Engineering Institute, December 1, 2009. https://doi.org/10.1184/R1/6571757.v1.

R. Nord, P. Clements, D. Emery, and R. Hilliard, "A Structured Approach for Reviewing Architecture Documentation," Carnegie Mellon University, Software Engineering Institute's Digital Library. Software Engineering Institute, Technical Note CMU/SEI-2009-TN-030, 1-Dec-2009 [Online]. Available: https://doi.org/10.1184/R1/6571757.v1. [Accessed: 27-Feb-2024].

Nord, Robert, Paul Clements, David Emery, and Rich Hilliard. "A Structured Approach for Reviewing Architecture Documentation." (Technical Note CMU/SEI-2009-TN-030). Carnegie Mellon University, Software Engineering Institute's Digital Library, Software Engineering Institute, 1 Dec. 2009. https://doi.org/10.1184/R1/6571757.v1. Accessed 27 Feb. 2024.

Nord, Robert; Clements, Paul; Emery, David; & Hilliard, Rich. A Structured Approach for Reviewing Architecture Documentation. CMU/SEI-2009-TN-030. Software Engineering Institute. 2009. https://doi.org/10.1184/R1/6571757.v1