# code-documenter

> Claude/Codex skill by [@jeffallan](https://omgskills.com/library/jeffallan/index.md) · 12k stars · Updated 2026-10-30

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.

Tags: ai-agents, claude, claude-code, claude-marketplace, claude-skills

## Install

```sh
git clone https://github.com/Jeffallan/claude-skills /tmp/claude-skills && ln -s /tmp/claude-skills/skills/code-documenter ~/.claude/skills/code-documenter
```

## From README

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...

## Links

- HTML page: https://omgskills.com/library/jeffallan/claude-skills/code-documenter/
- GitHub: https://github.com/Jeffallan/claude-skills
- Author: [@jeffallan](https://omgskills.com/library/jeffallan/index.md)

## More from this repo

- [api-designer](https://omgskills.com/library/jeffallan/claude-skills/api-designer/index.md) — Used when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture.
   - [@jeffallan](https://omgskills.com/library/jeffallan/index.md) · 12k stars
- [architecture-designer](https://omgskills.com/library/jeffallan/claude-skills/architecture-designer/index.md) — Used when designing new high-level system architecture, reviewing existing designs, or making architectural decisions.
   - [@jeffallan](https://omgskills.com/library/jeffallan/index.md) · 12k stars
- [atlassian-mcp](https://omgskills.com/library/jeffallan/claude-skills/atlassian-mcp/index.md) — Integrates with Atlassian products to manage project tracking and documentation via MCP protocol.
   - [@jeffallan](https://omgskills.com/library/jeffallan/index.md) · 12k stars