IntermediárioDesign SystemAberto

Documentacao de design system no Storybook com exemplos vivos

Estrutura de documentacao interativa no Storybook que serve como referencia unificada para designers e desenvolvedores.

Storybookdocumentacaocomponentesexemplosreferencia

Objetivo do Prompt

Criar uma documentacao de design system no Storybook que seja a referencia unica para toda a organizacao, com exemplos interativos, guidelines de uso e playground para experimentacao.

Exemplo Real de Uso

A TechGestao, empresa de software de gestao de Sao Paulo com 1.500 desenvolvedores, adotou Storybook mas tem apenas 20% dos componentes documentados. Querem um padrao de documentacao que escale para 300+ componentes e que devs consigam usar sem precisar perguntar no Slack.

Prompt

Crie o padrao de documentacao do design system [NOME DO DS] no Storybook, para [NUMERO] componentes utilizados por [NUMERO] desenvolvedores e [NUMERO] designers.

Stack: [REACT/VUE/ANGULAR] + [STORYBOOK VERSAO]. Deploy: [URL DO STORYBOOK].

**1) Estrutura de Navegacao do Storybook:**
- Sidebar hierarchy:
  - Getting Started (instalacao, configuracao, contribuicao)
  - Foundations (cores, tipografia, espacamento, icones, motion)
  - Components (organizados por [CATEGORIZACAO])
  - Patterns (composicoes de componentes)
  - Templates (layouts de pagina completos)
  - Changelog

**2) Template de Documentacao por Componente:**
Cada componente DEVE ter:

a) **Overview** (MDX page):
- Descricao em 1-2 frases
- Import statement
- Exemplo basico funcional
- Tabela de props com tipos, defaults e descricao

b) **Variants**:
- Story para cada variante (size, color, state)
- Controls interativos (knobs) para experimentacao
- Side-by-side comparison de variantes

c) **Usage Guidelines** (MDX):
- Quando usar este componente
- Quando NAO usar (e qual alternativa)
- Do's and Don'ts com screenshots
- Composicao com outros componentes

d) **Accessibility**:
- ARIA attributes necessarios
- Keyboard navigation
- Screen reader behavior
- Teste com axe DevTools (badge de status)

e) **Design Specs**:
- Link para Figma component
- Tokens utilizados
- Anatomia do componente
- Responsive behavior

**3) Addons Essenciais:**
- @storybook/addon-a11y (testes de acessibilidade)
- @storybook/addon-viewport (responsividade)
- @storybook/addon-docs (documentacao MDX)
- storybook-dark-mode (preview em dark mode)
- @storybook/addon-interactions (testes visuais)
- Chromatic (visual regression testing)

**4) Automacao:**
- Auto-generate de stories a partir de props (TypeScript)
- CI pipeline: build + deploy + visual regression
- Slack notification quando componente e atualizado
- Metrics: tracking de page views por componente

**5) Adocao:**
- Onboarding para novos devs (tutorial de 30 min)
- Checklist de PR: "componente documentado no Storybook?"
- Monthly newsletter com novos componentes
- Design system office hours (1h/semana)

Escreva o exemplo completo para o componente [COMPONENTE EXEMPLO: Button], incluindo codigo MDX e stories.

Como usar este prompt

  1. 1Cole o prompt diretamente no ChatGPT, Claude, Gemini ou qualquer assistente de IA.
  2. 2Personalize os campos entre colchetes [assim] com suas informações específicas.
  3. 3Para melhores resultados, forneça contexto adicional sobre seu caso de uso.
  4. 4Combine múltiplos prompts em uma conversa para resultados mais completos.
  5. 5Salve os prompts que mais usa para acesso rápido no futuro.

Prompts relacionados

Ver todos

Explore outras categorias de prompts

Assine o AulasDeIA para desbloquear

Acesse 10.000+ prompts prontos para usar em qualquer profissão, além de todos os cursos da plataforma.

Assinar por R$ 49,90/mês

Cancele quando quiser. Sem multas.