Previous Topic: Rules and Guidelines for Documentation SegmentationNext Topic: Format of Documentation Segments


Segment Names Definition

The user-defined segments can be an orderly method of documentation. By establishing standards that are related to segment names, a powerful tool results. To define a segment name, select an eight-character name meaningful to your environment; precede the name with a # sign. Enter the definition starting in column 1. For example:

#segment-name

The following list contains potential segment names that could fit into the naming conventions for segments:

#DATECARD

Defines the format of the date cards that are used in this job.

#progname

Provides a description of programs that are used in the job.

#stepname

Provides a description of job steps in the job.

#DISASTER

Defines the instructions for disaster recovery procedures.

#RECOVERY

Defines the recovery specifications for I/O errors, abends, and so forth.

#FILING

Provides the instructions for filing input or output.

#SETUP

Defines I/O media requirements of the job.

#CONTACTS

Defines names and numbers of personnel who support the job.

#DEVICES

Defines I/O device requirements of the job.

#CONFLICT

Defines possible processing conflicts with other jobs.

#VALIDATE

Defines special manual verification requirements of the job.

#AFTERHRS

Defines special procedures occurring after the close of the business day.

Other segment names can be helpful or more meaningful and easy to use in any particular data center. Within the constraints of the few reserved segment names, users have total flexibility in naming documentation segments.