Forneça informações livre de erros. Se tivéssemos que escolher a característica mais importante de uma boa documentação, é a corretude do seu conteúdo. O usuário precisa confiar nas informações do documento. Nada abala a confiança tão rápido quanto o leitor descobrir que que uma peça crucial da informação está errada.

Os usuários dependem da acurácia da informação fornecida para executar suas tarefas, entender o produto e estão gastando tempo e dinheiro com isso.

Todos os elementos de uma documentação técnica devem atender essa característica: informação conceitual, declarações dos fatos, os procedimentos, os elementos gráficos e qualquer outro elemento.

Independentemente de quanto tempo os usuários levam para detectar uma imprecisão, a sua confiança na informação é abalada quando a encontram, eles podem até optar por não usar mais as informações ou o produto como um todo.

Para tornar a informação precisa, siga estas orientações:

1. Escreva as informações apenas quando você entendê-las e depois confirme se estão corretas.

Utilize o produto na prática e entenda-o como se você desenvolver o produto ou testá-lo.

2. Mantenha a documentação atualizada com as alterações técnicas.

Documentações desatualizadas são imprecisas. Quando uma funcionalidade for alterada, atualize a documentação.

Evite colocar datas, números de versões de produtos, imagens (caso a interface mude precisa atualizá-la) e sempre priorize atualizar os documentos existentes à criar novos.

3. Mantenha a consistência de todas as informações sobre um assunto.

Muitos problemas de acurácia estão relacionados a atualização de informação em um local e não atualizar em outro.

Evite escrever o mesmo texto duas vezes ou copiar um texto, utilize recursos das ferramentas de reutilização do texto, de forma que mudando em um local mude em todos. Isso torna seu trabalho mais eficiente e sua documentação mais precisa.

4. Utilize ferramentas que automatizam a verificação de acurácia.

Utilize corretores ortográficos e gramaticais para corrigir as documentações.

5. Verifique a acurácia das referências contidas nas documentações.

Sempre revise:

• Se os Links estão corretos:
  • Sites na web: O link está correto, o site existe e está acessível?
  • Para sua própria documentação.
• Referências a documentações impressão estão corretas. Contém autor, título e editora?