Step 5 -  Program Documentation

Documenting means writing a description of the purpose and process of the program.

1. Documentation consists of procedures about a program and how to use it.
2. It should be done on a continual basis throughout all the steps of the program development process.
3. Documentation is important for anyone who will be involved with the program in the future.

People who may be involved with the program in the future may include:

1. Users
   1. Users need to know how to use the software.
   2. Training sessions using documentation may be used to guide users through the program.
   3. Users may be expected to learn a program from written documentation alone.
   4. Manual may accompany the software when purchased.
   5. Some manuals are electronic manuals which include help options.
        
2. Operators
   1. Computer operators need documentation to guide them in running programs.
   2. Computer operators need documentation to translate error messages.
        
3. Programmers
   1. Programmers who update or modify a program need to know purpose and logic of program.
   2. Documentation should include flowcharts, program listings and sample output.
   3. Documentation should also show how the program relates to other programs within an information system.

<  Previous Page                                         Next Page >