typescript-docs_skill

Overview

This skill generates production-ready TypeScript documentation tailored to multiple audiences using JSDoc, TypeDoc, and layered documentation patterns. It produces API references, architectural decision records (ADRs), runnable code examples, and framework-specific docs for NestJS, Express, React, Angular, and Vue. The output is structured for CI/CD pipelines and versioned releases.

How this skill works

The skill scans TypeScript source files, injects or validates JSDoc comments, and builds TypeDoc configuration to emit API docs in chosen formats (HTML, Markdown). It also creates ADR templates, example snippets, and framework-focused doc stubs, then validates links and doc coverage with linting rules. You can integrate it into CI to auto-generate and publish docs on changes.

When to use it

• Generate TypeDoc-based API reference for a library or service
• Add or enforce JSDoc comments across public APIs
• Create ADRs for TypeScript architecture decisions
• Produce framework-specific guides for NestJS, Express, React, Angular, or Vue
• Set up automated doc generation in CI/CD pipelines

Best practices

• Document public surface area only; exclude private/internal members from published output
• Use @param, @returns, @example, @deprecated and @see consistently for discoverability
• Keep runnable examples minimal and tested; include copy-paste ready snippets
• Version docs alongside code and include migration guidance when marking @deprecated
• Validate links and run ESLint JSDoc rules as part of pre-commit or CI

Example use cases

• Create a complete API site for a TypeScript SDK with TypeDoc and markdown theme
• Add comprehensive JSDoc to a NestJS service, including security and performance notes
• Generate ADRs documenting framework selection, strict mode, or CI decisions
• Produce component docs for React or Angular with prop tables and usage examples
• Configure a CI job that regenerates and publishes docs to a docs site on each release