Generating documentation using workflow
Create accurate, easy-to-navigate program documentation for COBOL, PL/I, and Assembler programs and applications using Generate documentation workflow.
To generate program documentation, complete the following steps:
- Open IBM® Bob Premium Package for Z workspace with all extensions installed.
- In the IBM Bob chat window, click the Start Workflow icon (Play button), select Generate documentation, and then click Start.
- Select the program files or folders containing the programs you want to document and click Continue with selection.
- The system prepares selected programs, retrieve expanded sources and leverages data dictionary
(if available), extracts business rules, and generates documentation at the location,
/docs/program/{relative-path-to-program}/{program-name}.md.
The program documentation includes program overview and purpose, file structures and data layouts, processing logic and flow, dependencies (copy books, called programs), error handling, technical specifications, sample scenarios, and business rules.