accelint-ts-documentation

Audit JavaScript/TypeScript documentation and generate fixes for JSDoc tags and code-quality markers.

17|1|Updated Mar 14, 2025

Search Tags:#typescript #documentation #audit #jsdoc #edge-cases #code-comments #comment-quality

Ready to run

npx skills add https://github.com/deckgl-fiber-renderer/fiber.gl --skill accelint-ts-documentation-deckgl-fiber-renderer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: accelint-ts-documentation
Source: https://github.com/deckgl-fiber-renderer/fiber.gl/tree/main/.agents/skills/accelint-ts-documentation
Command: npx skills add https://github.com/deckgl-fiber-renderer/fiber.gl --skill accelint-ts-documentation-deckgl-fiber-renderer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

This Skill helps teams improve JavaScript/TypeScript documentation by auditing JSDoc tags, comment markers, and general comment quality, ensuring consistency and clarity across public APIs and internal utilities.

Core Features & Use Cases

JSDoc auditing for exported and internal code, ensuring description, @param, @returns, @template, @throws, and @example presence where appropriate.
Comment quality checks, including marker usage (TODO, FIXME, HACK, NOTE, PERF, REVIEW, DEBUG, REMARK), removal of dead code, and optimal comment placement.
Guidance on edge cases (deprecated APIs, overloads, generics) with judgment frameworks, decision trees, and conflict resolution.
Production-ready audit workflows with references to detailed guidance and templates for reporting.

Quick Start

Audit the documentation of a target codebase and output a structured improvement plan.

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 tags in a TypeScript project?▼

You can audit JSDoc tags by scanning exported and internal code to validate the presence and consistency of @param, @returns, @template, @throws, and @example tags, then generating a structured report with actionable fixes for missing or misplaced documentation.

What is the best way to check comment quality and marker usage in JavaScript code?▼

Comment quality checks involve scanning for marker usage like TODO, FIXME, HACK, and NOTE, identifying dead code comments, and verifying optimal comment placement to ensure internal utilities and public APIs remain clear and maintainable.

How do I document deprecated APIs and overloaded functions in TypeScript?▼

Documenting deprecated APIs and overloads requires applying judgment frameworks and decision trees to resolve conflicts, ensuring @deprecated tags and overload signatures are placed correctly while preserving existing tool directives.

Can I generate a structured documentation improvement plan for existing code?▼

Yes, you can generate a structured improvement plan by auditing the target codebase for JSDoc completeness and comment consistency, which produces an actionable report detailing required fixes for public APIs and internal utilities.

Does TypeScript documentation auditing work for internal utilities or only exported APIs?▼

TypeScript documentation auditing applies to both exported public APIs and internal code, validating JSDoc tag completeness, marker usage, and comment placement across the entire codebase to ensure consistency regardless of visibility.