generate-docs
Skill0 starsChanged 9 days agoApache-2.0View on GitHub
Generates comprehensive, production-grade documentation for the project. Invoke when the user asks to document the codebase, architecture, or APIs.
- Reads credentials
17 other projects use a version of this.
Adopted by
Most recently taken up by
- primelogiclabio/claude-generate-docstheir own version, first seen Nov 8, 2026
- Ronnasayd/aipptheir own version, first seen Oct 20, 2026
- buildpad-ai/skillstheir own version, first seen Oct 16, 2026
- vhmarquez/argotheir own version, first seen Oct 15, 2026
- DasDigitaleMomentum/opencode-processing-skillstheir own version, first seen Oct 9, 2026
- yagop/node-telegram-bot-apitheir own version, first seen Oct 8, 2026
Used with
Projects with it also use commit.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
SentrySkillcommit
Create commit messages following Sentry conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits with Sentry-specific issue references.
Also in 3 projects that use this
Other versions17 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 17
- yagop/node-telegram-bot-api★ 9.2ksame name
- DasDigitaleMomentum/opencode-processing-skills★ 60same name
- connerohnesorge/conclaude★ 37same name
- gohypergiant/agent-skills★ 25same name
- ZeyuLing/research_autocode_skills★ 9same name
- viknesh20-20/claude-code-tool-kit★ 7same name
- mfbari/claude-skill-generate-docs★ 5same name
- zaridan/job-hunt-hq★ 4same name
- Imran-ml/claude-skills★ 3same name
- aToy0m0/skills★ 2same name
7 more not listed
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 repository8 other files it gives its agents.
- AGENTS.mdAGENTS.md
- code-reviewSkill
- grill-meSkill
- onboard-devSkill
- performance-auditSkill
- security-auditSkill
- tdd-architectSkill
- write-adrSkill
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.
0
Common
Most of the 16 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 9
When asked to generate documentation for a project or feature, do not just output a simple README.
- Very specific: line 28
Use strict relative Markdown links between documents (e.g., Architecture Guide).
“Common” is measured: kept by at least 6 in 10 of the 16 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 Generator (Enterprise Grade)
<instructions>
When asked to generate documentation for a project or feature, do not just output a simple README. You MUST act as a Principal Technical Writer and create a structured, interconnected, and rigorous set of Markdown files.1. Documentation Structure:
Unless specified otherwise, generate or suggest the following structure inside a docs/ folder:
README.md(Executive summary, core features, quick start guide, system requirements).docs/ARCHITECTURE.md(High-level system design, architectural patterns like Hexagonal/Clean Architecture, data flow, tech stack rationale).docs/API.md(REST/GraphQL contract specifications, request/response DTO payloads, HTTP status codes, and error standard schemas like RFC 7807 Problem Details).docs/CONTRIBUTING.md(Local development setup, environment variables contract, testing instructions, linter rules, and PR lifecycle).
2. Deep Content Extraction:
- Inspect configuration files (
pom.xml,package.json,pyproject.toml,docker-compose.yml) to accurately map infrastructure dependencies, exact library versions, and build scripts. - Extract all environment variables from
.env.exampleor configuration beans, detailing types, default values, and whether they are mandatory. - Provide copy-pasteable, robust bash commands covering containerized startup (Docker) and manual execution.
3. Visual Architecture (Mermaid.js):
- You MUST include at least one Mermaid diagram per major file.
- In
ARCHITECTURE.md, use a Component or Sequence diagram mapping how layers interact (e.g., Controller -> Service -> Repository -> DB / Kafka).
4. Interconnectivity & Maintenance:
- Use strict relative Markdown links between documents (e.g.,
[Architecture Guide](./docs/ARCHITECTURE.md)). - Cross-reference critical business logic files directly in the codebase when explaining complex routines.
</instructions>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.

