Documentation production
Skill NickCrew/Claude-Cortex/skills/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.From its SKILL.md
npx -y skills add NickCrew/Claude-Cortex --skill documentation-productionAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 23 stars23 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
2.4 KB, 382 tokens by cl100k_base, as published. Nobody here has run it
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 |
| Writing process & style | skills/documentation-production/references/writing-process.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
What ships with it: 6 files
24.8 KB alongside SKILL.md
references/
- diagrams.md2.9 KB
- generate.md4.7 KB
- index.md5.5 KB
- teacher.md2.3 KB
- tutorials.md2.4 KB
- writing-process.md7.0 KB
Gives 0 of the 12 instructions most docs writing skills give in 382 tokens
Counted across 1,637 of the 3,044 authors here whose files we hold, read 2026-08-07
- Announce the skill at startin 54 of 1637, across 26 files
- Convert legacy doc files before editingin 45 of 1637, across 7 files
- Predict questions readers might askin 42 of 1637, across 4 files
- Generate clarifying questions for initial contextin 42 of 1637, across 3 files
- Create document scaffold with placeholder textin 42 of 1637, across 3 files
- Brainstorm content options for each sectionin 42 of 1637, across 3 files
- Test the document with a fresh context-less instancein 42 of 1637, across 3 files
- Include exact file paths in every taskin 42 of 1637, across 15 files
- Ask interview questions one at a timein 42 of 1637, across 27 files
- Apply surgical edits during refinementin 41 of 1637, across 2 files
- Offer structured workflow or freeformin 40 of 1637, across 1 file
- Ask for document meta-contextin 40 of 1637, across 2 files
Said here and by no other author read
- gather source material from code or existing docs
- produce the artifact using the required format
- validate accuracy against repository conventions
- summarize changes and next steps
- adjust indexes or nav links when updating docs
- include labels and accessibility notes in diagrams
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.