This skill streamlines the documentation lifecycle for JavaScript and TypeScript projects by parsing source code comments to generate comprehensive, professional API references. It integrates seamlessly with TypeDoc to produce HTML, Markdown, or JSON outputs while enforcing strict documentation standards through ESLint and validating coverage thresholds. It is an essential tool for SDK developers and library maintainers who need to ensure that implementation and documentation remain perfectly aligned and audit-ready without manual overhead.
主な機能
011,203 GitHub stars
02Validates documentation coverage and completeness against set thresholds
03Enforces documentation standards with ESLint plugins for consistent docstrings
04Supports TypeDoc integration for type-safe documentation and alignment
05Parses JSDoc/TSDoc comments for automatic API documentation generation
06Generates multi-format output including HTML, Markdown, and JSON
ユースケース
01Generating comprehensive API reference documentation for SDKs and open-source libraries
02Auditing existing codebases to identify and fix missing or incomplete documentation
03Automating documentation pipelines within CI/CD workflows to ensure docs stay updated