segunda-feira, 15 de maio de 2017

7 Dicas de Como Escrever um Manual



Recentemente li um Manual de Escrita Técnica bem interessante que detalha os passos de como escrever um Manual, independentemente do tipo de manual ou de produto. São dicas genéricas que podem ser seguidas para qualquer tipo de Manual. Neste post apresento um resumo dos principais passos mencionados. Você pode acessar o Manual completo ou fazer o download através do link Tech Writing Handbook.

Para escrever um manual existem duas leis básicas, a primeira é que é necessário ter o conhecimento sobre o assunto que o Manual vai abordar, se for um produto, é necessário conhecer o produto, se for um software é necessário utilizar o software, se for instruções para montar ou consertar algum produto é necessário executar a montagem ou conserto, antes de escrever sobre o assunto.

A segunda lei é conversar com os especialistas que desenvolveram o produto ou o software, perguntar, consultar tentar obter o maior número de informações possíveis sobre o assunto que o Manual deve abordar.

Além de obedecer as duas leis básicas podemos seguir alguns passos para que o Manual seja claro, objetivo e fácil de entender.

1. Seja coerente

  • Comece o parágrafo com a informação mais importante.
  • Escreva os fatos, as informações que não forem relevantes não precisam ser incluídas.
  • Escreva sentenças curtas com no máximo 24 palavras.
  • Não utilize palavras vazias por exemplo, no evento de, substitua por se.
  • Utilize voz ativa, elimine o verbo Ser. Elimine seria, deveria ser,  tinha sido.
  • Utilize voz passiva estrategicamente, mas se puder substituir por voz ativa, substitua.
  • Quando der direções comece a frase com o Verbo.

2. Escreva com Clareza

  • Utilize linguagem simples.
  • Não utilize jargões.
  • Não transforme verbos em substantivos.
  • Utilize as palavras um, uma, o, a, sem problemas. A omissão dessas palavras faz o texto parecer que foi escrito por um robô.
  • Faça testes com pessoas que não conhecem o assunto do Manual. Peça para que elas leiam o conteúdo e verifique se está claro e não existe nenhuma dúvida. Se existir significa que o Manual não está claro.
  • Não use as palavras, bastante, principalmente, um pouco,  parece, espécie de,  bonito.
  • No caso de siglas explique o significado a primeira vez que aparece no texto e coloque a sigla entre parênteses.

3. Comunique-se com Clareza

Cada autor tem um estilo de escrita que deve ser seguido do começo ao fim do Manual. O recomendado é que o autor seja espontâneo.

A utilização da segunda pessoa você ou seu, sua, pode ser utilizado sem problemas. Inclusive o texto fica mais claro. Naturalmente não deve ser utilizado em textos científicos que devem demonstrar imparcialidade.

Os parágrafos devem ser curtos. A regra de parágrafos com cinco sentenças não é aplicada em escrita técnica. Um parágrafo pode ser iniciado quando se inicia um novo pensamento. Uma recomendação é utilizar os marcadores para dar uma "quebrada" no texto.

4. Verifique a Audiência

Para escrever um bom Manual, o ideal é conhecer a audiência que vai utilizar o Manual. Um Manual para cliente não técnico deve ter termos simples e fáceis de entender. Um Manual para uma audiência mais técnica pode utilizar os termos técnicos já conhecidos.

Dependendo da audiência verifique a possibilidade e necessidade de incluir um glossário em seu Manual.

5. Fotografe o Processo

Não devemos somente explicar como fazer, é necessário mostrar como fazer. Utilize outras formas de figuras, além de fotos devemos utilizar outras formas de imagem para explicar como fazer determinado procedimento, portanto utilize gráficos, diagramas,  ilustrações, vídeos.

6. Organize o Conteúdo

  • Faça um esboço do conteúdo do manual.
  • As pessoas vão ler o Manual para procurar como fazer uma determinada tarefa se for o caso, portanto organize o Manual por tarefas nestas situações.
  • Utilize listas, numeradas ou não.
  • Escreva instruções úteis, e quando possível peça feedback das pessoas que leram o Manual.
  • Se a tarefa for um passo a passo, explique em sentenças curtas com fotos ou diagramas o que deve ser feito na sequência correta.
  • Faça reuso de conteúdo de forma inteligente. Se uma determinada tarefa for um pré-requisito que pode ser reutilizado, descreva o pré-requisito no Guia de Pré-Requisitos, depois somente mencione a página do pré-requisito, quando for necessário utilizá-lo novamente.

7. Requisitos Legais

As informações de perigos e riscos de utilização de determinado produto devem aparecer no manual de forma clara e chamativa por exemplo, com ícones, cores, letra em negrito. O texto também deve ser fácil de entender.

Muitas empresas para se protegerem legalmente iniciam o manual com páginas de recomendações e cuidados.  O manual deve ter as recomendações, mas devemos ser coerentes e manter um bom senso na quantidade e no tipo de recomendação.

Antes de iniciar a elaboração do Manual verifique se é necessário seguir alguma norma da empresa ou do local.

Conclusão

A elaboração de um bom Manual não é uma tarefa fácil, requer pesquisa, planejamento, conhecimento do assunto que será abordado, entre outros detalhes como apresentação e distribuição, mas sempre é bom conhecermos algumas dicas que podem ser seguidas durante a elaboração do Manual, para termos um bom resultado junto ao cliente.

Posts Relacionados: