Uma documentação de qualidade deve sempre que possível, manter uma linguagem que seja clara e objetiva para seus usuários.

Em alguns casos, é necessário utilizar termos que podem tornar a leitura complexa se não utilizados corretamente, para uma correta utilização de termos:

  • Caso precise utilizar um termo na documentação que possa gerar alguma dúvida ao leitor, introduza este termos de forma breve no texto.
  • Seja consistente, ou seja, ao introduzir um termo, utilize-o ao longo do resto do texto, procure não utilizar sinônimos ou variações cada vez que o termo for utilizado.
  • Caso utilize um termo novo no texto, escreva uma definição clara sobre o mesmo, para evitar gerar dúvidas nos leitores.
  • Se tratando de documentação técnica, não traduza termos que são utilizados na informática, seja na programação ou em outros setores.