Enterprise Applications
Development Guidelines and Procedures
Customer Documentation
A separate customer documentation file should be created for all screens and jobs the customer must run which are not adequately self-documented. QUICK screens and batch jobs are typically self-documented. COBOL programs are typically not self-documented. A separate documentation file should be stored in the DOC group or the appropriate production account. Typically this file should have the same name as the program file.
Following information should be included:
| Program name | Name of program or menu screen |
|---|---|
| Function | Explain the purpose of the program. Give the commands necessary to run the job. |
| Ending | State the method for exiting the program. |
| Function keys | State the effect of each function key. |
| Required fields | Include when significant, particularly in View or block mode QUICK screens. |
| Narrative | Give as much detail in stepping through the processes add, change, post, etc., as would be helpful. Give general instructions which apply to all screens. Follow with instructions specific to each screen accessible in this unit. |
| Error messages | Include only those messages which need further clarification as to the appropriate action for the customer to take. |