[PT-BR] Mostre-me um projeto sem documentação e eu te mostrarei o caos 😅

Bruno Rigolino on

Por outro lado, documentar todas as decisões em relatórios gigantes, escritos de forma impessoal e burocrática podem tornar a informação pouco útil ou difícil de consumir.

No último mês, minha principal ferramenta de design tem sido a escrita e os meus principais artefatos têm sido relatórios e artigos.

Por isso, decidi compartilhar 3 práticas que me ajudam na hora de documentar projetos e produtos:

1️⃣ Seja designer na hora de escrever:

Considere a “experiência do usuário” da documentação. Imagine ao escrever um relatório, por exemplo, que ele fosse uma landing page e pergunte-se: a pessoa lendo isso vai clicar no CTA (Call to Action)?

2️⃣ Escreva um glossário:

Ao usar um termo técnico ou uma sigla –por mais comum e integrada que ela esteja em sua cultura organizacional– é melhor escrever uma definição curta para garantir uma interpretação compartilhada e facilitar a leitura de uma pessoa recém-chegada.

3️⃣ Use títulos criativos:

Chamar o relatório de “Projeto X: relatório 2” além de entregar pouca informação, não me incentiva a ler. Tente algo como “Projeto X – A semana da entrega surpresa: relatório do período entre 13/06 e 17/06”.

E aí, quais técnicas você usa pra criar relatórios e documentação úteis?


PS: esse é o primeiro texto de 4 que vou escrever e publicar no Linkedin no contexto do #clubedaescritacc. Uma iniciativa da Clara Cecchini.