Documentando

aprendemos sobre a importância de documentar os componentes do nosso guia de estilo. Vimos que a documentação pode ser simples ou complexa, mas o importante é que ela seja clara e concisa.

A documentação deve conter informações sobre o componente, como sua função, exemplos de uso e estados de interação.

Também aprendemos que a documentação pode ser feita dentro da ferramenta de prototipagem, utilizando textos, imagens e exemplos.

O guia de estilo é como esse manual para o seu produto digital. Ele define como cada componente deve ser usado e como ele se comporta.

A documentação é como um guia detalhado para cada peça da casa. Ela explica para que serve cada peça, como ela funciona e como ela se conecta com as outras peças.

Por exemplo, o botão é como uma porta da sua casa. Você precisa saber como ela abre, como ela fecha e em quais situações ela pode ser usada.

A documentação do botão vai explicar tudo isso:

Assim como você precisa de um manual para construir uma casa, os designers e desenvolvedores precisam de um guia de estilo para construir um produto digital.

E a documentação é como um guia detalhado para cada componente do produto, garantindo que todos estejam usando os componentes da mesma forma e que o produto seja consistente.

image.png

<aside> <img src="/icons/arrow-turn-right_yellow.svg" alt="/icons/arrow-turn-right_yellow.svg" width="40px" />

Apesar de estarmos fazendo a documentação na própria ferramenta na qual estamos prototipando, existem outras plataformas online que permitem realizar essa construção, como é o caso do zeroheight, uma plataforma 100% voltada para a documentação de guias de estilo, como também o Notion, que viemos usando ao longo da formação.

</aside>

A melhor forma para se entender a parte de documentação, que por tabela já demonstra a forma de se utilizar para construir um produto em alta fidelidade, é indo a campo buscar e ler na prática, por isso, deixei abaixo uma lista com as melhores documentações para entender tanto a visão de design quanto de programação, mas com uma linguagem mais tranquila:

APRENDIZADOS CURSO