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.
Install
With your agent
Install OMGSkills skill "jeffallan/claude-skills:code-documenter" into this agent's normal skills directory: call the OMGSkills MCP get_install_plan tool for your agent and run the script it returns (it installs only the pinned commit and verifies SKILL.md), and stop if MCP or the pin is unavailable. Do not overwrite or change existing skills without asking me.
Manual command
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...
More from this repo
api-designer
Used when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture.
architecture-designer
Used when designing new high-level system architecture, reviewing existing designs, or making architectural decisions.
atlassian-mcp
Integrates with Atlassian products to manage project tracking and documentation via MCP protocol.
