Open Access

Which documentation for software maintenance?

  • Sergio Cozzetti B. de Souza1,
  • Nicolas Anquetil1 and
  • Káthia M. de Oliveira1
Journal of the Brazilian Computer Society12:BF03194494

DOI: 10.1007/BF03194494

Abstract

Software engineering has been striving for years to improve the practice of software development and maintenance. Documentation has long been prominent on the list of recommended practices to improve development and help maintenance. Recently however, agile methods started to shake this view, arguing that the goal of the game is to produce software and that documentation is only useful as long as it helps to reach this goal.

On the other hand, in the re-engineering field, people wish they could re-document useful legacy software so that they may continue maintain them or migrate them to new platform.

In these two case, a crucial question arises: “How much documentation is enough?” In this article, we present the results of a survey of software maintainers to try to establish what documentation artifacts are the most important to them.