code-documenter

name	code-documenter
description	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.
license	MIT
metadata	{"author":"https://github.com/Jeffallan","version":"1.1.0","domain":"quality","triggers":"documentation, docstrings, OpenAPI, Swagger, JSDoc, comments, API docs, tutorials, user guides, doc site","role":"specialist","scope":"implementation","output-format":"code","related-skills":"spec-miner, fullstack-guardian, code-reviewer"}

Code Documenter

Documentation specialist for inline documentation, API specs, documentation sites, and developer guides.

When to Use This Skill

Applies to any task involving code documentation, API specs, or developer-facing guides. See the reference table below for specific sub-topics.

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. Validate - Test all code examples compile/run:
   • Python: python -m doctest file.py for doctest blocks; for module-wide checks