doc-generator

To generate documentation from AI-produced code, provide your code or design input to the skill. It outputs READMEs, CHANGELOGs, inline docs, and ADRs by loading canonical templates to ensure consistency across artifacts.

Yes, markdown documentation generation is template-driven. It loads canonical templates from a dedicated reference file to automate the creation of consistent READMEs, ADRs, and other documentation artifacts from your codebase.

The best way to create READMEs and ADRs from refactored modules is using an automated documentation generator. It processes refactored code and design specifications to instantly produce the required accompanying markdown artifacts.

Yes, this documentation generator is reusable across multiple workflows. It applies to requirement-to-code, e2e-refactoring, and any future workflow that produces code or design specifications requiring accompanying documentation.

You can produce multiple documentation artifacts from design specifications, including README.md, CHANGELOG.md, inline docs, ADRs, and diagrams. Artifacts are written through authorized tooling based on your input designs.

No specific environment setup is required to write ADRs and CHANGELOGs from code. You simply provide the code or design input you want documented, and the skill generates the corresponding artifacts directly through authorized tooling.