Typescript Docs

TypeScript Documentation

Generate production-ready TypeScript documentation with layered architecture for multiple audiences. Supports API docs with TypeDoc, ADRs, and framework-specific patterns.

Overview

Use JSDoc annotations for inline documentation, TypeDoc for API reference generation, and ADRs for tracking design choices.

Key capabilities:

• TypeDoc configuration and API documentation generation
• JSDoc patterns for all TypeScript constructs
• ADR creation and maintenance
• Framework-specific patterns (NestJS, React, Express, Angular, Vue)
• ESLint validation rules for documentation quality
• GitHub Actions pipeline setup

When to Use

Use this skill when creating API documentation, architectural decision records, code examples, or framework-specific patterns for NestJS, Express, React, Angular, or Vue.

Quick Reference

Tool	Purpose	Command
TypeDoc	API documentation generation	npx typedoc
Compodoc	Angular documentation	npx compodoc -p tsconfig.json
ESLint JSDoc	Documentation validation	eslint --ext .ts src/

JSDoc Tags