documentation

Document TypeScript/React projects with TSDoc, Storybook, VitePress, and TypeDoc.

Updated Dec 19, 2025
One-click install
npx skills add https://github.com/CrazySwami/cross-platform-web-app-research --skill documentation-crazyswami
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/CrazySwami/cross-platform-web-app-research/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/CrazySwami/cross-platform-web-app-research --skill documentation-crazyswami

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you document TypeScript/React projects using TSDoc, Storybook, VitePress, and TypeDoc, ensuring maintainable APIs and clearer collaboration.

Core Features & Use Cases

  • TSDoc & JSDoc Comments: Add and standardize inline exports with proper documentation.
  • Storybook Stories: Create and maintain Storybook stories to validate visual components.
  • API Documentation: Generate API docs from TypeScript using TypeDoc.
  • Use Case: On a new component release, automatically generate API docs and Storybook stories so developers understand usage and props.

Quick Start

Add or update documentation for your codebase. Generate API docs with TypeDoc and start the docs site by running the relevant commands (e.g., pnpm docs:api, pnpm docs:dev).