Code Documenter
Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides.
Before & after
Same prompt, same agent — the only difference is the skill.
API documentation is important, and there are a few formats like OpenAPI and JSDoc that work well. You could write it inline with your code or generate it separately. Tools exist to help validate and maintain docs, but setup varies. What format does your team prefer?
DOCUMENTATION OUTPUT SUITE:
FORMAT 1: OPENAPI SPECIFICATION
→ Auto-generated from code structure (request/response objects, auth, status codes)
→ Includes all endpoints, param types, example payloads
→ YAML or JSON, compatible with Swagger UI
FORMAT 2: JSDOC ANNOTATIONS
→ Inline docstrings auto-inserted above functions
→ Template: @param {type} name - description
→ @returns {type} description + @throws {error} cases
FORMAT 3: MARKDOWN PORTAL
→ Getting started guide (install, auth, first request)
→ Endpoint reference (organized by feature)
→ Error codes + troubleshooting (common gotchas)
→ Code snippets (node.js, Python, curl examples)
VALIDATION CHECKLIST:
☐ All endpoints documented
☐ Every param has a type and description
☐ Response examples included
☐ Error codes mapped to solutions
☐ No outdated endpoints
INTEGRATION:
• Post-commit hook: re-generate docs, flag mismatches
• Preview: Swagger UI deployed to docs.example.com
• Build gate: fails if 10% of endpoints lack examples
TIME SAVED: Auto-generation eliminates 60% of manual doc work. Keep humans only for "why" + examples.About this skill
name: code-documenter description: Use when Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides.
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.
What you get
- Public GitHub repo
- the skills/code-documenter folder with SKILL.md and references.
Customize your output
- Fork the repo and extend the skill's reference files for your own stack conventions.
Example output
Activates on a matching request (e.g. building or reviewing Code Documenter code) and can chain with other skills in the pack.
Best for
Full-stack developers and engineering teams using Claude Code.
SKILL.md preview
---
name: code-documenter
description: Use this skill when code, APIs, or a project need docstrings, OpenAPI specs, JSDoc annotations, a documentation site, or user guides written and validated.
version: 1.0.0
category: Development / Engineering
author: AgentVolt
license: proprietary
tags:
- development
- engineering
---
# Code Documenter
Generates and validates technical documentation across formats: function and class docstrings, OpenAPI/Swagger specs, JSDoc annotations, documentation portals, and getting-started guides.
## When to use
… (sign up to view the full skill)More development skills
View all Development skills →Generate
Scaffold code, tests, and boilerplate from a short spec.
Performance Profiler
Systematic performance profiling for Node.js, Python, and Go applications.
Threat Detection
Use when hunting for threats in an environment, analyzing IOCs, or detecting behavioral anomalies in telemetry.
Agent Harness
Turns a domain folder of skills into a bounded agentic loop: compile a goal into a task plan, execute with the domain's tools, verify every task, retry within a budget.