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, which includes screenshots for every scenario the user encounters.
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. If printed reports are used, instructions for distribution.
System Documentation
1. Data dictionary - Description of files and databases (see
data dictionary).
2. System flowchart - Description of data flowing flow from source document to report (see
flowchart).
3. Application programs - Description of inputs, processing and outputs for each data entry, query, update and report function in the system (see
information system).
Technical Documentation
1. File structures (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).