Dicas para melhorar a sua documentação

A documentação da sua organização é tão eficaz quanto gostaria que fosse? Você tem muito tempo para treinar sua equipe em habilidades de documentação eficazes? Provavelmente não. Então, aqui estão algumas dicas simples e rápidas para ajudá-lo e sua equipe a melhorar sua documentação imediatamente.

A voz passiva é uma praga na documentação eficaz. Reduz sua clareza, sua consistência, e a eficiência e aperto da escrita. A voz passiva é escrita em que o assunto da frase denota o destinatário da ação em vez do performer. Por exemplo, “o servidor foi instalado” representa a voz passiva enquanto “o técnico instalado o servidor” representa a voz ativa. A voz passiva é mais comum na maioria dos documentos, porque é uma forma mais fácil e desleixada de escrever.

Escrever na voz passiva é altamente prejudicial para a documentação, especialmente para a documentação relacionada ao processo, onde é essencial entender quais pessoas ou sistemas estão executando as ações. A boa notícia é que esta é uma solução fácil. Sob a sua função gramatical em palavra, você pode clicar na opção “frases passivas” e a palavra irá verificar automaticamente para você frases passivas.

Para melhorar a sua documentação imediatamente: Use a função de verificação de gramática de voz passiva em Word para rever a sua documentação e mudar frases passivas em frases mais claras e mais nítidas.

Você pode não ser um artista gráfico, mas você pode melhorar sua documentação rapidamente através do uso de visuais simples. Aproveite as muitas formas enlatadas e arte inteligente em palavra para adicionar um pouco de “punch” para a sua documentação para envolver melhor o seu público.

Aproveite as muitas maneiras que este programa oferece para desenhar diagramas simples que reduzem a sua necessidade de texto extenso e que melhoram suas chances de engajamento das partes interessadas. Um diagrama que é particularmente útil é o diagrama da pista de natação que ilustra os atores e suas ações. Sem ser um especialista em processos, você vai se surpreender com a forma como a simples pista de Natação vai melhorar a clareza nos papéis, responsabilidades e processos para sua equipe e sua organização em geral.

Lembre-se, seu público geralmente quer exercer o mínimo de energia possível ao ler seu trabalho. Eles apenas “desviam” o seu documento à procura dos pontos principais. Por isso, facilita-lhes as coisas! Cabeçalhos e balas, muitas vezes combinados com visuais eficazes, são tão importantes quanto o texto. Para alguns leitores, cabeçalhos e balas são tudo o que eles vão ler. Seu leitor pode até mesmo tomar uma decisão sobre o seu trabalho apenas lendo o índice. Então, ao avaliar a sua documentação, é útil se toda a essência do seu trabalho é comunicada apenas pelos cabeçalhos e balas. O leitor entende o que você está tentando dizer? Se eles podem entender a maioria do que você está dizendo apenas lendo os cabeçalhos, então você fez um bom trabalho.

Talvez não haja nada mais irritante quando se trata de documentação do que entrar em um projeto ou em uma nova organização e ser incapaz de entender um único parágrafo no documento, porque ele é tão cheio de acrônimos e palavras buzz. Os acrônimos e as palavras buzz não, deixem-me repetir, fazem-vos parecer mais inteligentes. Na maioria dos casos, eles realmente irritam o seu leitor, impedindo a sua capacidade de entender as suas mensagens-chave.

Evite usar acrônimos excessivos e palavras buzz sempre que possível. Ou, pelo menos, defini-los antecipadamente. Em muitos casos, você deve definir acrônimos e palavras frequentemente usadas em um glossário bem pensado no início de seus documentos ou como parte de sua biblioteca de documentação.

Fonte: https://dnibrasil.com/