Documentation Utilities › System Documentation › General Considerations for System Documentation › Toolkit Program Documenter

Toolkit Program Documenter

The Toolkit Document Program utility (YDOCPGM) provides a summary description of a program or command, including all relevant linkage information. The level of detail of the YDOCPGM output is ideal for bridging the low level information of source listings, and the high level view of system flowcharts and overviews. The program documenter brings together information from a wide variety of sources, and collates it into an easily assimilable form. Documentation created by the program documenter includes:

• Object information (from object)
• Functional synopsis (extracted from source)
• Source member information (from source member)
• File/format used information (from object)
• Sub-programs used information (from source analysis)
• Entry parameters required (from source analysis)
• "Where called from" information (from source analysis)
• Maintenance notes (extracted from source)
• Warning notes (extracted from source)

Examples of the output of the YDOCPGM command are shown in the next three illustrations.