gohypergiant avatar

Accelint Ts Documentation

This handles JSDoc comments and comment quality audits for TypeScript and JavaScript codebases. It's built around a two-tier system: exported APIs get comprehensive documentation with all the tags (@param, @returns, @template, @example), while internal code only gets documented when it's not self-evident from the function signature and names. The skill includes detailed guidance on comment markers (TODO, FIXME, HACK), when to remove obvious or outdated comments, and proper @example formatting with code fences. It even has a judgment framework asking who the reader is and whether you're dealing with opacity or complexity. The audit template is thorough, maybe more structured than you need for quick fixes, but solid if you're doing a real documentation review.

skills.sh installs
263
GitHub stars
25
last updated
Aug 21, 2026

Install

$ npx -y skills add gohypergiant/agent-skills --skill accelint-ts-documentation --agent claude-code

Installs into .claude/skills of the current project.

Files

Code Documentation Skill

Comprehensive skill for improving JavaScript/TypeScript documentation, including JSDoc comments, comment markers, and general comment quality.

When to Activate This Skill

Use this skill when the task involves:

JSDoc Documentation

  • Adding JSDoc comments to exported functions, types, interfaces, or classes
  • Validating JSDoc completeness (missing @param, @returns, @template tags)
  • Ensuring JSDoc @example tags use proper code fences
  • Documenting object parameters with destructuring using dot notation

Comment Quality

  • Identifying and categorizing comments using proper markers (TODO, FIXME, HACK, NOTE, PERF, REVIEW, DEBUG, REMARK)
  • Removing unnecessary comments (commented-out code, edit history, obvious statements)
  • Preserving important comments (markers, linter directives, business logic)
  • Improving comment placement (moving end-of-line comments above code)

Documentation Audits

  • Reviewing code for documentation completeness
  • Ensuring exported code has comprehensive documentation
  • Validating internal code has minimum required documentation

When NOT to Use This Skill

Sponsors

Details

Repository
github.com/gohypergiant/agent-skills
Categories
Documentation, Code Review & Quality, AI & Agent Building, Debugging
First seen
Jun 3, 2026

More from gohypergiant/agent-skills

All 14
1odyssey4me avatargoogle-docsodyssey4me/agent-skillsCreate and modify Google Docs documents. Read content, insert tables, apply heading styles, and manage formatting. Use when asked to edit a gdoc, write a Google262skills.sh installs
2cinience avataralicloud-platform-multicloud-docs-api-benchmarkcinience/alicloud-skillsBenchmark similar product documentation and API documentation across Alibaba Cloud, AWS, Azure, GCP, Tencent Cloud, Volcano Engine, and Huawei Cloud. Given one 260skills.sh installs
3levnikolaevich avatarln-611-docs-structure-auditorlevnikolaevich/claude-code-skillsChecks hierarchy, links, SSOT, compression, requirements compliance, freshness, legacy cleanup. Use when auditing documentation structure.256skills.sh installs
4qodex-ai avatargenerate-swagger-docsqodex-ai/ai-agent-skillsGenerate OpenAPI documentation from source code. Analyzes repository to automatically discover API endpoints and create swagger.json and interactive HTML docume255skills.sh installs
5everyinc avatardeploy-docseveryinc/compound-engineering-pluginValidate and prepare documentation for GitHub Pages deployment234skills.sh installs
6charleswiltgen avataraxiom-apple-docs-researchcharleswiltgen/axiomUse when researching Apple frameworks, APIs, or WWDC sessions - provides techniques for retrieving full transcripts, code samples, and documentation using Chrom202skills.sh installs