accelint-ts-documentation

Audit JavaScript/TypeScript documentation against JSDoc standards and comment quality.

21|4|Updated Jan 15, 2026
One-click install
npx skills add https://github.com/gohypergiant/agent-skills --skill accelint-ts-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: accelint-ts-documentation
Source: https://github.com/gohypergiant/agent-skills/tree/main/skills/accelint-ts-documentation
Command: npx skills add https://github.com/gohypergiant/agent-skills --skill accelint-ts-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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/".

Frequently Asked Questions about accelint-ts-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit JSDoc comments in a TypeScript project?

To audit JSDoc comments in TypeScript, use this skill to validate tags like @param, @returns, and @template across both exported and internal code. It enforces JSDoc standards by loading reference guides to ensure proper syntax and thorough coverage during documentation tasks.

What is the best way to improve JavaScript documentation quality?

The best way to improve JavaScript documentation quality is by applying expert judgment to enforce comment hygiene and JSDoc standards. This skill audits marker usage like TODO and FIXME, removes dead comments, and uses decision trees to determine documentation sufficiency.

Can I use static analysis to review TODO and FIXME markers in JS code?

Yes, you can use static analysis to review TODO and FIXME markers in JS code. This skill guides the annotation and cleanup of comment markers including HACK, NOTE, PERF, REVIEW, and DEBUG, ensuring proper placement and removing redundant comments across your project.

How do I document TypeScript generics and overloaded APIs?

To document TypeScript generics and overloaded APIs, apply the skill's edge case coverage which addresses deprecated APIs, overloads, generics, and object parameters with dot notation. It enforces comprehensive tag usage and nested property documentation for complex types.

Does JSDoc auditing work for internal code or only exported functions?

JSDoc auditing works for both internal code and exported functions. The skill enforces comprehensive documentation across entire projects, guiding users to validate tags, describe behavior, and fix markers for all code rather than just public APIs.

What are the limitations of automated comment quality tools?

Automated comment quality tools cannot fully replace human judgment in determining documentation sufficiency. This skill mitigates that by providing anti-patterns, decision trees, and framework-style thinking to guide expert-level documentation decisions rather than applying rigid rules blindly.