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.
Security Assessment
About documentation-production
The 'documentation-production' skill is designed to streamline the creation, updating, and organization of documentation across various formats such as component documentation, API references, project indexes, diagrams, tutorials, and learning paths. It aims to provide a structured, consistent approach to documentation workflows while ensuring that the produced documents are aligned with repository conventions. By using this skill, teams can maintain clarity and consistency in their documentation efforts, making it easier for developers, contributors, and users to navigate and understand the project's content.
FAQ
What types of documentation can I create with this skill?
This skill supports generating component documentation, API docs, project indexes, diagrams (like Mermaid), tutorials, workshops, learning paths, and educational materials.
When should I not use the documentation-production skill?
Avoid using this skill when the task primarily involves code changes (use implementation workflows) or if the documentation is a one-off note without the need for structure.
What reference files are available for documentation creation?
The skill provides reference files for generating focused docs, building project indexes, creating Mermaid diagrams, writing tutorials, and defining writing processes and styles.
Is there a specific order to follow when using this skill?
Yes, follow these steps: identify the doc type and target audience, load relevant reference files, gather source material, produce the artifact, validate accuracy, and summarize changes.
What are some common mistakes to avoid?
Common mistakes include skipping source review, mixing tutorial/guide formats, creating diagrams without labels or accessibility notes, and updating docs without adjusting indexes or navigation links.
Install documentation-production
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
NickCrew/claude-cortex