Workload Documentation › Special Documentation Features › User-Defined Documentation Segments › Naming Conventions Documentation

Naming Conventions Documentation

As a further aid in handling documentation, we recommend that not only should you adopt a naming convention for segments and subsegments but also that you document the naming convention. We suggest that you use at least one documentation member (not a segment) of the user-designated level for this purpose. The following are suggestions for naming a user documentation member:

STANDARD.NAMING.SEGMENTS
STANDARD.NAMES.FOR.SEGMENTS

The DB.4.3 panel contains more information about the USER field.

If your installation is using subsegments and segments, two documentation members, one for segments and one for subsegments, might be advisable. Following are suggestions for the documentation member name containing documentation on subsegment naming conventions:

STANDARD.NAMING.SUB.SEGMENTS
STANDARD.NAMES.FOR.SUB.SEGMENTS

As with any documentation, the contents of documentation members can be maintained easily through the appropriate DB.4 panels.

More information:

DB.4.3 - User-Defined Item Documentation Panel