< Prev Next >
NATO SOFTWARE ENGINEERING CONFERENCE 1968
121
9. Working Papers

DOCUMENTATION STANDARDS
excerpted from
DOCUMENTATION FOR SERVICE AND USERS
by Franz Selig
Documentation standards are set in many individual centers using forms easy to fill out which typically contain the following entries:
TITLE PAGE
a. Project name and number
b. Computer models on which it can be run
c. Program language(s)
d. Client department and number
e. Client contact
f. Frequency of program use (e.g. annual, monthly, continual)
g. Program user(s) (i.e. individual, department, general)
h. Date issued
1. Brief abstract
J. Issued by: (Programmer’s name)
MODEL DESCRIPTION
a. Problem statement
1. Complete description with history
2. Purpose and value
3. Urgency
4. Area of intended use
b. Technical writeups and diagrams
c. Basic formulae (with definitions of symbols and terminology)
d. Restrictions concerning physical limitations and bounds
e. List of references

USER’S GUIDE
a. Description of how to use the program
1. How to submit a job
2. Where the program resides
3. Sample job card