Which documentation for software maintenance?-Reference-Cited by-同舟云学术

Which documentation for software maintenance?

Published:2006-10 Issue:3 Volume:12 Page:31-44
ISSN:0104-6500
Container-title:Journal of the Brazilian Computer Society
language:en
Short-container-title:J Braz Comp Soc

Author:

de Souza Sergio Cozzetti B.,Anquetil Nicolas,de Oliveira Káthia M.

Abstract

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.

Publisher

Springer Science and Business Media LLC

Subject

General Computer Science

Link

https://link.springer.com/content/pdf/10.1007/BF03194494.pdf

Reference27 articles.

1. S. W. Ambler. Agile documentation. available on the internet at: http://www.agilemodeling.com/essays/ agile-Documentation.htm, 2001–2005. Last accessed on May 27, 2005.

2. N. Anquetil, K. M. Oliveira, A. G. dos Santos, P. C. da Silva jr., L. C. de Araujo jr., and S. D. Vieira. A tool to automate re-documentation. InForum of the CAISE, Conference on Advanced Information Systems Engineering (CAiSE’05), jun. 15 2005. accepted for publication.

3. L. C. Briand. Software documentation: How much is enough. InProceedings of the Seventh European Conference on Software Maintenance and Reengineering (CSMR’03), pages 13–17. IEEE, IEEE Comp. Soc. Press, March 26–28 2003.

4. F. A. Cioch and M. Palazzolo. A documentation suite for maintenance programmers. InProceedings of the 1996 International Conference on Software Maintenance (ICSM’96), pages 286–95. IEEE, IEEE Comp. Soc. Press, Nov 1996.

5. A. Forward and T. C. Lethbridge. The relevance of software documentation, tools and technologies: a survey. In DocEng ’02:Proceedings of the 2002 ACM symposium on Document engineering, pages 26–33, New York, NY, USA, 2002. ACM Press.

Cited by 8 articles. 订阅此论文施引文献订阅此论文施引文献，注册后可以免费订阅5篇论文的施引文献，订阅后可以查看论文全部施引文献

1. What do class comments tell us? An investigation of comment evolution and practices in Pharo Smalltalk;Empirical Software Engineering;2021-08-18

2. Software Redocumentation Using Distributed Data Processing Technique to Support Program Understanding for Legacy System: A Proposed Approach;Advances in Visual Informatics;2021

3. Identifying self-admitted technical debt through code comment analysis with a contextualized vocabulary;Information and Software Technology;2020-05

4. Identifying Technical Debt through a Code Comment Mining Tool;Proceedings of the XV Brazilian Symposium on Information Systems;2019-05-20

5. Applying pattern-driven maintenance;Proceedings of the 12th ACM/IEEE International Symposium on Empirical Software Engineering and Measurement;2018-10-11