domains / families / documents / documentation-generation-doc-generate

documentation-generation-doc-generate

combined

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.

When to use

• Generating API, architecture, or user documentation from code
• Building documentation pipelines or automation
• Standardizing docs across a repository

When not to use

• The project has no codebase or source of truth
• You only need ad-hoc explanations
• You cannot access code or requirements
• Use this skill only when the task clearly matches the scope described above.
• Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
• Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

Skill page

Conflict

The two copies share the same core procedure (identify doc types, extract from code, generate consistent docs, reference the playbook), but they disagree on a key step and the second copy adds material constraints. The first copy instructs to 'Add automation (linting, CI) and validate accuracy' as a default step. The second copy explicitly changes this to 'add automation only when requested' and adds a specific 'Worked example and prerequisites' section that requires validating examples against actual routes/builds and recording which commands ran. It also adds a 'Limitations' section. Crowning the first copy would hide the second copy's more cautious approach to automation and its specific validation workflow, while crowning the second would lose the first's explicit default to add automation. Therefore, they must be combined to preserve both the default automation step and the conditional/validation alternative.