Template do componente de design
por Tony Starr, Líder de Design de Conteúdo @ Atlassian
Crie uma biblioteca de componentes de design documentados com cuidado

Monitorar todos os componentes que a equipe usa nos designs pode ser complicado, ainda mais quando a equipe está crescendo. O template do componente de design ajuda a documentar cada um, desde os princípios básicos, como o que o componente faz e como ele funciona, até como ele se parece e age em contextos diferentes. Existe até uma seção para orientação adicional, em que você pode explicar regras específicas do componente, acessibilidade, mobilidade, etc. Crie uma biblioteca inteira de componentes do zero!
Como usar o template Componente de design
Passo 1. Comece pelo básico
Antes de entrar no aspecto mais importante das especificações de um componente, você precisa saber os princípios básicos. Comece preenchendo as linhas em Noções básicas do componente: dê um nome ao componente, descreva o que ele faz e carregue um diagrama de anatomia com indicadores numerados. Use estes indicadores para criar uma chave e defina cada elemento da anatomia do componente. O objetivo desta seção é explicar às pessoas que usam o componente como tudo se encaixa nele.
Etapa 2. Descreva as especificações
É aqui que você começa a descrever as diferentes formas de usar um componente como parte dos designs para um recurso maior. Descreva como o componente é usado, incluindo o objetivo geral no design, e como ele se parece e age em contextos diferentes. Use o código ao vivo do repositório do sistema de design para exibir variações diferentes. Por último, descreva o estilo visual do componente. Inclua exemplos do que fazer e do que não fazer.
Etapa 3. Documente dicas, truques e práticas recomendadas
Todo componente tem peculiaridades. Em Orientação adicional, digite quais são elas. Comece com o conteúdo: existem regras de pontuação específicas deste componente? E as categorias padrão? Anote tudo, junto com as dicas ou dúvidas sobre a acessibilidade específica do componente para aplicação em ambientes móveis. Se existirem práticas recomendadas padrão do setor de como o componente é usado, também faça uma lista delas. Por último, adicione links aos componentes e padrões relacionados.
Tony Starr
Líder de Design de Conteúdo @ Atlassian
Tony é Líder de Design de Conteúdo na Atlassian. É redator de conteúdo e técnico multidisciplinar que ama estabelecer padrões e superar as fronteiras de onde a diretriz de conteúdo pode ficar.
Coleções com esse template
Mais Design templates Exibir todos
-
Atlassian
Content design glossary
Teach writers how to use product names, industry terms, and other content with an A-Z guide.
-
Atlassian
Relatório de entrevista com o cliente
Transforme as entrevistas com o cliente em dados com o último relatório de entrevista com o cliente.
-
Atlassian
Design decision
Use our design decision template to review design options, present design examples, and log design decisions.