search menu icon-carat-right cmu-wordmark

Experience Using the Web-Based Tool Wiki for Architecture Documentation

Technical Note
This 2005 report discusses the benefits and challenges of using a wiki-based collaborative environment to create software architecture documentation.
Publisher

Software Engineering Institute

CMU/SEI Report Number
CMU/SEI-2005-TN-041
DOI (Digital Object Identifier)
10.1184/R1/6573647.v1

Abstract

In an organization that uses an architecture-centric development approach, it is the purpose of the software architecture, especially the product documentation, to guide all stakeholders who contribute in one way or another to the development of the product(s). Unfortunately, in many organizations, this documentation ends up on the shelves, unused and collecting dust. This happens in part because it is difficult to keep the architecture documentation current, hard for non-developers to understand what the documents describe, and challenging for non-developers to use the tools necessary to access the documentation.  

This technical note discusses the benefits and challenges of using a wiki-based collaborative environment to create software architecture documentation. The findings are based on two experiences. The first was that of a team of Carnegie Mellon University Master of Software Engineering (MSE) program students who used the wiki tool in a real-world software project. For its customers, the team had to produce and document the architecture of a system that will be developed by many geographically distributed teams. The second experience was a study conducted by another MSE student to reconstruct and document the architecture of a multitier enterprise application using the wiki tool and UML 2.0.

Cite This Technical Note

Bachmann, F., & Merson, P. (2005, September 1). Experience Using the Web-Based Tool Wiki for Architecture Documentation. (Technical Note CMU/SEI-2005-TN-041). Retrieved April 13, 2024, from https://doi.org/10.1184/R1/6573647.v1.

@techreport{bachmann_2005,
author={Bachmann, Felix and Merson, Paulo},
title={Experience Using the Web-Based Tool Wiki for Architecture Documentation},
month={Sep},
year={2005},
number={CMU/SEI-2005-TN-041},
howpublished={Carnegie Mellon University, Software Engineering Institute's Digital Library},
url={https://doi.org/10.1184/R1/6573647.v1},
note={Accessed: 2024-Apr-13}
}

Bachmann, Felix, and Paulo Merson. "Experience Using the Web-Based Tool Wiki for Architecture Documentation." (CMU/SEI-2005-TN-041). Carnegie Mellon University, Software Engineering Institute's Digital Library. Software Engineering Institute, September 1, 2005. https://doi.org/10.1184/R1/6573647.v1.

F. Bachmann, and P. Merson, "Experience Using the Web-Based Tool Wiki for Architecture Documentation," Carnegie Mellon University, Software Engineering Institute's Digital Library. Software Engineering Institute, Technical Note CMU/SEI-2005-TN-041, 1-Sep-2005 [Online]. Available: https://doi.org/10.1184/R1/6573647.v1. [Accessed: 13-Apr-2024].

Bachmann, Felix, and Paulo Merson. "Experience Using the Web-Based Tool Wiki for Architecture Documentation." (Technical Note CMU/SEI-2005-TN-041). Carnegie Mellon University, Software Engineering Institute's Digital Library, Software Engineering Institute, 1 Sep. 2005. https://doi.org/10.1184/R1/6573647.v1. Accessed 13 Apr. 2024.

Bachmann, Felix; & Merson, Paulo. Experience Using the Web-Based Tool Wiki for Architecture Documentation. CMU/SEI-2005-TN-041. Software Engineering Institute. 2005. https://doi.org/10.1184/R1/6573647.v1