document-generate

You can generate missing documentation automatically by providing feature, module, or project context. The skill produces structured Markdown with YAML frontmatter, aligning content to the Diataxis framework across tutorials, how-tos, references, and explanations.

The Diataxis framework structures documentation into four modes: tutorials, how-tos, reference material, and explanations. This skill applies the framework to generate multi-section Markdown bodies that match project conventions and cover distinct learning needs.

You can create tutorials and reference material by providing code context to the skill. It uses Bash, Read, Grep, and Glob tools to gather inputs, then writes structured Markdown files with YAML frontmatter directly into your project.

Yes, you can auto-generate YAML frontmatter containing a name and description. The skill outputs a coherent Markdown body aligned to the Diataxis framework, ensuring documentation entries match your project conventions.

This documentation generation approach works for both entire projects and single modules. It scales from generating missing docs for a single feature to creating complete, structured documentation across a full software project.

Auto-generating how-to guides and explanations depends on the accuracy of provided context. While it uses Read, Grep, and Glob to gather inputs, complex or undocumented logic may require manual review to ensure the generated Markdown accurately reflects behavior.