ABSTRACT
This chapter discusses documentation types and documentation contents and offers several tips for producing good documentation. Documentation consists of the specifications, instructions, tutorials, reference guides, and similar materials that accompany and explain a piece of software or a hardware component. Command-oriented documentation contains all the commands used by the system and/or the program, usually arranged in alphabetical order. Execution-oriented documentation is designed to support an application. Effective documentation begins with a thorough understanding of the user, the user’s needs, and the user’s technical expertise. Good documentation never leaves the user hanging. All explanations should be written in user terms, using words the user understands. Perhaps the best way to improve documentation is to start with documentation that works well, study it carefully to find out why it works, and then use the good documentation as a model. The only way to be sure the documentation is good is to test it.
