Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
Generate docs: README, API reference, architecture, guides. An agent skill from HezaoHezao/poirot.
Install Code Documentation
$ npx skills add HezaoHezao/poirot --skill code-documentation -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install HezaoHezao/poirot code-documentation --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/HezaoHezao/poirot.git skills-src && mkdir -p .claude/skills && cp -r skills-src/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation .claude/skills/code-documentation && 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-documentation" agent skill from https://github.com/HezaoHezao/poirot/tree/master/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation into .claude/skills/code-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documentation", 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/HezaoHezao/poirot/tree/master/poirot/backend/agents/skill/builtin_skills/productivity/code-documentationType 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 HezaoHezao/poirot --skill code-documentation -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install HezaoHezao/poirot code-documentation --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/HezaoHezao/poirot.git skills-src && mkdir -p .agents/skills && cp -r skills-src/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation .agents/skills/code-documentation && 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-documentation" agent skill from https://github.com/HezaoHezao/poirot/tree/master/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation into .agents/skills/code-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documentation", 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 HezaoHezao/poirot --skill code-documentation -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install HezaoHezao/poirot code-documentation --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/HezaoHezao/poirot.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation .cursor/skills/code-documentation && 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-documentation" agent skill from https://github.com/HezaoHezao/poirot/tree/master/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation into .cursor/skills/code-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documentation", 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/HezaoHezao/poirot.git --path poirot/backend/agents/skill/builtin_skills/productivity/code-documentation--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 HezaoHezao/poirot --skill code-documentation -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install HezaoHezao/poirot code-documentation --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/HezaoHezao/poirot.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation .gemini/skills/code-documentation && 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-documentation" agent skill from https://github.com/HezaoHezao/poirot/tree/master/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation into .gemini/skills/code-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documentation", 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 HezaoHezao/poirot code-documentationInstalls 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 HezaoHezao/poirot --skill code-documentation -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/HezaoHezao/poirot.git skills-src && mkdir -p .github/skills && cp -r skills-src/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation .github/skills/code-documentation && 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-documentation" agent skill from https://github.com/HezaoHezao/poirot/tree/master/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation into .github/skills/code-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documentation", 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 HezaoHezao/poirot --skill code-documentation -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install HezaoHezao/poirot code-documentation --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/HezaoHezao/poirot.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation .opencode/skills/code-documentation && 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-documentation" agent skill from https://github.com/HezaoHezao/poirot/tree/master/poirot/backend/agents/skill/builtin_skills/productivity/code-documentation into .opencode/skills/code-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "code-documentation", 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-documentation- GitHub stars
- 250
- Token cost
- ~1.2k tokens
- SKILL.md length
- 312 words
- Files
- 1
- Skills in repo
- 23
- Repo updated
- First seen
- Licence
- MIT
At a glance
Generate docs: README, API reference, architecture, guides. An agent skill from HezaoHezao/poirot.
- Works in 3 steps: Codebase Analysis → Documentation Generation → Review
- Tasks that involve Technical documentation
- SKILL.md covers Overview, When to Use, Workflow and Documentation Conventions by…, plus 2 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Code Documentation is an agent skill from HezaoHezao/poirot. Generate docs: README, API reference, architecture, guides.
Its SKILL.md is about 1.2k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation. The repository describes itself as: Poirot is a deep research agent kernel built for those who care about how agents are architected. The licence is MIT.
When your agent uses it
- Tasks that involve Technical documentation
Example prompts
- “/code-documentation”
Requirements
- Python 3
- Pre-approved tools (allowed-tools): bash, read_file, write_file, list_dir
Workflow steps
3 steps, taken from the step headings in SKILL.md.
What it can do on your machine
Read from SKILL.md and the folder at commit 86bf279. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves these tools, so the agent can use them without asking each time:
bashread_filewrite_filelist_dir
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are bash and markdown).
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 Documentation loads about 1.2k tokens when it runs. Until then it costs about 20 tokens; SKILL.md has 312 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 HezaoHezao/poirot at commit 86bf279, republished under its MIT licence (© HezaoHezao). 312 words, ~1,161 tokens.
Download SKILL.mdSave it as
.claude/skills/code-documentation/SKILL.md (or your agent's skills folder).- name
- code-documentation
- description
- Generate docs: README, API reference, architecture, guides.
- allowed-tools
- bash, read_file, write_file, list_dir
- enabled
- true
- related-skills
- codebase-inspection
- license
- MIT
- author
- Adapted from deer-flow (Bytedance, MIT)
Code Documentation
Overview
Generate professional, comprehensive documentation for software projects, codebases, libraries, and APIs. Follows best practices from React, Django, Stripe, Kubernetes to produce accurate, well-structured docs.
When to Use
- User asks to "document", "create docs", or "write documentation" for code
- User requests a README, API reference, or developer guide
- User shares a codebase and wants documentation generated
- User asks to improve or update existing documentation
- User needs architecture documentation with diagrams
- User requests a changelog or migration guide
Workflow
Phase 1: Codebase Analysis
Step 1.1: Project Discovery
| Field | How to Determine |
|---|---|
| Language(s) | File extensions, package.json, pyproject.toml, go.mod |
| Framework | Dependencies (React, Django, Express, Spring) |
| Build System | Makefile, CMakeLists.txt, webpack.config.js |
| Package Manager | npm/yarn/pnpm, pip/uv/poetry, cargo |
| Project Structure | Map directory tree |
| Entry Points | main files, CLI entry points, exported modules |
| Existing Docs | README, docs/, wiki, inline docs |
# Discover project structure
list_dir(".")
# Read key files
read_file("package.json") # or pyproject.toml, go.mod, etc.
# Find all source files
bash("find . -name '*.py' -not -path '*/venv/*' -not -path '*/.venv/*' | head -30")Step 1.2: Code Structure Analysis
# Find entry points
bash("grep -rl 'if __name__' --include='*.py' . | head -10")
# Find API routes/endpoints
bash("grep -rn '@app.route\|@router\.\|def get\|def post' --include='*.py' . | head -20")
# Find exported modules
bash("grep -rn 'export\|module.exports' --include='*.js' --include='*.ts' . | head -20")
# Find classes (for API reference)
bash("grep -rn '^class ' --include='*.py' . | head -20")Phase 2: Documentation Generation
README.md
# Project Name
> One-line description
## Features
- Feature 1
- Feature 2
## Installation
\`\`\`bash
pip install project-name
\`\`\`
## Quick Start
\`\`\`python
from project import Client
client = Client()
result = client.do_thing()
\`\`\`
## API Reference
### `Client.do_thing(param: str) -> Result`
Description of what this does.
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| param | str | Yes | The input |
## Configuration
| Key | Default | Description |
|-----|---------|-------------|
## Contributing
See CONTRIBUTING.md
## License
MITAPI Reference
For each public function/class:
- Signature (parameters, return type)
- Description
- Parameters table
- Return value
- Example usage
- Exceptions raised
Architecture Documentation
- System overview diagram (use
architecture-diagramskill) - Component descriptions
- Data flow
- Key design decisions (ADR format)
Phase 3: Review
- All public APIs documented
- Examples are runnable
- Installation instructions tested
- No broken links
- Language-appropriate conventions (docstrings, JSDoc, GoDoc)
- Architecture diagram included for complex projects
Documentation Conventions by Language
| Language | Inline Format | Reference Format |
|---|---|---|
| Python | docstrings (Google/NumPy style) | Sphinx, MkDocs |
| JavaScript/TypeScript | JSDoc/TSDoc | JSDoc, TypeDoc |
| Go | GoDoc comments | godoc |
| Java | Javadoc | javadoc |
| Rust | rustdoc (///) | rustdoc |
Changelog Generation
# From git log
bash("git log --oneline --no-decorate v1.0.0..HEAD | head -50")
# Generate changelog from commits
bash("git log v1.0.0..HEAD --pretty=format:'- %s (%h)' --no-merges")Pitfalls
- Stale docs: documentation must match code. If code changed, docs must update. Note the commit/version the docs were generated from.
- No examples: documentation without runnable examples is useless. Always include copy-pasteable examples.
- Over-documenting internals: document public API, not implementation details. Internal code should have inline comments, not API docs.
- No table of contents: for long docs, include a TOC with anchor links.
- Missing prerequisites: list all dependencies, environment requirements, and minimum versions.
© HezaoHezao, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in poirot/backend/agents/skill/builtin_skills/productivity/code-documentation of HezaoHezao/poirot.
Open the folder on GitHubat commit 86bf279
Compare with similar skills
Code Documentation 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 Documentation this skillHezaoHezao/poirot | 250 | — | ~1.2k | Automated safety check: Pass | MIT | |
| Diagram Designcathrynlavery/diagram-design | 44k | 1 repos | ~7.5k | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Get API Docs with chubandrewyng/context-hub | 14k | 2 repos | ~775 | Automated safety check: Pass | MIT | |
| Doc SyncJetBrains/ideavim | 10k | 2 repos | ~2.6k | Automated safety check: Pass | MIT | |
| Mailspring App ScreenshotsFoundry376/Mailspring | 18k | — | ~1.4k | Automated safety check: Pass | GPL-3.0 |
Similar skills
Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
Get API Docs with chub
andrewyng/context-hub
Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.
- Official
Doc Sync
JetBrains/ideavim
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
Mailspring App Screenshots
Foundry376/Mailspring
Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
More from HezaoHezao/poirot
All 23 skills in this repoRequesting Code Review
HezaoHezao/poirot
Pre-commit review: security scan, quality gates, auto-fix. An agent skill from HezaoHezao/poirot.
Research Paper Writing
HezaoHezao/poirot
ML paper pipeline: experiment design to submission. An agent skill from HezaoHezao/poirot.
Academic Paper Review
HezaoHezao/poirot
Structured peer-review of academic papers. An agent skill from HezaoHezao/poirot.
Blogwatcher
HezaoHezao/poirot
Monitor blogs and RSS/Atom feeds via blogwatcher-cli. An agent skill from HezaoHezao/poirot.
Bootstrap
HezaoHezao/poirot
Onboarding conversation to generate a user profile. An agent skill from HezaoHezao/poirot.
Chart Visualization
HezaoHezao/poirot
Generate charts: select type, extract data, render image. An agent skill from HezaoHezao/poirot.
Related
Categories
Questions about Code Documentation
What does Code Documentation do?
Generate docs: README, API reference, architecture, guides. An agent skill from HezaoHezao/poirot. Code Documentation is an agent skill from HezaoHezao/poirot. Generate docs: README, API reference, architecture, guides.
When should I use Code Documentation?
Code Documentation fits situations like: tasks that involve Technical documentation.
How do I install Code Documentation in Claude Code?
Run `npx skills add HezaoHezao/poirot --skill code-documentation -a claude-code`. Or copy the skill folder (poirot/backend/agents/skill/builtin_skills/productivity/code-documentation in HezaoHezao/poirot) into .claude/skills/code-documentation in your project. Claude Code loads it when a task matches its description.
How do I install Code Documentation in Codex?
Run `npx skills add HezaoHezao/poirot --skill code-documentation -a codex`. Or copy the skill folder (poirot/backend/agents/skill/builtin_skills/productivity/code-documentation in HezaoHezao/poirot) into .agents/skills/code-documentation in your project. Codex loads it when a task matches its description.
Can I use Code Documentation 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 HezaoHezao/poirot --skill code-documentation -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-documentation, .gemini/skills/code-documentation, .github/skills/code-documentation and .opencode/skills/code-documentation in your project.
What does Code Documentation need to run?
SKILL.md names no scripts, command-line tools or credentials: Code Documentation is instructions for the agent only. Our summary lists: Python 3. Its frontmatter pre-approves these tools: bash, read_file, write_file, list_dir.
Does Code Documentation 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 Documentation 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 Documentation use?
Code Documentation 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 Documentation use?
About 1.2k tokens (SKILL.md is roughly 4.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Code Documentation?
Skills that share tags, products or a category with Code Documentation: Diagram Design (cathrynlavery/diagram-design, 44k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Code Documentation?
HezaoHezao (a GitHub user) maintains it in HezaoHezao/poirot, which has 250 GitHub stars. The repository holds 23 skills in this directory. The repository was last updated on July 28, 2026.
Source: HezaoHezao/poirot on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.