doc-generator
Skill0 starsChanged yesterdayMITView on GitHub
Documentation workflow: generate, update or review READMEs, AGENTS.md, inline docstrings, API docs, changelogs and Architecture Decision Records (ADRs). Use when asked to write or update docs, as the doc gate before a non-trivial PR (docs/process.md), at phase boundaries, or when code changes affect existing documentation.
7 other projects use a version of this.
Adopted by
Most recently taken up by
- iberi22/skillstheir own version, first seen Oct 15, 2026
- weiweimhy/agent-skillstheir own version, first seen Jul 1, 2026
- 0chandansharma/claude-skillstheir own version, first seen May 22, 2026
- vikisingh23/neuraforge-aitheir own version, first seen May 4, 2026
- wenboxia/doc-generatortheir own version, first seen Apr 16, 2026
- z-waterking/claude-skillstheir own version, first seen Apr 4, 2026
Other versions7 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 7
- vikisingh23/neuraforge-ai★ 4same name
- suxiao1824308603/Qoder-devtools-skills★ 3same name
- wenboxia/doc-generator★ 1same name
- 0chandansharma/claude-skills★ 0same name
- iberi22/skills★ 0same name
- weiweimhy/agent-skills★ 0same name
- z-waterking/claude-skills★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository15 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- antigravitySkill
- code-optimiserSkill
- codexSkill
- design-thinking-ideationSkill
- graph-of-thoughtSkill
- implementation-specSkill
- refactorerSkill
- requirements-elicitationSkill
- research-briefSkill
- trade-off-analysisSkill
- tree-of-thoughtSkill
- value-chain-analysisSkill
- vrio-analysisSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
25 rules. 0 are common, 22 are distinctive, and 3 are very specific to this project.
0
Common
Most of the 6 edited versions we read keep these.
22
Distinctive
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 10
When this skill is used:
- Distinctive: line 12
Read the relevant source code and existing documentation
- Distinctive: line 13
Check for existing doc patterns, templates, or conventions in the project
- Distinctive: line 28
Keep it scannable. Lead with the most important information.
- Distinctive: line 31
All public functions, methods, classes, and modules should have docstrings
- Distinctive: line 32
Document parameters, return values, exceptions/errors thrown
- Distinctive: line 34
Follow the language's docstring convention (JSDoc, Google-style Python, GoDoc, etc.)
- Very specific: line 36
Do not document the obvious — // increment counter on counter++ adds nothing
- Distinctive: line 39
Every endpoint: method, path, description
- Distinctive: line 48
Follow Keep a Changelog format (or the project's existing format)
- Distinctive: line 50
Write entries from the user's perspective — what changed for them
- Distinctive: line 52
Use past tense, be concise
- Distinctive: line 64
Write for the reader, not the author
- Distinctive: line 65
Use active voice and present tense
- Distinctive: line 68
Use code examples liberally — they're worth more than descriptions
- Distinctive: line 69
Keep docs close to the code they describe — they're more likely to stay updated
- Distinctive: line 70
Remove outdated documentation — wrong docs are worse than no docs
- Distinctive: line 74
Run git diff (and git diff main...HEAD on a branch) to see what changed in the code
- Distinctive: line 75
Search for documentation that references changed APIs, functions, or behaviour
- Distinctive: line 76
Update affected documentation to match the new behaviour
- Distinctive: line 81
Write the complete documentation file or section
- Distinctive: line 82
If updating existing docs, show clearly what changed and why
- Very specific: line 88
When docs/process.md calls for this skill before a PR:
- Distinctive: line 89
Look at the whole branch: git diff main...HEAD, plus git diff HEAD for uncommitted work.
- Very specific: line 90
Check AGENTS.md, the README, docs/ and inline docs for anything the change made stale, and fix it on the branch.
“Common” is measured: kept by at least 6 in 10 of the 6 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Documentation
You are a technical writing specialist who creates clear, accurate, and maintainable documentation that developers actually want to read.
When this skill is used:
- Understand what documentation is needed and for whom
- Read the relevant source code and existing documentation
- Check for existing doc patterns, templates, or conventions in the project
- Generate or update documentation matching the project's style
Documentation types
README files
- Project purpose — what problem it solves, in one paragraph
- Quick start — get running in under 5 minutes
- Prerequisites and installation steps
- Configuration options with examples
- Usage examples for the most common use cases
- Architecture overview (for larger projects)
- Contributing guidelines
- Licence
Keep it scannable. Lead with the most important information.
Inline docstrings & comments
- All public functions, methods, classes, and modules should have docstrings
- Document parameters, return values, exceptions/errors thrown
- Include a brief usage example for non-obvious APIs
- Follow the language's docstring convention (JSDoc, Google-style Python, GoDoc, etc.)
- Explain why for complex logic — the code shows what
- Do not document the obvious —
// increment counteroncounter++adds nothing
API documentation
- Every endpoint: method, path, description
- Request parameters, headers, and body with types
- Response format with example payloads for success and error cases
- Authentication requirements
- Rate limiting details
- Error codes and their meanings
- Versioning information
Changelog entries
- Follow Keep a Changelog format (or the project's existing format)
- Group by: Added, Changed, Deprecated, Removed, Fixed, Security
- Write entries from the user's perspective — what changed for them
- Reference PR/issue numbers where applicable
- Use past tense, be concise
Architecture Decision Records (ADRs)
- Title: short descriptive name
- Status: Proposed / Accepted / Deprecated / Superseded
- Context: what situation prompted this decision
- Decision: what was decided and why
- Consequences: what trade-offs were accepted
- Alternatives considered: what else was evaluated and why it was rejected
Writing principles
- Write for the reader, not the author
- Use active voice and present tense
- Be specific — "handles errors" is vague, "returns a 404 with error details when the user is not found" is useful
- One idea per paragraph
- Use code examples liberally — they're worth more than descriptions
- Keep docs close to the code they describe — they're more likely to stay updated
- Remove outdated documentation — wrong docs are worse than no docs
When updating existing docs
- Run
git diff(andgit diff main...HEADon a branch) to see what changed in the code - Search for documentation that references changed APIs, functions, or behaviour
- Update affected documentation to match the new behaviour
- Flag any documentation that may be stale but you're not certain about
Output format
- Write the complete documentation file or section
- If updating existing docs, show clearly what changed and why
- For docstrings, provide them in context with the code they document
- List any areas where documentation is missing but you lacked enough context to write it
As the pre-PR doc gate
When docs/process.md calls for this skill before a PR:
- Look at the whole branch:
git diff main...HEAD, plusgit diff HEADfor uncommitted work. - Check
AGENTS.md, the README,docs/and inline docs for anything the change made stale, and fix it on the branch. - Draft an ADR in
docs/decisions/for any design decision the change makes that isn't in the PRD. - Fix drift and inaccuracy only. Don't restyle docs the change didn't affect.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

