doc-generator

JSDoc and API documentation can be automatically generated by analyzing your code structure and extracting function signatures, parameters, and types. This Skill scans your JavaScript/TypeScript projects, identifies functions and classes, applies JSDoc/TSDoc formatting conventions, and produces comprehensive API reference documentation without manual writing.

Yes. README files and CHANGELOGs can be auto-generated by extracting project metadata, interface definitions, and code structure. This Skill analyzes your repository, synthesizes documentation artifacts including README content and CHANGELOG entries, and validates output using TypeScript doc checks and ESLint to ensure consistency.

Automated documentation generation eliminates manual writing by analyzing your codebase end-to-end, extracting interface definitions and function metadata, and producing JSDoc-formatted comments and interface documentation. This Skill implements the full workflow from code analysis through validation, reducing documentation maintenance overhead.

This Skill is applicable to JavaScript/TypeScript projects and integrates with existing JSDoc/TSDoc annotations. It analyzes your current code structure, generates missing documentation, and validates all outputs with TypeScript doc checks, so it complements existing documentation rather than replacing it.

Documentation generation supports JavaScript/TypeScript codebases with functions, classes, and interfaces. The Skill produces JSDoc/TSDoc annotations, API reference files, README documents, and CHANGELOGs. It uses Bash, Grep, and Glob patterns to locate and analyze source files, then validates output through TypeScript and ESLint tooling.

Automated documentation eliminates time-consuming manual writing, ensures consistency across API references and code comments, and reduces maintenance burden as code evolves. This Skill generates comprehensive, validated documentation artifacts end-to-end, freeing developers to focus on code rather than documentation upkeep.