The narrative and graphical description of a system. Following are the kinds of documentation required to describe an information system for both users and systems staff. See
self-documenting code,
technical writer,
online help and
RTFM.
OPERATING PROCEDURES
1. Instructions for turning system on and
initiating the programs (see load).
2. Instructions for entering data, including
screenshots of every scenario users encounter.
3. Description of error messages that can occur
and methods for handling them.
4. Description of the defaults in the programs and
the instructions for changing them (see default).
5. Instructions for distribution of printed reports.
SYSTEM DOCUMENTATION
1. Files/databases (see data dictionary).
2. From source documents to reports (see flowchart).
3. Inputs, processing and outputs for each
application (see information system).
TECHNICAL DOCUMENTATION
1. Files (see file manager and access method).
2. Program logic (see flowchart).
3. Source code (see program documentation).
4. Machine procedures (see batch file and JCL).