📖

Component Documentation

Verified

by Community

Creates thorough component documentation including usage guidelines, props/variants, do's and don'ts, accessibility notes, and code examples. Ensures design system components are used correctly across teams.

documentationcomponentsdesign-systemguidelines

Component Documentation

Document UI components thoroughly for consistent usage across teams.

Usage

Describe a component to get comprehensive documentation.

Examples

  • "Document a button component with all variants"
  • "Create usage guidelines for our modal dialog component"
  • "Write do's and don'ts for our card component"

Guidelines

  • Include a clear description of the component's purpose
  • Document all props, variants, and states
  • Provide visual examples of correct and incorrect usage
  • Include accessibility requirements and ARIA patterns
  • Add code snippets for common implementation patterns