Patterns for consistent software documentation

  • Authors:

  • Filipe Figueiredo Correia;Ademar Aguiar;Hugo Sereno Ferreira;Nuno Flores

  • Affiliations:

  • Universidade do Porto, Rua Dr. Roberto Frias, s/n;Universidade do Porto, Rua Dr. Roberto Frias, s/n;Universidade do Porto, Rua Dr. Roberto Frias, s/n;Universidade do Porto, Rua Dr. Roberto Frias, s/n

  • Venue:
  • Proceedings of the 16th Conference on Pattern Languages of Programs
  • Year:
  • 2009

Quantified Score

Hi-index 0.00

Visualization

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.