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.”
Shape the Future of Computing
ACM encourages its members to take a direct hand in shaping the future of the association. There are more ways than ever to get involved.Get Involved
Communications of the ACM (CACM) is now a fully Open Access publication.
By opening CACM to the world, we hope to increase engagement among the broader computer science community and encourage non-members to discover the rich resources ACM has to offer.Learn More