research-article

Free access

Modular documentation: a software development tool

Author:

Roy E. AndersonAuthors Info & Claims

AFIPS '81: Proceedings of the May 4-7, 1981, national computer conference

Pages 401 - 405

https://doi.org/10.1145/1500412.1500469

Published: 04 May 1981 Publication History

PDF eReader

Abstract

This paper presents a scheme for documenting the design and implementation of a large software system. The scheme is presented in terms of a family of documents based on the decomposition of any system into specific levels of abstraction for the purpose of software development. It facilitates the use of structured design techniques, provides tangible objects for organizing manpower resources on the basis of the system's structure, gives management meaningful milestones with which to measure development progress, and results in a fully documented system when the implementation phase is complete.

References

[1]

Jensen, R. W. and Tonies, C. C., Software Engineering, Prentice-Hall, Englewood Cliffs, NJ, 1979.

Google Scholar

[2]

Kernighan, B. W. and Plauger, P. J., The Elements of Programming Style, McGraw-Hill, New York, 1974.

Digital Library

Google Scholar

[3]

Metzger, P. W., Managing a Programming Project, Prentice-Hall, Englewood Cliffs, NJ, 1973.

Digital Library

Google Scholar

[4]

Parnas, D. L. "On the Criteria To Be Used in Decomposing Systems into Modules," Comm. ACM 15, 12 (Dec. 1972), pp. 1053--1058.

Digital Library

Google Scholar

[5]

Ross, D. T. and Schoman, K. E., Jr., "Structured Analysis for Requirements Definition," IEEE Trans. Software Eng. Vol. SE-3, No. 1, (Jan. 1977), pp. 6--15.

Digital Library

Google Scholar

[6]

Wirth, N., Systematic Programming: An Introduction, Prentice-Hall, Englewood Cliffs, NJ, 1973.

Digital Library

Google Scholar

[7]

Yeh, R. T., (Editor), Programming Methodology, Volume I, Prentice-Hall, Englewood Cliffs, NJ, 1977.

Google Scholar

Recommendations

Documentation threads - presentation of fragmented documentation

In this paper, we introduce a means for presenting fragmented documentation through a concept called documentation threads. A documentation thread presents a number of documentation fragments specified by the programmer and can guide a documentation ...
Code Documentation

The basic principles of good code documentation include the avoidance of repetition, the coexistence of code and its documentation, the documentation of all artifacts, and a preference for clear code and automated processes to explanatory documentation. ...
Haddock, a Haskell documentation tool
Haskell '02: Proceedings of the 2002 ACM SIGPLAN workshop on Haskell

This paper describes Haddock, a tool for automatically generating documentation from Haskell source code. Haddock's unique approach to source code annotations provides a useful separation between the implementation of a library and the interface (and ...

Comments

Information & Contributors

Information

Published In

AFIPS '81: Proceedings of the May 4-7, 1981, national computer conference

May 1981

736 pages

ISBN:9781450379212

DOI:10.1145/1500412

Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 04 May 1981

Permissions

Request permissions for this article.

Request Permissions

Check for updates

Qualifiers

Research-article

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

0
Total Citations
162
Total Downloads

Downloads (Last 12 months)35
Downloads (Last 6 weeks)5

Reflects downloads up to 28 Jan 2025

Other Metrics

View Author Metrics

Citations

View Options

View options

PDF

View or Download as a PDF file.

PDF

eReader

View online with eReader.

eReader

Login options

Check if you have access through your login credentials or your institution to get full access on this article.

Recommendations

Documentation threads - presentation of fragmented documentation

Code Documentation

Haddock, a Haskell documentation tool

Comments

Published In

Sponsors

Publisher

Publication History

Permissions

Check for updates

Qualifiers

Other Metrics

Article Metrics

Other Metrics

PDF

eReader

Login options

Full Access

Abstract

References

Recommendations

Documentation threads - presentation of fragmented documentation

Code Documentation

Haddock, a Haskell documentation tool

Comments

Information

Published In

Sponsors

Publisher

Publication History

Permissions

Check for updates

Qualifiers

Contributors

Other Metrics

Bibliometrics

Article Metrics

Other Metrics

Citations

View options

PDF

eReader

Login options

Full Access

Share

Share this Publication link

Share on social media

Affiliations