code-documentation
Generate docs: README, API reference, architecture, guides.
npx skills add HezaoHezao/poirot --skill code-documentation --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# 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 |
- Overview
- When to Use
- Workflow
- Phase 1: Codebase Analysis
- Phase 2: Documentation Generation
- Phase 3: Review
- Documentation Conventions by Language
- Changelog Generation
- Pitfalls
Discover project structure Read key files Find all source files Find entry points Find API routes/endpoints Find exported modules Find classes (for API reference) From git log Generate changelog from commits
What does the code-documentation skill do?
Generate docs: README, API reference, architecture, guides.
How do I install it?
Run `npx skills add HezaoHezao/poirot --skill code-documentation --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From HezaoHezao/poirot, a repository with 139 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.