document-generate

Automating documentation generation requires analyzing the target codebase and environment to create tailored docs for features and modules. This Skill uses the Diataxis framework to structure the output, reducing manual effort and ensuring consistency across the project.

The Diataxis framework is a structured approach for software documentation that categorizes content into tutorials, how-to guides, reference, and explanation. This Skill applies Diataxis automatically to generated module and feature documentation, ensuring comprehensive coverage and logical structure.

Automated documentation generation applies to any software development context needing structured docs, provided there is access to the target codebase and environment for analysis. It requires no specific platform but relies on codebase access to generate accurate feature and module documentation.

Creating tutorials or explaining modules from existing code is handled by invoking automated documentation generation against the target codebase. The Skill analyzes the environment and uses the Diataxis framework to output structured explanations and tutorials for the specified features.

Document generation can be invoked by other skills like document-release to identify and fill coverage gaps in software documentation. This integration ensures missing feature or module documentation is automatically generated using the Diataxis framework during the release process.

Automating documentation generation requires direct access to the target codebase and environment for analysis, limiting its use to accessible software development contexts. It cannot generate accurate module or feature documentation without codebase access to drive the Diataxi structured output.