Workload Documentation › Special Documentation Features › User-Defined Documentation Segments › Format of Documentation Segments

Format of Documentation Segments

The format of documentation segments is simple. The first statement must be a #segment-name statement. The #segment-name begins in column 1. Immediately following the #segment-name statement is the documentation that is associated with the name. The documentation is in free-form and control characters are not needed. However, avoid beginning a documentation line with a #, which the system interprets as a segmentation control character. The system tries to treat it as a start or an end of a segment or subsegment.

To terminate the documentation for this segment, a #END statement is required. The #END statement begins in column 1 and the format of this statement is as follows:

#END[,segment-name]

For every segment name defined, you must have a #END control statement. The #END statement must occur before a new segment name can be defined. That is, the #END statement must precede the next occurrence of a #segment-name statement.

The following shows an example of documentation segments. In this case, the user is documenting jobs, and thus, is entering job-level documentation.

job documentation
   .
   .      usual job documentation goes here
   .
#DATECARD
   .
   .      date control statement information goes here
   .
#END,DATECARD
#RECOVERY
   .
   .      production recovery documentation goes here
   .
#END,RECOVERY
#CONTACTS
   .
   .      names, telephone numbers of responsible personnel go here
   .
#END,CONTACTS