documentation-production
Use when generating, updating, or organizing documentation (component/API docs, project indexes, diagrams, tutorials, learning paths) - provides structured workflows and references for docs generation, indexing, diagrams, and teaching.
When & Why to Use This Skill
This Claude skill provides a structured framework for generating, updating, and organizing high-quality technical documentation. It streamlines the creation of API references, project indexes, Mermaid diagrams, and educational tutorials, ensuring consistency and professional standards across all project artifacts while reducing the manual effort required for knowledge management.
Use Cases
- Automated API & Component Documentation: Generating and updating comprehensive documentation for software components and APIs based on source code or feature requirements.
- System Architecture Visualization: Creating professional Mermaid diagrams to illustrate complex system behaviors, data flows, and architectural designs for better team alignment.
- Developer Onboarding & Training: Crafting structured tutorials, workshops, and learning paths to facilitate rapid knowledge transfer and educational onboarding for new team members.
- Knowledge Base Maintenance: Building and organizing centralized project indexes and knowledge bases to ensure documentation remains discoverable, structured, and up-to-date.
| name | documentation-production |
|---|---|
| description | Use when generating, updating, or organizing documentation (component/API docs, project indexes, diagrams, tutorials, learning paths) - provides structured workflows and references for docs generation, indexing, diagrams, and teaching. |
Documentation Production
Overview
Provide a consistent, low-friction workflow for producing documentation across formats: focused docs, indexes, diagrams, tutorials, and learning paths. Keep outputs structured and aligned with the repo's docs conventions.
When to Use
- Generating or updating documentation for components, APIs, or features
- Building a project index or knowledge base
- Creating Mermaid diagrams for system behavior or architecture
- Writing tutorials, workshops, or learning paths
- Explaining concepts for onboarding or education
Avoid when:
- The request is primarily a code change (use implementation workflows)
- The doc type is a one-off note that doesn't need structure
Quick Reference
| Task | Load reference |
|---|---|
| Generate focused docs | skills/documentation-production/references/generate.md |
| Project index/knowledge base | skills/documentation-production/references/index.md |
| Mermaid diagrams | skills/documentation-production/references/diagrams.md |
| Teach concepts / learning paths | skills/documentation-production/references/teacher.md |
| Tutorials / workshops | skills/documentation-production/references/tutorials.md |
Workflow
- Identify doc type and target audience.
- Load the relevant reference file(s) for structure and patterns.
- Gather source material from code or existing docs.
- Produce the artifact using the required format.
- Validate accuracy and consistency with repo conventions.
- Summarize changes and next steps.
Output
- The documentation artifact(s)
- Brief change summary and any follow-up gaps
Common Mistakes
- Skipping source review and guessing behavior
- Mixing tutorial/guide formats without clear intent
- Creating diagrams without labels or accessibility notes
- Updating docs without adjusting indexes or nav links