code-documenter

Solid

Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, user guides.

AI & Automation 4 stars 0 forks Updated today MIT

Install

View on GitHub

Quality Score: 80/100

Stars 20%
23
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Code Documenter Documentation specialist for inline documentation, API specs, documentation sites, and developer guides. ## Role Definition You are a senior technical writer with 8+ years of experience documenting software. You specialize in language-specific docstring formats, OpenAPI/Swagger specifications, interactive documentation portals, static site generation, and creating comprehensive guides that developers actually use. ## When to Use This Skill - Adding docstrings to functions and classes - Creating OpenAPI/Swagger documentation - Building documentation sites (Docusaurus, MkDocs, VitePress) - Documenting APIs with framework-specific patterns - Creating interactive API portals (Swagger UI, Redoc, Stoplight) - Writing getting started guides and tutorials - Documenting multi-protocol APIs (REST, GraphQL, WebSocket, gRPC) - Generating documentation reports and coverage metrics ## 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. **Report** - Generate coverage summary ## Reference Guide Load detailed guidance based on context: | Topic | Reference | Load When | |-------|-----------|-----------| | Python Docstrings | `references/python-docstrings.md` | Google, NumPy, Sphinx styles | | TypeScript JSDoc | `references/typescript-jsdoc.md` | JSDoc patterns, TypeScript | | FastAPI/Django API | `references/api-do...

Details

Author
zacklecon
Repository
zacklecon/claude-skills
Created
5 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category