Code documenter

Skill zacklecon/claude-skills/skills/code-documenter

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

Install

npx -y skills add zacklecon/claude-skills --skill code-documenter

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

3 stars3 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its file declares

Copied from the file, not written here

The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.

SKILL.md

3.6 KB, 694 tokens by cl100k_base, as published. Nobody here has run it

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

Discover - Ask for format preference and exclusions
Detect - Identify language and framework
Analyze - Find undocumented code
Document - Apply consistent format
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-docs-fastapi-django.md`	Python API documentation
NestJS/Express API	`references/api-docs-nestjs-express.md`	Node.js API documentation
Coverage Reports	`references/coverage-reports.md`	Generating documentation reports
Documentation Systems	`references/documentation-systems.md`	Doc sites, static generators, search, testing
Interactive API Docs	`references/interactive-api-docs.md`	OpenAPI 3.1, portals, GraphQL, WebSocket, gRPC, SDKs
User Guides & Tutorials	`references/user-guides-tutorials.md`	Getting started, tutorials, troubleshooting, FAQs

Constraints

MUST DO

Ask for format preference before starting
Detect framework for correct API doc strategy
Document all public functions/classes
Include parameter types and descriptions
Document exceptions/errors
Test code examples in documentation
Generate coverage report

MUST NOT DO

Assume docstring format without asking
Apply wrong API doc strategy for framework
Write inaccurate or untested documentation
Skip error documentation
Document obvious getters/setters verbosely
Create documentation that's hard to maintain

Output Formats

Depending on the task, provide:

Code Documentation: Documented files + coverage report
API Docs: OpenAPI specs + portal configuration
Doc Sites: Site configuration + content structure + build instructions
Guides/Tutorials: Structured markdown with examples + diagrams

Knowledge Reference

Google/NumPy/Sphinx docstrings, JSDoc, OpenAPI 3.0/3.1, AsyncAPI, gRPC/protobuf, FastAPI, Django, NestJS, Express, GraphQL, Docusaurus, MkDocs, VitePress, Swagger UI, Redoc, Stoplight

What ships with it: 8 files

44.4 KB alongside SKILL.md

references/

Gives 1 of the 12 instructions most api reference skills give in 694 tokens

Counted across 159 of the 198 authors here whose files we hold, read 2026-09-06

Document all possible error responsesin 14 of 159, across 7 files
Create OpenAPI 3.0 compliant specificationsin 13 of 159, across 7 files
Use $ref for reusable componentsin 12 of 159, across 6 files
Include example requests and responsesin 11 of 159, across 5 files
Group endpoints logically with tagsin 11 of 159, across 5 files
Document all endpoints with descriptions and examplesin 10 of 159, across 4 files
Define request and response schemas accuratelyin 9 of 159, across 3 files
Include authentication and security schemesin 8 of 159, across 2 files
Provide clear examples for all operationsin 8 of 159, across 2 files
Use descriptive summaries and descriptionsin 8 of 159, across 2 files
Use clear operation IDsin 8 of 159, across 2 files
Include parameter types and descriptionshere, and in 7 of 159, across 5 files

Said here and by no other author read

Detect the framework before writing API docs

Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.