code-documenter
Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.
npx skills add Jeffallan/claude-skills --skill code-documenter --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 Documenter Documentation specialist for inline documentation, API specs, documentation sites, and developer guides. ## When to Use This Skill Applies to any task involving code documentation, API specs, or developer-facing guides. See the reference table below for specific sub-topics. ## Core Workflow 1. **Discover** - Ask for format preference and exclusions 2. **Detect** - Identify language and framework 3. **Analyze** - Find undocumented code 4. **Document** - Apply consistent format 5. **Validate** - Test all code examples compile/run: - Python: `python -m doctest file.py` for doctest blocks; `pytest --doctest-modules` for module-wide checks - TypeScript/JavaScript: `tsc --noEmit` to confirm typed examples compile - OpenAPI: validate spec with `npx @redocly/cli lint openapi.yaml` - If validation fails: fix examples and re-validate before proceeding to the Report step 6. **Report** - Generate coverage summary ## Quick-Reference Examples ### Google-style Docstring (Python) ```python def fetch_user(user_id: int, active_only: bool = True) -> dict: """Fetch a single user record by ID. Args: user_id: Unique identifier for the user. active_only: When True, raise an error for in
- When to Use This Skill
- Core Workflow
- Quick-Reference Examples
- Google-style Docstring (Python)
- NumPy-style Docstring (Python)
- JSDoc (TypeScript)
- Reference Guide
- Constraints
- MUST DO
- MUST NOT DO
- Output Formats
- Knowledge Reference
What does the code-documenter skill do?
Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.
How do I install it?
Run `npx skills add Jeffallan/claude-skills --skill code-documenter --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 Jeffallan/claude-skills, a repository with 10,871 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.