Software Engineering Institute | Carnegie Mellon University
Software Engineering Institute | Carnegie Mellon University

Digital Library

Javascript is currently disabled for your browser. For an optimal search experience, please enable javascript.

Advanced Search

Basic Search

Content Type

Topics

Publication Date

Technical Note

A Structured Approach for Reviewing Architecture Documentation

  • December 2009
  • By Robert Nord, Paul C. Clements, David Emery, Rich Hilliard
  • 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.
  • Software Architecture
  • Publisher: Software Engineering Institute
    CMU/SEI Report Number: CMU/SEI-2009-TN-030
  • 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.

  • Download

Part of a Collection

Views and Beyond Collection

Cite This Report

SEI

Nord, Robert; Clements, Paul; Emery, David; & Hilliard, Rich. A Structured Approach for Reviewing Architecture Documentation. CMU/SEI-2009-TN-030. Software Engineering Institute, Carnegie Mellon University. 2009. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9045

IEEE

Nord. Robert, Clements. Paul, Emery. David, and Hilliard. Rich, "A Structured Approach for Reviewing Architecture Documentation," Software Engineering Institute, Carnegie Mellon University, Pittsburgh, Pennsylvania, Technical Note CMU/SEI-2009-TN-030, 2009. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9045

APA

Nord, Robert., Clements, Paul., Emery, David., & Hilliard, Rich. (2009). A Structured Approach for Reviewing Architecture Documentation (CMU/SEI-2009-TN-030). Retrieved December 05, 2016, from the Software Engineering Institute, Carnegie Mellon University website: http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9045

CHI

Robert Nord, Paul Clements, David Emery, & Rich Hilliard. A Structured Approach for Reviewing Architecture Documentation (CMU/SEI-2009-TN-030). Pittsburgh, PA: Software Engineering Institute, Carnegie Mellon University, 2009. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9045

MLA

Nord, Robert., Clements, Paul., Emery, David., & Hilliard, Rich. 2009. A Structured Approach for Reviewing Architecture Documentation (Technical Report CMU/SEI-2009-TN-030). Pittsburgh: Software Engineering Institute, Carnegie Mellon University. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9045

BibTex

@techreport{NordAStructured2009,
title={A Structured Approach for Reviewing Architecture Documentation},
author={Robert Nord and Paul Clements and David Emery and Rich Hilliard},
year={2009},
number={CMU/SEI-2009-TN-030},
institution={Software Engineering Institute, Carnegie Mellon University},
address={Pittsburgh, PA},
url={http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=9045} }