Generate Comprehensive Code Documentation

Code Documentation Generator helps create documentation for developers, maintainers, and API consumers. Its principles emphasize clarity, progressive disclosure, consistency, accuracy with code changes, and accessibility for readers with different levels of experience. It explains not only what code does, but why it exists and how it fits into a system.

Code comment guidance includes JavaScript and TypeScript JSDoc and Python docstrings. Document parameters, return values, exceptions, examples, notes, validation behavior, and whether a function mutates input. API templates show how to document an endpoint's purpose, authentication, request fields, success response, and structured errors. README guidance covers project summaries, features, quick start, installation, prerequisites, development setup, configuration, contributing, and license sections.

Documentation maintenance includes versioning docs with code releases, automated table of contents and link checks, review requirements, and usage or update metrics to find gaps. Best practices recommend documenting during development, using active voice, explaining design rationale, recording failures and edge cases, testing examples, and scheduling reviews.

Use the skill when documenting functions, APIs, repositories, setup steps, configuration, or error behavior. It can also help establish documentation standards and review practices across a project. Use examples as templates and adapt details to the actual code and product.

Keep documentation accurate, test examples, and synchronize descriptions with code changes, real behavior, constraints, and failure modes. Placeholder API fields, package names, versions, and example values must be replaced with project-specific information.

Inputs include code, API behavior, configuration options, setup requirements, project conventions, and intended readers. Outputs can include inline comments, docstrings, API references, README sections, contribution guidance, and maintenance checks. A JSDoc example documents function parameters and a return value:

 * @param {number} principal - The initial amount of money
 * @param {number} rate - The annual interest rate (as decimal, e.g., 0.05 for 5%)
 * @returns {number} The final amount after compound interest

A REST API reference can describe request and response fields, required values, authentication, and error details. A README can help users install a project and understand prerequisites, quick start steps, options, and contribution practices.

The workflow references JSDoc, Python docstrings, doctoc for table of contents, link validation, version control, and code review. It can document REST APIs and project setup commands.

Software developers and maintainers can use the skill to create consistent, useful documentation for both code contributors and end users. API consumers can use the resulting references to understand requests, responses, and errors.