quarta-feira, 2 de maio de 2018

7 Dicas de Como Planejar um Documento

Planeje seu Documento

Muitos escritores começam a escrever sem ter a menor ideia de qual caminho tomar. Isso se aplica a várias áreas de escrita como por exemplo, ficção, negócios ou até mesmo acadêmica. Se você for escrever em e-mail tudo bem não planejar antes, porque você já sabe o que vai escrever. Agora se você for escrever um manual ou um relatório é necessário fazer um planejamento antes de iniciar a escrita.

O planejamento vai auxiliar nas tomadas de decisões sobre quais tópicos e níveis de detalhamento que você deve colocar no documento, além de apresentar uma visão clara e organizada que o documento deve possuir na apresentação final. Com esta visão fica mais fácil e rápido elaborar o documento.

Antes de iniciar um documento devemos nos fazer algumas perguntas:
  1. Porque estou escrevendo este documento?
  2. Qual o objetivo?
  3. Quem vai ler e qual informação a pessoa necessita.
Conheça neste post 7 dicas que você pode utilizar para auxiliar no planejamento de um documento e tornar a escrita mais rápida.

1. Defina qual o Propósito

Defina o motivo de escrever o documento. Sem uma definição clara do propósito do documento fica difícil escrever. Como você vai saber qual informação incluir e o nível de detalhamento necessário. Alguns exemplos de propósito podem ser:
  • Interpretar resultados de laboratório
  • Fornecer instruções
  • Descrever serviços disponíveis para o cliente
  • Reportar a solução para um problema
  • Iniciar um novo procedimento
  • Estabelecer sua credibilidade profissional
  • Gerar Negócios

2. Defina seus Objetivos

Antes de iniciar a escrita de qualquer tipo de documento precisamos definir qual o objetivo do documento, por exemplo fazer com que um usuário consiga utilizar um software, um técnico consiga instalar um equipamento, um cliente consiga montar um equipamento.

Definir o objetivo é importante porque além de guiar o curso da escrita do documento, auxilia a verificar se atingiu o objetivo desejado após a finalização do documento.

3. Defina sua Audiência

Conhecer a audiência é importante para escrever um documento. Se você conhece a audiência fica mais fácil definir como escrever e o grau de dificuldade do texto. Se a audiência é um grupo de pessoas por exemplo, técnicos especializados de uma área específica, o documento pode ter mais termos técnicos da área e você não precisa se preocupar em definir todos os termos, porque a audiência já conhece o assunto.

Se for um grupo de pessoas com conhecimento variado e você precisa escrever um documento técnico, vai ser necessário explicar com mais detalhes os termos técnicos, porque nem todas as pessoas da audiência conhecem o assunto. Escrever um documento desse tipo é um pouco mais complicado.

Procure conhecer a sua audiência, pesquise quais são os interesses, quais são as informações que a audiência necessita. Somente após conhecer a sua audiência é que você deve escrever o documento.

4. Entenda o Tipo de Documento

A forma que as pessoas leem depende do tipo de material. Se for um livro para distração, tipo uma aventura ou um romance, as pessoas leem do começo ao fim. Se for uma apostila ou livro didático o leitor normalmente lê os capítulos de interesse e antes de ler o próximo capítulo procuram entender o capítulo anterior, porque normalmente existe uma dependência no entendimento dos capítulos anteriores para entender o próximo.

Se for um manual ou um relatório o leitor procura diretamente a informação desejada. Os manuais são destinados principalmente para procurar informações, para resolver um problema, responder uma dúvida ou para completar uma tarefa.

Para esse tipo de documento você pode seguir alguns passos que facilitam a procura da informação pelo usuário, por exemplo:
  • Organize as informações relacionadas no mesmo local. 
  • Divida o texto em partes lógicas. 
  • Crie uma tabela de conteúdo com a relação dos tópicos. Se o documento possuir mais de 50 páginas crie também um índice alfabético. 
  • Utilize técnica de apresentação, tipo listas numeradas, tabelas e diagramas. 
  • Realce as palavras chaves e ideias.
Somente após definir o tipo de documento por exemplo, se livro, manual, apostila, relatório, você pode definir a organização e como vão ser apresentados os tópicos do documento.

5. Organize suas Ideias

Uma vez definido os tópicos que compõem o documento precisamos organizar, por isso considere:
  • Como a informação será utilizada. 
  • Como normalmente esse tipo de informação é organizada. Pesquise material semelhante. 
  • Os leitores estão familiarizados com as informações ou é necessário fazer a introdução e detalhar cada informação. 
  • Qual a relação lógica entre as diferentes partes da informação.

6. Organize seu Documento

A organização das informações não precisa ser idêntica em todo o documento, depende do tipo de informação. Uma seção pode estar em ordem de tópicos outra em ordem alfabética.

Pode-se organizar uma seção com a sequência de informações de forma a explicar os detalhes mais facilmente ou por ordem de tarefas.

A organização do documento vai depender do tipo de informação e como apresentar de forma a ficar clara, objetiva e lógica para o leitor.

7. Faça um Esboço Antes de Escrever

Antes de iniciar a escrita do documento faça um esboço das ideias principais. Se for um documento longo como um manual, faça antes um esboço da tabela de conteúdo com os tópicos principais e pelo menos um subtópico. Se o documento for mais complexo inclua vários níveis na tabela de conteúdo.

Um exemplo que posso citar é o Ebook Introdução ao Scrum que escrevi recentemente. Antes de iniciar o ebook fiz primeiro um esboço do que é atualmente a tabela de conteúdo. Este processo me ajudou a ter uma visão clara da organização que eu queria apresentar no documento.

O esboço serve para você visualizar o conteúdo necessário para o documento e para ajudar em uma reunião com as outras pessoas envolvidas no projeto.

Sem um planejamento anterior fica muito difícil escrever qualquer tipo de documento. Pode dar um pouco de trabalho fazer o planejamento antes, mas a recompensa vem depois. Esse tempo que você gasta fazendo o planejamento você ganha lá na frente, porque o rendimento no momento de escrever vai ser muito maior. Você já sabe exatamente que passos seguir, o que escrever e a organização da informação, isso faz com que o processo de escrever seja mais rápido. 

Post Relacionado