Professional Levels of Computer Program Documentation

Conference · Tue Jun 01 00:00:00 EDT 1976

OSTI ID:7342211

Gey, Fredric ^[1]

---

1. Lawrence Berkeley Laboratory (LBL), Berkeley, CA (United States); University of California, Berkeley, CA (United States)

Computer program documentation is more than a collection of techniques for manipulating code for readability, more than a flow diagram of program logic, and more than a block of comments cards at the beginning of a module. A professional level of documentation derives from the systematic synthesis of technique tempered with good judgment and lucid composition. The overriding goal of documentation is understanding, by managers, by users, and by maintenance programmers. Documentation requires a level of precision rarely required in programing itself.

• Research Organization: University of California, Berkeley, CA (United States); Lawrence Berkeley Laboratory (LBL), Berkeley, CA (United States)
• Sponsoring Organization: US Energy Research and Development Administration (ERDA)
• DOE Contract Number: W-7405-ENG-48
• OSTI ID: 7342211
• Report Number(s): LBL--4876; CONF-760634-3
• Country of Publication: United States
• Language: English

Related Subjects

97 MATHEMATICS AND COMPUTING
99 GENERAL AND MISCELLANEOUS
990200* -- Mathematics & Computers
COMPUTER CODES
DOCUMENTATION
PROGRAMMING
RECOMMENDATIONS