Writing good computer documentation

A new approach to writing computer documentation is needed-one that recognizes the fact that a computer program cannot achieve its purpose if its meaning is not accessible to the user. Making information accessible to the user involves certain principles that have long been recognized by writers and editors: early definition of terms, simple, parallel construction of ideas; consistency of formal and word usage; conciseness and a minimum of redundancy. One of the most important functions that writers or editors can serve with respect to software development is to ensure that the resulting documentation actually reflects what the user sees on the computer screen. All too often, the documentation is written by developers on the basis of what they remember after the software has essentially been developed. Writers or editors can also edit screens and help files for clarity and review the work of the different programmers to ensure that online terminology, punctuation, and format are consistent. From the point of view of the writer or editor, it is important to identify projects early and, if possible, to become involved in the process of developing software, as well as the documentation.<>