1991Communications of the ACMOpen access

Notes from COMDEX

Larry Press

Open full text 0 citations

Abstract

Finally, new and interesting ideas about documentation. It is kind of funny, really. Most documentation is written by technicians—not professional writers. And most technicians would include documentation among their top ten complaints regarding the software they use. Physician, heal thyself. This column describes ideas and suggestions from current literature on software documentation. I hope they will change the way you think about documentation. If you are in the software field, it is almost certain that you will have to write documentation, for either your peers or your users. If you are designing software, you owe it to those you serve to gain an enlightened attitude toward documentation, recognizing the interconnectedness of the software, its documentation, and the help system. Otherwise, you are not a “practical programmer.”

Open-access reader

About this research paper

What this paper is about

Finally, new and interesting ideas about documentation. It is kind of funny, really. Most documentation is written by technicians—not professional writers. And most technicians would include documentation among their top ten complaints regarding the software they use. Physician, heal thyself. This column describes ideas and suggestions from current literature on software documentation. I hope they will change the way you think about documentation. If you are in the software field, it is almost certain that you will have to write documentation, for either your peers or your users. If you are designing software, you owe it to those you serve to gain an enlightened attitude toward documentation, recognizing the interconnectedness of the software, its documentation, and the help system. Otherwise, you are not a “practical programmer.”

Why it matters

A significance statement is not available in the OpenAlex record.

Key contribution

A contribution statement is not available in the OpenAlex record.

Method / approach

Method details are not available in the OpenAlex metadata.

Main findings

Findings are not separately available in the OpenAlex metadata.

Limitations

Limitations are not available in the OpenAlex metadata.

Applications

Application details are not available in the OpenAlex metadata.

Available abstract

Finally, new and interesting ideas about documentation. It is kind of funny, really. Most documentation is written by technicians—not professional writers. And most technicians would include documentation among their top ten complaints regarding the software they use. Physician, heal thyself. This column describes ideas and suggestions from current literature on software documentation. I hope they will change the way you think about documentation. If you are in the software field, it is almost certain that you will have to write documentation, for either your peers or your users. If you are designing software, you owe it to those you serve to gain an enlightened attitude toward documentation, recognizing the interconnectedness of the software, its documentation, and the help system. Otherwise, you are not a “practical programmer.”

Key concepts: Documentation, Internal documentation, Software documentation, Programmer, Computer science, Software, Software engineering, World Wide Web

Related papers

Back to paper searchBrowse research topicsOriginal source
Notes from COMDEX — Research Paper | ScholarLens