Code Documenter

This one handles the full spectrum of code documentation, from inline docstrings to full API specs and dev portals. It walks through discovery, analysis, documentation, and validation with actual test commands (doctest, tsc, Redocly CLI) to make sure your examples aren't broken. Ships with reference guides for Google/NumPy/Sphinx docstrings, JSDoc, OpenAPI, and major frameworks like FastAPI, Django, NestJS, and Express. The workflow is methodical: it asks your format preference upfront, detects your stack, finds undocumented code, applies consistent formatting, validates everything compiles, then gives you a coverage report. Good if you need to document an API or clean up a codebase that's been accumulating tech debt, and you want the examples to actually work.

skills.sh installs: 6K
GitHub stars: 12.3K
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add jeffallan/claude-skills --skill code-documenter --agent claude-code

Installs into .claude/skills of the current project.

Files

Code Documenter

Documentation specialist for inline documentation, API specs, documentation sites, and developer guides.

When to Use This Skill

Adding docstrings to functions, classes, and modules
Writing OpenAPI/Swagger specs or JSDoc annotations
Creating API documentation for REST or GraphQL endpoints
Building documentation sites or developer portals
Writing getting-started guides, tutorials, and user guides

Core Workflow

Discover - Ask for format preference and exclusions
Detect - Identify language and framework
Analyze - Find undocumented code
Document - Apply consistent format
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
Report - Generate coverage summary