A study of the documentation essential to software maintenance

Proceedings of the 23rd International Conference on Design of Communication - Documenting and Designing for Pervasive Information

Volumn , Issue , 2005, Pages 68-75

  De Souza, Sergio Cozzetti B ^a   Anquetil, Nicolas ^a   De Oliveira, Káthia M ^a  

^a UNIVERSIDADE CATÓLICA DE BRASÍLIA   (Brazil)

Author keywords

Empirical study; Program understanding; Software maintenance; Software system documentation

Indexed keywords

EMPIRICAL STUDY; PROGRAM UNDERSTANDING; SOFTWARE SYSTEM DOCUMENTATION;

COMPUTER SOFTWARE; COMPUTER SOFTWARE MAINTENANCE; SOFTWARE ENGINEERING;

PROGRAM DOCUMENTATION;

EID: 84890998907     PISSN: None     EISSN: None     Source Type: Conference Proceeding    
DOI: 10.1145/1085313.1085331     Document Type: Conference Paper

References (25)

1. V. M. aes Teles. Extreme Programming. Novatec Editora Ltda, Rua cons. Moreira de Barros, 1084, conj. 01, São Paulo, SP, 02018-012, Brazil, 2004, ISBN: 85-7522-047-0.
2. S. W. Ambler. Agile documentation, available on the internet at: http://www.agilemodeling.com/essays/agileDocumentation.htm, 2001-2005. Last accessed on May 27, 2005.
3. N. Anquetil, K. M. Oliveira, A. G. dos Santos. P. C. da Silva jr., L. C. de Araujo jr., and S. D. Vicira. A tool to automate re-documentation. In Forum of the CAISE, Conference on Advanced Information Systems Engineering (CAiSE'05), jun. 15 2005. accepted for publication.
4. M. J. ao Sousa. A survey on the software maintenance process. In International Conference on Software Maintenance, ICSM'98, pages 265- 74. IEEE, IEEE Comp. Soc. Press, Mar. 1998.
5. L. C. Briand. Software documentation: How much is enough. In Proceedings of the Seventh European Conference on Software Maintenance and Reengineering (CSMR '03), pages 13-17, IEEE, IEEE Comp, Soc, Press, March 26 - 28 2003.
6. F. A. Cioch and M. Palazzolo. A documentation suite for maintenance programmers, In Proceedings of the 1996 International Conference on Software Maintenance (ICSM'96), pages 286-95. IEEE, IEEE Comp. Soc. Press, Nov 1996.
7. 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.
8. P. Grubb and A. Takang. Software Maintenance: Concepts and Practice. World Scientific Publishing Co., Singapore, 2nd edition, 2003.
9. HCI. What to put in software maintenance documentation. Available on the Internet at: http://www.hci.com.au/hcisite2/journal/What to put in software maintenance documentation.htm, 2001-2002. Last accessed on May 27, 2005.
10. S. Huang and S. Tilley. Towards a documentation maturity model. In SIGDOC '03: Proceedings of the 21st annual international conference on Documentation, pages 93-99, New York, NY, USA, 2003. ACM Press.
11. M, Kajko-Mattsson. The state of documentation practice within corrective maintenance. In Proceedings of the International Conference on Software Maintenance (ICSM'01), pages 354-363. IEEE, IEEE Comp. Soc. Press, Nov. 07-09 2001.
12. B. A. Kitchenham, G. H. Travassos, A. von Mayrhauser, F. Niessink, N. F. Schneidewind, J. Singer, S. Takada, R. Vehvilainen, and H. Yang. Towards an ontology of software maintenance. Journal of Software Maintenance: Research and Practice, 11:365-389, 1999.
13. M. Lehman, Programs, life cycles and the laws of software evolution. Proceedings of the IEEE, 68(9):1060-76, sept. 1980.
14. M. Lindvall, V. R. Basili, B. W. Boehm, P. Costa, K. Dangle, F. Shull, R. Tesoriero, L. A. Williams, and M. V. Zelkowitz. Empirical findings in agile methods. In Proceedings of the Second XP Universe and First Agile Universe Conference on Extreme Programming and Agile Methods - XP/Agile Universe 2002, pages 197-207, London, UK, 2002. Springer-Verlag.
15. S. L. Pfieeger. Software Engineering: Theory and Practice. Prentice Hall, 2nd edition, 2001.
16. V. Phoha, A standard for software documentation. Computer, 30(10):97 98, Oct. 1997.
17. T. M. Pigoski. Practical Software Maintenance: Best Practices for Software Investment. John Wiley & Sons, Inc., 1996.
18. C. J. Poole, T. Murphy, J. W. Huisman, and A. Higgins, Extreme maintenance. In International Conference on Software Maintenance, ICSM'01, pages 301-10, IEEE, IEEE Comp. Soc. Press, Nov. 2001.
19. R. S. Pressman. Software Engineering: A Practitioner's Approach. McGraw-Hill, 5th edition, 2001.
20. V. Rajlich. Incremental redocumentation using the web, IEEE Software, 17(5): 102-6, Sep 2000.
21. R. C. Seacord, D. plakosh, and G. A. Lewis, Modernizing Legacy Systems - Software technologies, engineering processes, and business practices. Addison-Wesley, 2003.
22. B. Thomas and S. Tilley, Documentation for software engineers: what is needed to aid system understanding? In SIGDOC '01: Proceedings of the 19th annual international conference on Computer documentation, pages 235-236, New York, NY, USA, 2001. ACM Press.
23. S. Tilley and H. Müller. Info: a simple document annotation facility. In SIGDOC '91: Proceedings of the 9th annual international conference on Systems documentation, pages 30-36, New York, NY, USA, 1991. ACM Press.
24. S. R. Tilley. Documenting-in-the-large vs. documenting-in-the-small. In Proceedings of CASCON'93, pages 1083-90. IBM Centre for Advanced Studies, Oct. 1993.
25. S. R. Tilley, H. A. Müeller, and M. A. Orgun. Documenting software systems with views. In Proceedings of the 10th International Conference on Systems Documentation, SIGDOC'92, pages 211-19. ACM, ACM Press, Oct 1992.