Construindo uma base: Definindo regras e manuais na documentação do Design System

Documentei as regras e manuais dos componentes do Design System numa página online, criando uma referência única entre design e desenvolvimento.

---

---

Após estabelecer as regras de criação e documentação desses componentes, esse projeto teve como objetivo definir a documentação das regras e manuais dos componentes na página online do Design System.

O principal público-alvo deste projeto incluiu o time de Product Design e os times de desenvolvimento, garantindo uma comunicação eficiente entre ambas as áreas.

Minhas responsabilidades foram direcionadas pelo meu interesse significativo e habilidades destacadas na criação e organização de regras e guias no Design System.

Enfrentei o desafio de identificar todas as informações essenciais para a documentação de manuais de componentes, considerando as peculiaridades de cada componente.

Realizei benchmarks em vários Design Systems, optando pela estrutura do Material Design 3 como base. Durante o processo, enfrentei o desafio de garantir que as informações fossem acompanhadas por imagens ilustrativas atualizadas, integrando o processo com nosso arquivo de componentes no Figma.

Enfrentamos problemas de desempenho com a plataforma de documentação online, resultando na decisão de migrar para o Notion como medida preventiva.

As soluções finais envolveram a criação de imagens ilustrativas no Figma, detalhando inspeções de elementos, e a documentação das regras na página online do Design System, seguindo uma estrutura modelada.

A estrutura final da documentação inclui uma visão geral do componente, especificações detalhadas de cada parte, e um manual de uso abrangente, abordando comportamentos em diferentes situações.

Os resultados obtidos proporcionam clareza e centralização dentro do time de design, prevenindo falhas de aplicação ao longo do tempo. Além disso, a documentação oferece visibilidade sobre o comportamento dos componentes no código, eliminando a necessidade constante de supervisão por parte dos designers. Este projeto visa aprimorar a eficiência e colaboração no desenvolvimento, promovendo uma compreensão abrangente e consistente dos componentes no Design System.