accelint-ts-documentation

What problem does it solve?

This Skill audits and improves JavaScript/TypeScript documentation, covering JSDoc comments, marker-based quality, and general comment hygiene to reduce drift and improve maintainability.

Core Features & Use Cases

• JSDoc Auditing: Enforces comprehensive documentation for public APIs and internal code, including description, @param, @returns, @template, and @example tags.
• Comment Quality: Guides on marker usage (TODO, FIXME, HACK, NOTE, PERF, REVIEW, DEBUG, REMARK), removal of dead or redundant comments, and proper placement.
• Expert Judgment: Provides anti-patterns, decision trees, and framework-style thinking to determine documentation sufficiency.
• Edge Case Coverage: Addresses deprecated APIs, overloads, generics, and object parameters with dot notation, plus nested property documentation.
• Progressive References: Loads references (references/jsdoc.md, references/comments.md) only when needed to minimize cognitive load.

Quick Start

Use accelint-ts-documentation to audit and improve code documentation. Common prompts include "Add JSDoc to all exported functions in src/api/client.ts" or "Review and annotate comment markers in src/core/".