jsdoc-typescript-docs

Guide TypeScript/JSDoc documentation decisions for library APIs.

3|Updated Jun 23, 2022
One-click install
npx skills add https://github.com/fbosch/dotfiles --skill jsdoc-typescript-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: jsdoc-typescript-docs
Source: https://github.com/fbosch/dotfiles/tree/main/.agents/skills/jsdoc-typescript-docs
Command: npx skills add https://github.com/fbosch/dotfiles --skill jsdoc-typescript-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill provides expert guidance to decide what to document in TypeScript/JSDoc for libraries, balancing thoroughness with audience needs and avoiding documentation drift.

Core Features & Use Cases

  • Decision guidance on what to document for public vs internal consumers
  • Strategy for choosing examples, edge cases, and migration notes
  • References to common documentation patterns and setup (TypeDoc, MDN links)

Quick Start

Provide your project context and let the AI generate a tailored TS/JSDoc documentation strategy, including audience targets and tooling recommendations.

Frequently Asked Questions about jsdoc-typescript-docs

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

FAQPage Schema
How do I document a TypeScript library API for public vs internal consumers?

Documenting a TypeScript library API requires differentiating public interfaces from internal modules. This skill provides decision guidance on what to document, balancing thoroughness with audience needs to prevent documentation drift.

What's the best way to structure JSDoc comments for TypeScript library documentation?

Structuring JSDoc for TypeScript involves choosing examples, edge cases, and migration notes strategically. This skill generates a tailored documentation strategy that targets specific audiences and recommends practical patterns.

How do I set up TypeDoc for generating TypeScript API documentation?

Setting up TypeDoc for TypeScript API documentation involves configuring references for public API docs, error notes, and anti-patterns. This skill provides setup references and tooling recommendations to get started.

When should I include migration notes and error documentation in TypeScript API docs?

Migration notes and error documentation in TypeScript API docs are needed when satisfying thorough public API requirements. This skill offers strategy decisions on when to include edge cases and practical examples for library consumers.

Does JSDoc work well with TypeScript for generating library API documentation?

JSDoc works with TypeScript to generate library API documentation when paired with TypeDoc tooling. This skill covers setup references and documentation strategies that balance JSDoc annotations with TypeScript type definitions.

How to avoid documentation drift when maintaining TypeScript JSDoc comments?

Avoiding documentation drift in TypeScript JSDoc requires audience-specific guidance and strategic documentation decisions. This skill helps decide what to document, ensuring thoroughness without creating maintenance overhead.