Generating Documentation
ancoleman/ai-design-components
Generate comprehensive technical documentation including API docs (OpenAPI/Swagger), code documentation (TypeDoc/Sphinx), documentation sites (Docusaurus/MkDocs), Architecture Decision Records…
A skill your agent uses when adding docstrings, creating API documentation, or building documentation sites.
Install Code Documenter
$ npx skills add zebbern/claude-code-guide --skill code-documenter -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install zebbern/claude-code-guide code-documenter --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/code-documenter .claude/skills/code-documenter && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "code-documenter" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/code-documenter into .claude/skills/code-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documenter", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/zebbern/claude-code-guide/tree/main/skills/code-documenterType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add zebbern/claude-code-guide --skill code-documenter -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install zebbern/claude-code-guide code-documenter --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/code-documenter .agents/skills/code-documenter && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "code-documenter" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/code-documenter into .agents/skills/code-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documenter", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add zebbern/claude-code-guide --skill code-documenter -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install zebbern/claude-code-guide code-documenter --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/code-documenter .cursor/skills/code-documenter && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "code-documenter" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/code-documenter into .cursor/skills/code-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documenter", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/zebbern/claude-code-guide.git --path skills/code-documenter--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add zebbern/claude-code-guide --skill code-documenter -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install zebbern/claude-code-guide code-documenter --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/code-documenter .gemini/skills/code-documenter && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "code-documenter" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/code-documenter into .gemini/skills/code-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documenter", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install zebbern/claude-code-guide code-documenterInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add zebbern/claude-code-guide --skill code-documenter -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/code-documenter .github/skills/code-documenter && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "code-documenter" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/code-documenter into .github/skills/code-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documenter", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add zebbern/claude-code-guide --skill code-documenter -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install zebbern/claude-code-guide code-documenter --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/zebbern/claude-code-guide.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/code-documenter .opencode/skills/code-documenter && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "code-documenter" agent skill from https://github.com/zebbern/claude-code-guide/tree/main/skills/code-documenter into .opencode/skills/code-documenter/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documenter", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
code-documenter- GitHub stars
- 4.6k
- Token cost
- ~1k tokens
- SKILL.md length
- 332 words
- Files
- 9 (incl. references)
- Skills in repo
- 46
- Repo updated
- First seen
- Licence
- MIT
At a glance
A skill your agent uses when adding docstrings, creating API documentation, or building documentation sites.
- Works in 5 steps: Discover - Ask for format preference and… → Detect - Identify language and framework → Analyze - Find undocumented code → …
- Adding docstrings
- SKILL.md covers Role Definition, When to Use This Skill, Core Workflow and Reference Guide, plus 3 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Code Documenter is an agent skill from zebbern/claude-code-guide. Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, user guides.
Its SKILL.md is about 1k tokens, which your agent loads only when the skill is triggered. The skill folder holds 9 other files, including reference files (for example `references/api-docs-fastapi-django.md`, `references/api-docs-nestjs-express.md` and `references/coverage-reports.md`).
It sits in Backend & APIs, covering Technical documentation, OpenAPI specifications and Static sites and blogs. It works with OpenAPI, Python and TypeScript. The repository describes itself as: Claude Code Guide - Setup, Commands, workflows, agents, skills & tips-n-tricks from beginner to power user! The licence is MIT.
When your agent uses it
- Adding docstrings
- Creating API documentation
- Building documentation sites
Example prompts
- “/code-documenter”
Requirements
- Python 3
- Node.js
Workflow steps
5 steps, taken from the first numbered list in SKILL.md.
- Discover - Ask for format preference and exclusions
- Detect - Identify language and framework
- Analyze - Find undocumented code
- Document - Apply consistent format
- Report - Generate coverage summary
What it can do on your machine
Read from SKILL.md and the folder at commit 4698e3b. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Code Documenter loads about 1k tokens when it runs, and up to ~13k if it reads all its reference files. Until then it costs about 46 tokens; SKILL.md has 332 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from zebbern/claude-code-guide at commit 4698e3b, republished under its MIT licence (© zebbern). 332 words, ~1,029 tokens.
Download SKILL.mdSave it as
.claude/skills/code-documenter/SKILL.md (or your agent's skills folder). This skill also uses 8 other files; get the full folder from GitHub.- name
- code-documenter
- description
- Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, user guides.
- license
- MIT
- metadata.author
- https://github.com/Jeffallan
- metadata.version
- 1.0.0
- metadata.domain
- quality
- metadata.triggers
- documentation, docstrings, OpenAPI, Swagger, JSDoc, comments, API docs, tutorials, user guides, doc site
- metadata.role
- specialist
- metadata.scope
- implementation
- metadata.output-format
- code
- metadata.related-skills
- spec-miner, fullstack-guardian, code-reviewer
Code Documenter
Documentation specialist for inline documentation, API specs, documentation sites, and developer guides.
Role Definition
You are a senior technical writer with 8+ years of experience documenting software. You specialize in language-specific docstring formats, OpenAPI/Swagger specifications, interactive documentation portals, static site generation, and creating comprehensive guides that developers actually use.
When to Use This Skill
- Adding docstrings to functions and classes
- Creating OpenAPI/Swagger documentation
- Building documentation sites (Docusaurus, MkDocs, VitePress)
- Documenting APIs with framework-specific patterns
- Creating interactive API portals (Swagger UI, Redoc, Stoplight)
- Writing getting started guides and tutorials
- Documenting multi-protocol APIs (REST, GraphQL, WebSocket, gRPC)
- Generating documentation reports and coverage metrics
Core Workflow
- Discover - Ask for format preference and exclusions
- Detect - Identify language and framework
- Analyze - Find undocumented code
- Document - Apply consistent format
- Report - Generate coverage summary
Reference Guide
Load detailed guidance based on context:
| Topic | Reference | Load When |
|---|---|---|
| Python Docstrings | references/python-docstrings.md | Google, NumPy, Sphinx styles |
| TypeScript JSDoc | references/typescript-jsdoc.md | JSDoc patterns, TypeScript |
| FastAPI/Django API | references/api-docs-fastapi-django.md | Python API documentation |
| NestJS/Express API | references/api-docs-nestjs-express.md | Node.js API documentation |
| Coverage Reports | references/coverage-reports.md | Generating documentation reports |
| Documentation Systems | references/documentation-systems.md | Doc sites, static generators, search, testing |
| Interactive API Docs | references/interactive-api-docs.md | OpenAPI 3.1, portals, GraphQL, WebSocket, gRPC, SDKs |
| User Guides & Tutorials | references/user-guides-tutorials.md | Getting started, tutorials, troubleshooting, FAQs |
Constraints
MUST DO
- Ask for format preference before starting
- Detect framework for correct API doc strategy
- Document all public functions/classes
- Include parameter types and descriptions
- Document exceptions/errors
- Test code examples in documentation
- Generate coverage report
MUST NOT DO
- Assume docstring format without asking
- Apply wrong API doc strategy for framework
- Write inaccurate or untested documentation
- Skip error documentation
- Document obvious getters/setters verbosely
- Create documentation that's hard to maintain
Output Formats
Depending on the task, provide:
- Code Documentation: Documented files + coverage report
- API Docs: OpenAPI specs + portal configuration
- Doc Sites: Site configuration + content structure + build instructions
- Guides/Tutorials: Structured markdown with examples + diagrams
Knowledge Reference
Google/NumPy/Sphinx docstrings, JSDoc, OpenAPI 3.0/3.1, AsyncAPI, gRPC/protobuf, FastAPI, Django, NestJS, Express, GraphQL, Docusaurus, MkDocs, VitePress, Swagger UI, Redoc, Stoplight
© zebbern, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 8 other files (references) in skills/code-documenter of zebbern/claude-code-guide.
- SKILL.md
- references/api-docs-fastapi-django.md
- references/api-docs-nestjs-express.md
- references/coverage-reports.md
- references/documentation-systems.md
- references/interactive-api-docs.md
- references/python-docstrings.md
- references/typescript-jsdoc.md
- references/user-guides-tutorials.md
Open the folder on GitHubat commit 4698e3b
Compare with similar skills
Code Documenter next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Code Documenter this skillzebbern/claude-code-guide | 4.6k | — | ~1k | Automated safety check: Pass | MIT | |
| Generating Documentationancoleman/ai-design-components | 526 | — | ~3k | Automated safety check: Pass | MIT | |
| Code DocumenterJeffallan/claude-skills | 12k | — | ~1.5k | Automated safety check: Pass | MIT | |
| Api2clialexknowshtml/api2cli | 455 | — | ~2.9k | Automated safety check: Pass | MIT | |
| API Documenteralirezarezvani/claude-code-tresor | 777 | — | ~1.5k | Automated safety check: Pass | MIT | |
| Agentic Workflows API Documentation Lungoagntcy/coffeeAgntcy | 112 | — | ~2.6k | Automated safety check: Pass | Apache-2.0 |
Similar skills
Code Documenter
Jeffallan/claude-skills
Generates and validates docstrings, OpenAPI specs, JSDoc annotations and user guides, running every code example through a real compiler or linter before reporting coverage.
Api2cli
alexknowshtml/api2cli
Generate a working CLI from any API, then wrap it in a Claude Code skill.
API Documenter
alirezarezvani/claude-code-tresor
Auto-generate API documentation from code and comments. An agent skill from alirezarezvani/claude-code-tresor.
Agentic Workflows API Documentation Lungo
agntcy/coffeeAgntcy
Authors and maintains the human-facing Agentic Workflows API documentation for the lungo subproject at coffeeAGNTCY/coffeeagents/lungo/docs/workflow-instanceapi.md.
E2a Integrate
tokencanopy/e2a
A skill your agent uses when adding e2a email capabilities to an application or codebase: outbound sending, inbound signed webhooks, REST polling, or SDK integration.
More from zebbern/claude-code-guide
All 46 skills in this repoLocalization Toolkit
zebbern/claude-code-guide
This skill should be used when setting up, auditing, or enforcing internationalization/localization in UI codebases (React/TS, i18next or similar, JSON locales), including installing/configuring the…
Audit Flow
zebbern/claude-code-guide
Interactive system flow tracing across CODE, API, AUTH, DATA, NETWORK layers with SQLite persistence and Mermaid export.
Chart Image
zebbern/claude-code-guide
Generate publication-quality PNG chart images from data, supporting line, bar, area, candlestick, pie, and heatmap charts.
Code To Diagram
zebbern/claude-code-guide
Analyze codebases and automatically generate architecture diagrams, flowcharts, and org charts.
Code Vuln Audit
zebbern/claude-code-guide
Scan code for security issues: dependency vulnerabilities (npm/pip audit), secret leaks (regex and entropy analysis), and OWASP anti-patterns like SQL injection, XSS, or command injection.
Data Viz Renderer
zebbern/claude-code-guide
Generate self-contained HTML/SVG infographics from JSON data, including stat cards, bar charts, flow diagrams, and mixed dashboards.
Related
Works with
Categories
Questions about Code Documenter
What does Code Documenter do?
A skill your agent uses when adding docstrings, creating API documentation, or building documentation sites. Code Documenter is an agent skill from zebbern/claude-code-guide. Use when adding docstrings, creating API documentation, or building documentation sites.
When should I use Code Documenter?
Code Documenter fits situations like: adding docstrings; creating API documentation; building documentation sites.
How do I install Code Documenter in Claude Code?
Run `npx skills add zebbern/claude-code-guide --skill code-documenter -a claude-code`. Or copy the skill folder (skills/code-documenter in zebbern/claude-code-guide) into .claude/skills/code-documenter in your project. Claude Code loads it when a task matches its description.
How do I install Code Documenter in Codex?
Run `npx skills add zebbern/claude-code-guide --skill code-documenter -a codex`. Or copy the skill folder (skills/code-documenter in zebbern/claude-code-guide) into .agents/skills/code-documenter in your project. Codex loads it when a task matches its description.
Can I use Code Documenter in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add zebbern/claude-code-guide --skill code-documenter -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/code-documenter, .gemini/skills/code-documenter, .github/skills/code-documenter and .opencode/skills/code-documenter in your project.
What does Code Documenter need to run?
SKILL.md names no scripts, command-line tools or credentials: Code Documenter is instructions for the agent only. Our summary lists: Python 3; Node.js.
Does Code Documenter access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Code Documenter safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Code Documenter use?
Code Documenter is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Code Documenter use?
About 1k tokens (SKILL.md is roughly 4.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 12k tokens, read only when the agent opens those files.
What are the alternatives to Code Documenter?
Skills that share tags, products or a category with Code Documenter: Generating Documentation (ancoleman/ai-design-components, 526 stars), Code Documenter (Jeffallan/claude-skills, 12k stars), Api2cli (alexknowshtml/api2cli, 455 stars) and API Documenter (alirezarezvani/claude-code-tresor, 777 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Code Documenter?
zebbern (a GitHub user) maintains it in zebbern/claude-code-guide, which has 4,648 GitHub stars. The repository holds 46 skills in this directory. The repository was last updated on October 7, 2026.
Source: zebbern/claude-code-guide on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.