Transformando conhecimento em comunicação

Sempre que começo em uma nova empresa, espero encontrar documentações sobre os processos rotineiros. Quando não as encontro, sinto uma enorme insatisfação.

Uma habilidade essencial que muitos profissionais de tecnologia carecem é a capacidade de se expressar de forma assertiva no dia a dia. Acredito que criar o hábito de documentar os procedimentos certamente contribui para o desenvolvimento dessa habilidade, além de disseminar o conhecimento entre todas as partes interessadas.

Desde a infância, meus familiares sempre ressaltaram o quanto eu adorava conversar sem parar e questionar o motivo por trás de tudo. Antes de ingressar na área de tecnologia, meu sonho era ser jornalista. Então, acredito que a comunicação foi — e continua sendo — um traço marcante da minha personalidade.

Como escrever boas documentações?

Richard Feynman, um físico norte-americano, desenvolveu a técnica conhecida como Método Feynman. Ela consiste em aprender ensinando. Ao ensinar, você aprende; ao escrever, aprimora sua comunicação.

📚 Amplie seu repertório

Cultive o hábito da leitura de conteúdos não técnicos. Seja um livro, um artigo ou uma revista, o ato de ler enriquece seu vocabulário e consequentemente lhe apresenta diferentes recursos para se expressar.

👤 Utilize a terceira pessoa

Escrever sobre um tema referindo-se aos "de fora" traz uma visão mais próxima da perspectiva do leitor. Evite a suposição de que os leitores detêm a mesma linha de raciocínio que você.

🔁 Varie seu vocabulário

Evite repetições na mesma frase que podem tornar a leitura cansativa e confusa. Recorra a recursos como o site sinonimos.com.br para encontrar sinônimos que transmitam o mesmo significado. A diversidade de palavras torna o texto mais agradável e evita monotonia.

📐 Estrutura clara

Modele suas documentações como receitas culinárias: comece com os ingredientes, explique o modo de preparo e finalize com sugestões para servir. Sua documentação deve ter começo, meio e fim.

🧠 Mantenha a linha de raciocínio

Não pule informações. Detalhe o porquê, quando e como executar um procedimento.

🖼️ Ilustre com exemplos

Utilize ilustrações como mapas mentais, esquemas de arquitetura, capturas de tela de mensagens de erro ou trechos de código. Esses recursos beneficiam as pessoas que aprendem visualmente.

💬 Colha feedback

Peça opiniões e observe as dúvidas que surgem enquanto outros leem seu texto. A percepção externa é valiosa para melhorar a clareza.

🔄 Revisão contínua

A área de tecnologia é efêmera, e os processos estão sempre em evolução. Revisar e atualizar suas documentações regularmente garante que elas se mantenham relevantes e precisas.

✍️ Padronização

Estabeleça um formato para suas documentações. Assim como uma redação exige introdução, desenvolvimento e conclusão, uma estrutura padronizada ajuda a manter a consistência e a qualidade.

🗣️ Comunique-se

Somente a prática elucida áreas de melhoria na nossa comunicação — direta ou indireta, como numa documentação. Comunicação clara é sinônimo de relacionamentos consistentes e caminhos abertos.