Escreva a documentação de um sistema de design e mantenha-a atualizada
Use para documentar o sistema de design da sua equipe. Define o que cobrir, divide o trabalho em páginas por prioridade, explica cada componente com o quê, por quê, quando e como, e antes de publicar verifica se documentação, design e código coincidem.
Para usar estas regras de IA
## Decida o que a documentação cobre, dos princípios aos componentes
Documente tanto os fundamentos intangíveis do sistema — princípios, decisões e formas de trabalhar — quanto seus recursos tangíveis: padrões, componentes, regras de uso e ferramentas de implementação. Torne o escopo visível antes de escrever, para que as lacunas se transformem em itens de trabalho pendentes, em vez de surpresas.
## Divida a documentação em páginas e comece pelo que mais atrapalha
Divida o trabalho em páginas autossuficientes. Priorize as áreas que causam mais atrito e, em seguida, os componentes usados com frequência ou que concentram muitas dependências. Acompanhe o progresso e reveja as prioridades à medida que as restrições mudarem. Use qualquer ferramenta que a equipe consiga manter, pesquisar e compartilhar de forma confiável.
## Explique cada componente respondendo a quatro perguntas
Para cada componente, responda a quatro perguntas: O que é, incluindo seus estados e opções? Por que escolhê-lo em vez de alternativas semelhantes? Quando seu contexto o torna adequado? Como deve ser usado, incluindo variações compatíveis, exemplos e orientações explícitas sobre o que fazer e o que não fazer?
## Escreva primeiro para designers e desenvolvedores, e resuma para os demais
Atenda primeiro às necessidades de designers e desenvolvedores, oferecendo comportamento claro, critérios de decisão, referências de implementação e links para código ou histórias de componentes. Dê às funções de produto, controle de qualidade e pesquisa um caminho de verificação mais curto. Reutilize bons padrões de outros sistemas, mas adapte-os; o acesso funcional é mais importante do que a perfeição visual.
## Antes de publicar, verifique se documentação, design e código coincidem
Trate a documentação como um produto vivo. Analise novos componentes e orientações nas revisões de design, avalie as necessidades de documentação no início do projeto, teste os componentes com usuários e verificações de acessibilidade e confirme o alinhamento entre design, código e documentação antes do lançamento. Mude os rituais de manutenção quando as evidências mostrarem que eles não funcionam.