component-docs

Generate JSDoc comments and Storybook stories for React TypeScript components.

Updated Jan 17, 2026
One-click install
npx skills add https://github.com/saddam-eng-tech/ai-agent-skills --skill component-docs-saddam-eng-tech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: component-docs
Source: https://github.com/saddam-eng-tech/ai-agent-skills/tree/main/component-docs
Command: npx skills add https://github.com/saddam-eng-tech/ai-agent-skills --skill component-docs-saddam-eng-tech

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of essential documentation for React TypeScript components, including JSDoc comments and Storybook stories files, saving developers significant time and ensuring consistency.

Core Features & Use Cases

  • JSDoc Generation: Automatically adds detailed JSDoc comments for component props, functions, and exported members.
  • Storybook Story Creation: Generates a complete .stories.tsx file with argTypes for every prop and multiple story variants.
  • Use Case: When you've finished building a new React component, use this Skill to instantly generate its documentation and a Storybook file, making it ready for review and integration.

Quick Start

Write documentation for the attached React component file.

Frequently Asked Questions about component-docs

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

FAQPage Schema
How do I generate JSDoc comments for React TypeScript components?

To generate JSDoc comments for React TypeScript components, you can use a Skill that analyzes component props interfaces and rendering logic to automatically add detailed documentation for props, functions, and exported members. This automates the creation of essential component documentation.

Can I automatically create Storybook stories from a React component file?

Yes, you can automatically create Storybook stories from a React component file by analyzing its TypeScript props interfaces and behavior. This process generates a complete `.stories.tsx` file with multiple story variants and interactive argTypes for every component prop.

How do I map TypeScript types to Storybook controls automatically?

You can map TypeScript types to Storybook controls automatically by analyzing component props interfaces during story generation. This process maps each TypeScript type to its corresponding Storybook control, producing accurate argTypes and detailed explanations for complex component arguments.

What is the best way to document React component props and behavior?

The best way to document React component props and behavior is to automate JSDoc generation and Storybook story creation. This approach analyzes component rendering logic and props interfaces to produce comprehensive documentation files and interactive story examples simultaneously.

Does this documentation approach work without external dependencies?

Yes, this documentation approach works without external dependencies. The Skill operates independently to analyze React TypeScript components and generate both JSDoc comments and Storybook stories, requiring no additional libraries or setup tools to produce the documentation outputs.