Transformando conhecimento em comunicação: A importância de documentar
Published: 2023-08-21 16:03:32

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 contribuirá para o desenvolvimento dessa habilidade, além de disseminar o conhecimento entre todas as partes interessadas.

Desde a minha 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.
 
Vamos ao que interessa: como escrever boas documentações, segundo a minha percepção?

_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. Uma receita começa com os ingredientes, explica o modo de preparo e finaliza com sugestões para servir. Sua documentação deve possuir começo, meio e fim.

**Matenha 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 através do visual.

**Colha feedback:** 
Peça opiniões e observe as dúvidas que surgem enquanto outros leem seu texto.

**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 em um exame de vestibular exige introdução, desenvolvimento e conclusão, um estilo padronizado ajuda a manter a qualidade do que você escreve.

**Comunique-se:**
Somente a prática elucida áreas de melhoria na maneira que nos comunicamos, diretamente ou indiretamente, como por exemplo uma documentação. 

Comunicação clara é sinômino de relacionamentos consistentes e caminhos abertos.