Advanced Search

Content Type

Topics

Publication Date

Experience Using the Web-Based Tool Wiki for Architecture Documentation

  • Author(s): ,
  • Publish Date:
  • Publisher: Software Engineering Institute
  • SEI Identifier: CMU/SEI-2005-TN-041
  • Type: Technical Note
  • Topics: Software Architecture
  • Description: This 2005 report discusses the benefits and challenges of using a wiki-based collaborative environment to create software architecture documentation.

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 nondevelopers to understand what the documents describe, and challenging for nondevelopers 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 that used the wiki tool in a real-world software project. For its customer, 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 Report

Show Citation Formats

SEI

Bachmann, Felix; & Merson, Paulo. Experience Using the Web-Based Tool Wiki for Architecture Documentation (CMU/SEI-2005-TN-041). Software Engineering Institute, Carnegie Mellon University, 2005. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=7561

IEEE

Bachmann. Felix, and Merson. Paulo, "Experience Using the Web-Based Tool Wiki for Architecture Documentation," Software Engineering Institute, Carnegie Mellon University, Pittsburgh, Pennsylvania, Technical Note CMU/SEI-2005-TN-041, 2005. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=7561

APA

Bachmann, Felix., & Merson, Paulo. (2005). Experience Using the Web-Based Tool Wiki for Architecture Documentation (CMU/SEI-2005-TN-041). Retrieved September 17, 2014, from the Software Engineering Institute, Carnegie Mellon University website: http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=7561

CHI

Felix Bachmann, & Paulo Merson. Experience Using the Web-Based Tool Wiki for Architecture Documentation (CMU/SEI-2005-TN-041). Pittsburgh, PA: Software Engineering Institute, Carnegie Mellon University, 2005. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=7561

MLA

Bachmann, Felix., & Merson, Paulo. 2005. Experience Using the Web-Based Tool Wiki for Architecture Documentation (Technical Report CMU/SEI-2005-TN-041). Pittsburgh: Software Engineering Institute, Carnegie Mellon University. http://resources.sei.cmu.edu/library/asset-view.cfm?AssetID=7561