Evolution of program documentation through a long-term project

Subscribe (Full Service)


	Search: The ACM Digital Library The Guide

	Feedback

Evolution of program documentation through a long-term project

Full text

Pdf (638 KB)

Source

ACM Special Interest Group for Design of Communication archive
Proceedings of the 4th annual international conference on Systems documentation table of contents

Ithaca, New York, United States

Pages: 34 - 43

Year of Publication: 1986

ISBN:0-89791-186-5

Authors

Peter E Schilling	Aluminum Company of America, Alcoa Center, Pennsylvania
John T Wizzard	Aluminum Company of America, Alcoa Center, Pennsylvania

Sponsor

SIGDOC: ACM Special Interest Group for Design of Communications

Publisher

ACM New York, NY, USA

Bibliometrics

Downloads (6 Weeks): 5, Downloads (12 Months): 11, Citation Count: 1

Additional Information:

abstract references cited by index terms collaborative colleagues

Tools and Actions:	Request Permissions Review this Article Save this Article to a Binder Display Formats: BibTeX EndNote ACM Ref

DOI Bookmark:	Use this link to bookmark this Article: http://doi.acm.org/10.1145/10563.10569 What is a DOI?

ABSTRACT

This paper is a case study with some recommendations. Over the course of a four-year (twenty person-year) project, the method of documenting programs changed from using separate files containing input data for a documentation lister, to placing all of the program documentation in the source code and using an extraction program when separate documentation was needed. The history and reasons for this evolution are described. The project revealed the usefulness of documentation tools including program templates, a good cross-reference lister, in-line documentation, and the extraction program.

REFERENCES

Note: OCR errors may be found in this Reference List extracted from the full text article. ACM has opted to expose the complete List rather than only correct and linked references.

Ryder, B. F., and A. D. Hall. The PFORT Verifier. Bell Laboratories Computer Science Report 2 (1973 May).

CITED BY

Robert Pierce, Leveraging technology affinity: applying a common set of tools and practices to information development, Proceedings of the 23rd annual international conference on Design of communication: documenting & designing for pervasive information, September 21-23, 2005, Coventry, United Kingdom

INDEX TERMS

Classification:
D. Software
D.2 SOFTWARE ENGINEERING
D.2.7 Distribution, Maintenance, and Enhancement
Subjects: Documentation