typescript-docs

Generate TypeDoc-based API references, ADRs, and runnable code examples.

Updated Apr 5, 2026

Search Tags:#typescript #architecture #documentation #adr #jsdoc #docs #typedoc

Ready to run

npx skills add https://github.com/rizaldiem/digital-invitation-web_V2 --skill typescript-docs-rizaldiem

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: typescript-docs
Source: https://github.com/rizaldiem/digital-invitation-web_V2/tree/main/.windsurf/skills/typescript-docs
Command: npx skills add https://github.com/rizaldiem/digital-invitation-web_V2 --skill typescript-docs-rizaldiem

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

TypeScript documentation is often scattered across code comments, ADRs, and separate docs; this Skill automates multi-layered documentation generation for consistency and accessibility.

Core Features & Use Cases

TypeDoc-driven API reference generation for TypeScript projects
Architectural Decision Records (ADRs) templating and cross-referencing
Multi-audience documentation patterns with runnable code examples
Framework-agnostic guidance for NestJS, Express, React, Angular, and Vue
Versioned, publish-ready documentation pipelines

Quick Start

Run the TypeScript documentation workflow to generate API docs, ADRs, and cross-referenced examples for your project.

Frequently Asked Questions about typescript-docs

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

FAQPage Schema

How do I generate TypeScript documentation that combines API references, ADRs, and code examples?▼

TypeScript documentation generation unifies API references, ADRs, and code examples by enforcing TypeDoc workflows, JSDoc patterns, and ADR templates with cross-references. This automation produces consistent, multi-layered, publish-ready outputs for your project.

Does TypeDoc documentation generation work with NestJS, Express, React, Angular, and Vue?▼

TypeDoc documentation generation works with NestJS, Express, React, Angular, and Vue projects. The workflow applies framework-agnostic guidance to produce API docs, architectural decisions, and component documentation across these platforms.

What is the best way to maintain consistent architectural decision records across a TypeScript codebase?▼

Architectural decision records consistency is maintained through automated ADR templating and cross-referencing within the TypeScript documentation workflow. This approach connects architectural documentation directly to API references and runnable code examples.

How do I create versioned, publish-ready documentation pipelines for a TypeScript project?▼

Versioned TypeScript documentation pipelines are created by applying TypeDoc-based workflows, JSDoc patterns, and cross-referenced examples. This generates multi-audience documentation outputs that are versioned and ready for publishing.

Can I include runnable code examples in generated TypeScript API documentation?▼

Runnable code examples are included in generated TypeScript API documentation through multi-audience documentation patterns. The workflow creates cross-referenced examples alongside API references and architectural decision records.

Why does TypeScript documentation often become scattered across code comments and separate files?▼

TypeScript documentation becomes scattered when code comments, ADRs, and API docs are maintained separately. Automating multi-layered documentation generation enforces TypeDoc workflows and JSDoc patterns to ensure consistency and accessibility across all layers.