document-generate

Generate project documentation using the Diataxis framework for tutorials, references, and explanations.

Updated Jun 5, 2026
One-click install
npx skills add https://github.com/smarmen86/claude-code-kit --skill document-generate-smarmen86
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-generate
Source: https://github.com/smarmen86/claude-code-kit/tree/main/skills/document-generate
Command: npx skills add https://github.com/smarmen86/claude-code-kit --skill document-generate-smarmen86

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This skill eliminates the blank-page syndrome and documentation debt by automatically generating high-quality, structured documentation for features, modules, or entire projects.

Core Features & Use Cases

  • Diataxis Framework: Produces standardized tutorials, how-to guides, references, and explanations.
  • Context-Aware Generation: Integrates with existing project code and routing rules to ensure documentation is accurate and relevant.
  • Use Case: When a new module is completed, use this skill to instantly generate a comprehensive README and API reference, ensuring your team stays aligned without manual writing effort.

Quick Start

Invoke the document-generate skill to create documentation for the current module.

Frequently Asked Questions about document-generate

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate project documentation from a codebase?

You can automatically generate project documentation from a codebase by running this skill on specific modules or entire repositories to produce structured tutorials, references, and explanations.

What is the Diataxis framework for technical writing?

The Diataxis framework is a structured approach to technical writing that categorizes documentation into tutorials, how-to guides, references, and explanations to ensure comprehensive coverage and clarity.

How do I generate a README and API reference for a new code module?

To generate a README and API reference for a new code module, invoke the document generation skill on your current module to instantly bridge coverage gaps and maintain technical clarity.

Can I use automated documentation generation for an entire repository?

Yes, automated documentation generation operates on entire repositories to bridge coverage gaps, ensuring structural consistency across all modules without requiring manual writing effort.

Does context-aware documentation generation integrate with existing project code?

Yes, context-aware documentation generation integrates with existing project code and routing rules to ensure the output documentation remains accurate and relevant to your codebase.

What is the best way to eliminate documentation debt for developer-focused knowledge management?

The best way to eliminate documentation debt is to automate your documentation pipelines using a structured framework, ensuring your team stays aligned without manual writing effort.