Notes from COMDEX
Larry Press
Abstract
Open-access reader
Larry Press
Abstract
Open-access reader
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.”
A significance statement is not available in the OpenAlex record.
A contribution statement is not available in the OpenAlex record.
Method details are not available in the OpenAlex metadata.
Findings are not separately available in the OpenAlex metadata.
Limitations are not available in the OpenAlex metadata.
Application details are not available in the OpenAlex metadata.
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