skills.rest
giuseppe-trisciuoglio
giuseppe-trisciuoglioCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

typescript-docs

Generate TypeScript API references and ADRs with TypeDoc and JSDoc.

322|37|Updated Oct 21, 2025
Search Tags:#typescript#documentation#adr#jsdoc#api-docs#typedoc#framework-patterns
One-click install
npx skills add https://github.com/giuseppe-trisciuoglio/developer-kit --skill typescript-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: typescript-docs
Source: https://github.com/giuseppe-trisciuoglio/developer-kit/tree/main/skills/typescript-docs
Command: npx skills add https://github.com/giuseppe-trisciuoglio/developer-kit --skill typescript-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive TypeScript documentation for APIs, ADRs, code examples, and framework-specific patterns across frontend and backend stacks, dramatically reducing manual writing time and ensuring consistency.

Core Features & Use Cases

  • API Documentation: Generate API references using TypeDoc and related tools for TypeScript projects.
  • ADR Documentation: Maintain Architectural Decision Records to capture design rationale.
  • Multi-Framework Patterns: Include patterns for NestJS, Express, React, Angular, and Vue to serve multiple audiences.
  • Use Case: When onboarding a new TS module, automatically generate API docs, ADRs, and example snippets.

Quick Start

Install TypeDoc and related tooling, then run the documentation generator configured for your project. For example, install typedoc and generate docs with a markdown theme, then review the resulting docs in the docs/ directory.

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 API documentation automatically?▼

TypeScript API documentation is generated using tools like TypeDoc that parse JSDoc annotations and type definitions. This Skill automates configuration and output formatting to produce API references from your TypeScript modules in markdown or HTML format.

Can I generate documentation for multiple frameworks like NestJS, Express, and React at once?▼

Yes. This Skill applies layered documentation patterns across NestJS, Express, React, Angular, and Vue, generating framework-specific API docs and examples in a single workflow without reconfiguring for each stack.

What's the fastest way to document a new TypeScript module with examples and ADRs?▼

Install TypeDoc and configure JSDoc annotations on your module, then run the generator to produce API references, Architectural Decision Records, and code examples. This Skill automates the full pipeline so onboarding takes hours, not days.

Do I need to write JSDoc comments manually for TypeDoc to work?▼

JSDoc annotations provide the source material for TypeDoc output, describing parameters, return types, and context. This Skill streamlines the annotation process and template reuse, but JSDoc comments remain the input layer.

How do I maintain consistency across API docs and architectural decision records?▼

Architectural Decision Records and API documentation share reusable templates and patterns managed by this Skill. Applying consistent structures across both ensures design rationale and API contracts stay aligned throughout your TypeScript projects.

Related Skills

Explore More Software Engineering Skills→
vecearvecear

jsdoc-typescript-docs

Generate Markdown or HTML API documentation from TypeScript sources using JSDoc comments.

Community
Advanced
toanalientoanalien

mintlify

Builds and deploys Markdown/MDX documentation sites via Mintlify.

Community
Advanced
jeremydhoover-blipjeremydhoover-blip
7

maintaining-docs-as-code

Manage documentation with version control, CI/CD, and automated testing.

Community
Advanced
kssuminkssumin

api-docs-reference

Generate an OpenAPI 3 specification from Spring REST Docs.

Community
Intermediate