Research indexJournal article
Patterns for consistent software documentation
Correia, Aguiar, Ferreira and 1 other
28 Aug 2009
NobleIDark:/48914/w1/20260515/9F9D9791DOI10.1145/1943226.1943241
Patterns for consistent software documentation
Correia, Aguiar, Ferreira and 1 other · 2009 · Subscription
NobleIDark:/48914/w1/20260515/9F9D9791DOI10.1145/1943226.1943241
The full text is at the publisher
You can read the abstract here, or open it at the publisher.
Abstract
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 requires a considerable effort. Existing solutions encompass different tools and approaches that support the process of creating, evolving and using documents and other artifacts derived from the software development process. Based on existing literature and expertise, we have identified the key problems and solutions for documentation consistency. In concrete, four distinct patterns and their relations were identified, which are here described --- Information Proximity, Co-Evolution, Domain-Structured Information and Integrated Environment.