Now liveThe Skillselion MCP - thousands of ranked skills, loaded into your agent mid-task. No install.Get it →
giuseppe-trisciuoglio avatar

Typescript Docs

giuseppe-trisciuoglio/developer-kit

  • 2.1k installs
  • 311 repo stars
  • Updated June 22, 2026
  • giuseppe-trisciuoglio/developer-kit

typescript-docs is an agent skill that Generates comprehensive TypeScript documentation using JSDoc, TypeDoc, and multi-layered documentation patterns for diff.

About

Generate production ready TypeScript documentation with layered architecture for multiple audiences Supports API docs with TypeDoc ADRs and framework specific patterns 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 Use this skill when creating API documentation architectural decision records code examples or framework specific patterns for NestJS Express React Angular or Vue 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 The typescript docs agent skill provides documented workflows prerequisites triggers and safety guidance from its SKILL md source Agents load it when user requests match the description and follow step by step instructions without inventing capabilities It integrates with s.

  • description: Generates comprehensive TypeScript documentation using JSDoc, TypeDoc, and multi-layered documentation patt
  • allowed-tools: Read, Write, Edit, Bash, Grep, Glob
  • Generate production-ready TypeScript documentation with layered architecture for multiple audiences. Supports API docs w
  • Follow typescript-docs SKILL.md steps and documented constraints.
  • Follow typescript-docs SKILL.md steps and documented constraints.

Typescript Docs by the numbers

  • 2,055 all-time installs (skills.sh)
  • +60 installs in the week ending Jul 28, 2026 (Skillselion tracking)
  • Ranked #556 of 16,659 AI & Agent Building skills by installs in the Skillselion catalog
  • Security screen: MEDIUM risk (skills.sh audit)
  • Data as of Jul 28, 2026 (Skillselion catalog sync)
At a glance

typescript-docs capabilities & compatibility

Capabilities
description: generates comprehensive typescript · allowed tools: read, write, edit, bash, grep, gl · generate production ready typescript documentati · follow typescript docs skill.md steps and docume
Use cases
orchestration
From the docs

What typescript-docs says it does

description: Generates comprehensive TypeScript documentation using JSDoc, TypeDoc, and multi-layered documentation patterns for different audiences. Use when creating API documentation, architectural
SKILL.md
allowed-tools: Read, Write, Edit, Bash, Grep, Glob
SKILL.md
Generate production-ready TypeScript documentation with layered architecture for multiple audiences. Supports API docs with TypeDoc, ADRs, and framework-specific patterns.
SKILL.md
npx skills add https://github.com/giuseppe-trisciuoglio/developer-kit --skill typescript-docs

Add your badge

Show developers this skill is listed on Skillselion. Paste this into your README.

Listed on Skillselion
Installs2.1k
repo stars★ 311
Security audit3 / 3 scanners passed
Last updatedJune 22, 2026
Repositorygiuseppe-trisciuoglio/developer-kit ↗

When should an agent use typescript-docs and what problem does it solve?

Generates comprehensive TypeScript documentation using JSDoc, TypeDoc, and multi-layered documentation patterns for different audiences. Use when creating API documentation, architectural decision rec

Who is it for?

Developers invoking typescript-docs as documented in the skill source.

Skip if: Skip when requirements fall outside typescript-docs documented scope.

When should I use this skill?

Generates comprehensive TypeScript documentation using JSDoc, TypeDoc, and multi-layered documentation patterns for different audiences. Use when creating API documentation, architectural decision rec

What you get

Outputs aligned with the typescript-docs SKILL.md workflow and stated deliverables.

  • API reference pages
  • ADR markdown
  • JSDoc-annotated source

By the numbers

  • Covers 5 frameworks: NestJS, Express, React, Angular, and Vue

Files

SKILL.mdMarkdownGitHub ↗

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

ToolPurposeCommand
TypeDocAPI documentation generationnpx typedoc
CompodocAngular documentationnpx compodoc -p tsconfig.json
ESLint JSDocDocumentation validationeslint --ext .ts src/

JSDoc Tags

TagUse Case
@paramDocument parameters
@returnsDocument return values
@throwsDocument error conditions
@exampleProvide code examples
@remarksAdd implementation notes
@seeCross-reference related items
@deprecatedMark deprecated APIs

Instructions

1. Configure TypeDoc

npm install --save-dev typedoc typedoc-plugin-markdown
{
  "entryPoints": ["src/index.ts"],
  "out": "docs/api",
  "theme": "markdown",
  "excludePrivate": true,
  "readme": "README.md"
}

2. Add JSDoc Comments

/**
 * Service for managing user authentication
 *
 * @remarks
 * Handles JWT-based authentication with bcrypt password hashing.
 *
 * @example
 * ```typescript
 * const authService = new AuthService(config);
 * const token = await authService.login(email, password);
 * ```
 *
 * @security
 * - Passwords hashed with bcrypt (cost factor 12)
 * - JWT tokens signed with RS256
 */
@Injectable()
export class AuthService {
  /**
   * Authenticates a user and returns access tokens
   * @param credentials - User login credentials
   * @returns Authentication result with tokens
   * @throws {InvalidCredentialsError} If credentials are invalid
   */
  async login(credentials: LoginCredentials): Promise<AuthResult> {
    // Implementation
  }
}

3. Create an ADR

# ADR-001: TypeScript Strict Mode Configuration

## Status
Accepted

## Context
What is the issue motivating this decision?

## Decision
What change are we proposing?

## Consequences
What becomes easier or more difficult?

4. Set Up CI/CD Pipeline

name: Documentation
on:
  push:
    branches: [main]
    paths: ['src/**', 'docs/**']

jobs:
  generate-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'
      - run: npm ci
      - run: npm run docs:generate
      - run: npm run docs:validate

5. Validate Documentation

{
  "rules": {
    "jsdoc/require-description": "error",
    "jsdoc/require-param-description": "error",
    "jsdoc/require-returns-description": "error",
    "jsdoc/require-example": "warn"
  }
}

If validation fails: review ESLint errors, fix JSDoc comments (add missing descriptions, add @param/@returns/@throws where absent), re-run eslint --ext .ts src/ until all errors pass before committing.

Examples

Documenting a React Hook

/**
 * Custom hook for fetching paginated data
 *
 * @remarks
 * This hook manages loading states, error handling, and automatic
 * refetching when the page or filter changes.
 *
 * @example
 * ```tsx
 * function UserList() {
 *   const { data, isLoading, error } = usePaginatedData('/api/users', {
 *     page: currentPage,
 *     limit: 10
 *   });
 *
 *   if (isLoading) return <Spinner />;
 *   if (error) return <ErrorMessage error={error} />;
 *   return <UserTable users={data.items} />;
 * }
 * ```
 *
 * @param endpoint - API endpoint to fetch from
 * @param options - Pagination and filter options
 * @returns Paginated response with items and metadata
 */
export function usePaginatedData<T>(
  endpoint: string,
  options: PaginationOptions
): UsePaginatedDataResult<T> {
  // Implementation
}

Documenting a Utility Function

/**
 * Validates email addresses using RFC 5322 specification
 *
 * @param email - Email address to validate
 * @returns True if email format is valid
 *
 * @example
 * ```typescript
 * isValidEmail('user@example.com'); // true
 * isValidEmail('invalid-email');      // false
 * ```
 *
 * @performance
 * O(n) where n is the email string length
 *
 * @see {@link https://tools.ietf.org/html/rfc5322} RFC 5322 Specification
 */
export function isValidEmail(email: string): boolean {
  const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
  return emailRegex.test(email);
}

NestJS Controller Documentation

/**
 * REST API endpoints for user management
 *
 * @remarks
 * All endpoints require authentication via Bearer token.
 * Rate limiting: 100 requests per minute per user.
 *
 * @example
 * ```bash
 * curl -H "Authorization: Bearer <token>" https://api.example.com/users/123
 * ```
 *
 * @security
 * - All endpoints use HTTPS
 * - JWT tokens expire after 1 hour
 * - Sensitive data is redacted from logs
 */
@Controller('users')
export class UsersController {
  /**
   * Retrieves a user by ID
   * @param id - User UUID
   * @returns User profile (password excluded)
   */
  @Get(':id')
  async getUser(@Param('id') id: string): Promise<UserProfile> {
    // Implementation
  }
}

Best Practices

1. Document Public APIs: All public methods, classes, and interfaces 2. Use `@example`: Provide runnable examples for complex functions 3. Include `@throws`: Document all possible errors 4. Add `@see`: Cross-reference related functions/types 5. Use `@remarks`: Add implementation details and notes 6. Document Generics: Explain generic constraints and usage 7. Include Performance Notes: Document time/space complexity 8. Add Security Warnings: Highlight security considerations 9. Keep Updated: Update docs when code changes 10. Don't document obvious code: Focus on why, not what

Constraints and Warnings

  • Private Members: Use @private or exclude from TypeDoc output
  • Complex Types: Document generic constraints and type parameters
  • Breaking Changes: Use @deprecated with migration guidance
  • Security Info: Never include secrets or credentials in documentation
  • Link Validity: Ensure @see references point to valid locations
  • Example Code: All examples should be runnable and tested
  • Versioning: Keep documentation in sync with code versions

References

  • [references/jsdoc-patterns.md](references/jsdoc-patterns.md) — JSDoc patterns for interfaces, functions, classes, generics, and unions
  • [references/framework-patterns.md](references/framework-patterns.md) — Framework-specific patterns for NestJS, React, Express, and Angular
  • [references/adr-patterns.md](references/adr-patterns.md) — ADR templates and examples
  • [references/pipeline-setup.md](references/pipeline-setup.md) — CI/CD pipeline configuration for documentation
  • [references/validation.md](references/validation.md) — ESLint rules and validation checklists
  • [references/typedoc-configuration.md](references/typedoc-configuration.md) — Complete TypeDoc configuration options
  • [references/examples.md](references/examples.md) — Additional code examples

Related skills

mattpocockSetup Matt Pocock SkillsScaffold the per-repo configuration that Matt Pocock’s engineering agent skills rely on so they understand the issue tracker, triage labels, and domain documentation la462k185klarksuiteLark Skill MakerQuickly turn any Lark/Feishu OpenAPI call or multi-step workflow into a reusable agent skill with its own SKILL.md.379k15.8kjuliusbrusseeCavemanSlash token usage by roughly 75% while keeping every technical detail intact when working with Claude Code, Cursor or similar agents.378k92.5kopen.feishu.cnLark AppsConnect Claude, Cursor or custom agents directly to Lark (Feishu) for messaging, document automation, approval workflows and enterprise data access.375kxixu-meRunning Claude Code Via Litellm CopilotRun Claude Code at a fraction of the cost by routing requests through LiteLLM to the GitHub Copilot Chat API.270k72runcomfy-comCodex PetGenerate a complete Codex Pet spritesheet and metadata from one reference image without needing an OpenAI key or Codex Pro.246k8

Forks & variants (1)

Typescript Docs has 1 known copy in the catalog totaling 26 installs. They canonicalize to this original listing.

How it compares

Pick typescript-docs when you need layered TypeScript docs with ADRs and framework examples; use OpenAPI generators for HTTP contract specs alone.

FAQ

What is typescript-docs?

Generates comprehensive TypeScript documentation using JSDoc, TypeDoc, and multi-layered documentation patterns for different audiences. Use when creating API documentation, archit

When should I use typescript-docs?

Generates comprehensive TypeScript documentation using JSDoc, TypeDoc, and multi-layered documentation patterns for different audiences. Use when creating API documentation, archit

Is typescript-docs safe to install?

Review the Security Audits panel on this page before production use.

AI & Agent Buildingagents
Browse by category
AI & AgentsFrontend & DesignBackend & DataDev ToolsAutomationTesting & ReviewSecurityMonitoring & CloudDocs & Planning
Design & frontend
Design systemsAnimation & motionAccessibility (a11y)CSS & TailwindUI designUXDesign to codeshadcn/uiLanding pagesBest design skills
Most searched skills
find-skillscavemanfrontend-designbrainstormingsystematic-debuggingstop-slopemil-design-engui-ux-pro-maxkarpathy-guidelinesweb-design-guidelinesreact-best-practicesgrill-meimprovemicrosoft-foundryagent-browser
Browse all listings
All agent skillsAll MCP serversAll marketplacesAll plugins

This week in AI coding

Five minutes, every Monday - the tools, releases and tactics for developers.

unsubscribe anytime.