Clique aqui para acessar a checklist de documentação clara.

 

Informação clara, é uma informação que os usuários conseguem entender na primeira vez que leem.

Esta clareza requer atenção a elementos como palavras, frases, sentenças, listas e tabelas, a fim de ter certeza de que cada um deles tem um papel apropriado na mensagem a ser passada.

Para tornar uma informação clara, siga estas orientações:

1. Foque no significado

Informações claras requerem que você mantenha o foco no que você quer falar: O que você quer que os usuários façam ou saibam?

Quando a maioria das pessoas escrevem, precisam se "aquecer" (elas precisam escrever um pouco antes das palavras "fluírem"). Na primeira passagem, podem produzir sentenças longas, palavras imprecisas ou desnecessárias.

Após escrever, releia, pelo menos uma vez o que escreveu e preste atenção em palavras imprecisas e desnecessárias, para removê-las e em frases longas para resumi-las, tornando o texto mais objetivo e com foco.

2. Evite ambiguidade

Palavras que possuem mais de um significado podem ser confusas quando estes significados se encaixam no contexto. Para evitar ambiguidade siga estas dicas:

  • Utilize palavras com um significado claro.

  • Evite referências vagas.

  • Coloque pontuação corretamente.

  • Evite longas sequências de substantivos.

  • Escreva positivamente.

3. Mantenha elementos curtos

Mantenha os seus elementos curtos, porque ajudam o usuário a escanear e ler a informação, e, em geral, as pessoas pulam parágrafos longos.

Remova expressões redundantes e repetições desnecessárias, selecione palavras diretas ao invés de expressões, e mantenha as listas curtas.

4. Escreva de forma coesa 

Deixe claro o fluxo lógico de um elemento para outro, principalmente quando combinar elementos diferentes, como tabelas, listas e figuras. Para integrá-los ao texto, utilize sentenças de introdução e utilize títulos significativos para tabelas e imagens.

5. Apresente a informação similar de forma similar

Uma forma de facilitadas o entendimento da leitura pela primeira vez é apresentar elementos similares da mesma forma.

Algumas formas de apresentar informações de forma similar são:

  • Se você coloca borda em imagens, coloque em todas.
  • Se você descreve procedimentos através de exemplos, explique todos da mesma forma.
  • Utilize listas de forma apropriada.
  • Segmente informações em tabelas.

6. Utilize termos técnicos somente se forem necessários e apropriados

Sempre que possível evite a utilização de termos especializados ou crie novos termos, exceto quando for auxiliar o usuário.

Considere os critérios abaixo para avaliar se é necessário utilizar um termo técnico:

  • Já existe algum termo apropriado para o que está nomeando? Se é um termo aceito e muito utilizado, utilize o termo existente ao invés de colocar um novo.
  • Você tem intenção de utilizar o termo apenas uma ou duas vezes? Então utilize fases descritivas ao invés do termo.

Caso mesmo assim, utilize o termo ou crie um novo termo, você deve utilizá-lo de forma consistente.

7. Defina cada termo que é novo para o público alvo

Sempre que for necessário utilizar um termo que possa ser novo aos usuários, ou que não esteja diretamente ligado ao contexto da ideia a ser passada é necessário introduzir este termo, dando uma breve explicação sobre seu significado.

Para facilitar o usuário na identificação de novos termos destaque-os e utilize links direcionando o usuário para o significado dos mesmos.