Patterns for Consistent Software Documentation

• Type: Article in International Conference Proceedings Book
• Date: 2009

Authors

Filipe Figueiredo Correia (Author) FEUP; Hugo Sereno Ferreira (Author) FEUP; Nuno Flores (Author) FEUP; Ademar Aguiar (Author) FEUP

Conference proceedings International

Title: Proceedings of the 16th Conference on Pattern Languages of Programs (PLoP)

Pattern Languages of Programs (PLoP)

Chicago, Illinois, USA., 28 - 30 August 2009

Scientific classification

FOS: Engineering and technology > Electrical engineering, Electronic engineering, Information engineering

Other information

Abstract (EN): Documentation is an important part of the captured knowledge of a software project, providing a flexible and effective way of recording informal contents. However, maintaining documentation’s consistency presents several challenges. The present pattern language describes complementing solutions for maintaining the consistency of software documentation, focusing on different tools and approaches that support such activities. Ten distinct patterns and their relations are described — Views, Transclusion, Links, Single Source. Heterogeneous Document, Synchronous Co-Evolution, Time-Shifted Co-Evolution, Auditable Document, Domain-Structured Information and Integrated Environment.

Language: Portuguese

Type (Professor's evaluation): Scientific