5 Boas Práticas para Escrever um Documento

Boas práticas para escrever um documento

Para tornar um documento claro, objetivo e de fácil entendimento podemos aplicar algumas práticas de escrita que irão transforma-lo em um documento de qualidade. Você não precisa usar todas as práticas de uma só vez, pode usar de acordo com a necessidade e o contexto do documento. Se for um contrato não vai ter gráficos, agora se for um manual é interessante ter figuras ou mesmo gráficos para ilustrar a informação.

Conheça agora cinco boas práticas de escrita para aumentar a qualidade e fazer um documento claro, objetivo e que passe a informação de forma compreensível ou tire a dúvida que o leitor possui.

1. Defina uma Hierarquia

Se você está escrevendo um documento tipo carta, memorando ou um e-mail não é necessário colocar título, porque são documentos com normalmente somente uma página. Agora se você for escrever um documento mais longo tipo relatório ou manual torna-se necessário incluir títulos para dividir os tópicos, e tornar o documento compreensível para o leitor.

Sem uma hierarquia os leitores vão achar o documento confuso e de difícil localização das informações. Uma hierarquia de título clara e lógica é essencial para qualquer documento longo.

O recomendado é construir uma hierarquia lógica com o título principal e algumas subseções, 3 ou 4 subseções no máximo, para não confundir o leitor. Veja um exemplo na Figura 1.

Figura 1 - Exemplo de Hierarquia de Títulos
Seguem algumas regras para montar uma hierarquia lógica:
  • Evite título único dentro de uma seção, coloque dois ou mais títulos.
  • Evite colocar um título seguido de outro título sem um texto no meio.
  • Evite pular níveis de títulos para manter um padrão no estilo dos títulos por exemplo, o título1 deve ser seguido pelo título2 e assim sucessivamente.

2. Escreva Parágrafos Curtos

Os parágrafos são utilizados para organizar o texto em blocos e podem ser divididos em tópicos. Quando mudar de tópico crie um parágrafo novo.

Geralmente o parágrafo é composto de 3 ou 4 sentenças em documentos. Evite parágrafos muito longos para não intimidar o leitor.

Comece cada parágrafo com uma sentença sobre o tópico. Coloque o assunto geral do tópico na primeira sentença e somente depois detalhe o tópico nas demais sentenças.

Não tem problema “quebrar” o parágrafo entre páginas, somente evite deixar uma linha única no começo ou no final de uma página.

3. Use Títulos Informativos

Os títulos são importantes para descrever a informação detalhada do texto logo abaixo do título. É importante colocar um título informativo para auxiliar o leitor a decidir qual parte do documento possui a informação desejada, principalmente em documentos longos como manuais.

Como boa prática na construção de títulos:
  • Use títulos que descrevam o tópico, não o tipo de informação. Evite títulos como por exemplo, “Mais Informações”, “Resultados”, “Procedimentos”, “Diversos”. Se o título for para uma tarefa utilize o verbo no gerúndio por exemplo, “Salvando o Arquivo”.
  • Mantenha o título curto com no máximo quatro ou cinco palavras, se possível.
  • Evite numerar os títulos. A numeração de título é importante somente se for necessário fazer uma referência exata da seção como por exemplo, em documentos de especificação.
  • Use títulos similares por exemplo, se você utilizar verbo no imperativo, então faça com que todos os títulos sejam do mesmo padrão.
  • Escolha uma forma única de utilizar os títulos em letra maiúscula. Escolha entre colocar a primeira letra maiúscula em todas as palavras com exceção dos artigos e preposições, ou utilizar o formato jornalístico, somente a primeira letra da primeira palavra em maiúsculo.

4. Mostre a Informação Através de Gráficos

Dependendo do tipo de informação fica mais fácil para o leitor entender se for apresentado como uma figura ou gráfico. Veja exemplos de informação representada em gráficos no post O Que é Visualização de Dados

Quando você está escrevendo o texto analise se a informação vai ser mais fácil de entender em formato de parágrafos ou através de:
  • Lista de marcadores,
  • Caixa de texto,
  • Textos laterais,
  • Tabelas,
  • Listas numeradas,
  • Imagens,
  • Diagramas,
  • Captura de telas,
  • Gráficos.

Exibir a informação em outros formatos além de blocos de parágrafos facilita o entendimento e auxilia o leitor a localizar a informação de forma mais rápida.

5. Escreva de Forma Clara

Os documentos utilizados para os negócios são documentos com o propósito de comunicar a informação de forma rápida e de maneira clara.

Evite utilizar palavras complicadas e sentenças longas. Escreva objetivamente utilizando palavras do dia a dia e sentenças curtas, dando preferência ao formato sujeito-verbo-objeto.

As boas práticas para escrever um documento podem ser utilizadas em vários tipos de documentos como manuais, relatórios, especificações, guias e muitos outros tipos. Para melhorar a qualidade de seus documentos vá inserindo aos poucos as boas práticas, com o tempo você já vai estar habituado a usar as boas práticas de escrita.

Posts Relacionados: