doc-generator_skill

Overview

This skill generates comprehensive documentation for TypeScript projects, including JSDoc/TSDoc comments, interface and class docs, API reference pages, changelogs, and a project overview file. It is designed to automate doc creation from code, enforce consistency, and produce examples and error descriptions for public APIs.

How this skill works

The skill scans source files to find exported functions, classes, and interfaces, identifies undocumented or poorly documented symbols, and generates clear JSDoc/TSDoc annotations and markdown documentation. It creates parameter descriptions, return types, usage examples, error documentation, and a changelog entry template, then validates docs with TypeScript and linting tools.

When to use it

• Onboard new contributors and ensure public APIs are documented
• Prepare release notes and changelog entries before publishing
• Add JSDoc/TSDoc comments to TypeScript codebase missing inline docs
• Generate API reference and example usage for packages or services
• Automate documentation as part of CI or pre-release checks

Best practices

• Write brief imperative summaries and expand only when necessary
• Include parameter types, return descriptions, examples, and thrown errors
• Document all public exports and keep examples minimal and runnable
• Run typedoc validation and jsdoc lint rules as part of CI
• Keep changelog entries focused: Added, Changed, Fixed, Deprecated, Removed, Security

Example use cases

• Add JSDoc comments for exported utility functions before a library release
• Produce an API reference markdown for a client SDK from TypeScript sources
• Generate interface and class documentation for a backend service module
• Create a project overview file and usage examples for new contributors
• Auto-create a changelog stub for each release candidate