IBM 1130 User Manual page 223

Section
Subsections Page
35
10
I
10 01
INSTALLA TION MANUALS
Program Information Manual
Each application should have its own binder, which
will be used by management, systems analyst, or
programmer, and will contain:
1. Job description. This is the same for all
programs with a job or application. It is a brief
abstract.
2. System flowchart. This is also the same for
all programs within an application, and shows how
each program fits into the larger picture.
3. Record layouts. All record formats for the
application are shown.
The three items above appear once for the appli-
cation, whereas the items below are necessary for
each program (you may want to place dividers,
labeled with the program names, in front of each
group of these):
1. Form layout.
2. Variable Summary Sheet. The purpose for
which program variables are used is apparent at
the time of writing, but again, as with program
logic (of which variables are an integral part), the
programmer rapidly forgets how he used them. The
Variable Summary Sheet (see Section 25) will serve
as a testing and program modification aid.
3. Program flowchart. Experience has proved
that logic which is clear to the programmer at the
time of writing is difficult to recall a short time
later. The logic must, therefore, be documented
in such a manner that testing will be accomplished
in a minimum amount of machine time. Well docu-
mented logic is also valuable when the program is
changed from time to time, either by the author or
by another programmer who may be completely un-
familiar with it.
4. Coding sheets or program listing. To avoid
confusion, the coding sheets should be discarded
after the program listing is produced.
5. Test data listing. Test data should be listed
and retained. As changes to the program are made,
they may unintentionally affect parts of the original
program. All original test data, therefore, along
with any additional test data necessary for the
change, should be processed to ensure that the pro-
gram is operating properly.
6. Test output. This includes sample reports
or cards, as produced by the test data.
7. Machine setup sheet. This is a guide to the
operator, describing machine setup, source of input,
disposition of output, and actions to be taken at
machine halts.
8. Detailed program flowcharts. These must
be included if the programmer is using Assembler
Language. Since programs written in Assembler
Language are not as easily read, or as clearly re-
lated to the job as FORTRAN programs, it is vital
that your programmer draw a detailed program
flowchart that carefully documents the program
steps he has taken. Each block should cover only a
few program steps, and should be cross-referenced
to the program. It is advisable in most cases to in-
clude a general program flowchart, which provides
a quick means of introduction to the logic and is ex-
ploded by the detailed flowchart.