8.5 Generated Documentation

Go To Top

Return to Generated Artifacts

Generated documentation can help the team keep Repository documentation aligned with source definitions. The team may generate documentation from IDL files, topic catalogs, Node catalogs, script metadata, Configuration schemas, tests, or acceptance Evidence.

Generated documentation should identify its source and generation process. Readers should be able to tell whether they are reading authored guidance, generated reference material, or generated Evidence.

The team should use generated documentation for reference material, not for unsupported architectural assertions. For example, generated topic documentation can list topic names, carried structures, and QoS settings, but architectural meaning should still trace back to the architecture documents, topic definitions, or catalog entries.

Generated documentation should not replace handbook sections that explain team conventions. The handbook defines the rules. Generated documentation reports what the current Repository contains.

© 2026 Dido Solutions, Inc. and Jackrabbit Consulting, Inc.