Escritores técnicos criam diferentes tipos de documentação, por exemplo, manuais do usuário, documentação API, guias ‘Como fazer’ e assim por diante. Eu escrevi um artigo sobre como escrever um manual do usuário, então hoje vou falar sobre como criar um guia ‘How to’.
Quando você tem uma tarefa para criar um guia, seu primeiro passo deve ser o planejamento. Aqui está o que deve fazer:
Entender o seu público-alvo
Quando começar a escrever o seu guia, deve compreender claramente quem é o seu público-alvo. Qual é a sua idade, qual é o seu passado e assim por diante. Isto irá definir o estilo do seu guia ‘Como fazer’ no nível mais fundamental – a complexidade da linguagem utilizada, o número de termos e muitas outras características.
Pesquisa sobre o processo
Eu recomendo que você leia sobre a experiência de outras pessoas em escrever guias ‘how-to’. Isso o ajudará a obter uma imagem clara do trabalho futuro, e você pode integrar as abordagens dos outros em seu processo de trabalho. Por exemplo, eu escrevi sobre o processo de escrita técnica do Amrute Ranade, você pode ler o artigo aqui: ‘Grande Processo de Escrita Técnica’. Então, você também pode usar este método para facilitar sua escrita técnica.
Reunir materiais úteis
Antes de começar a escrever, colete material e informações que o ajudarão a escrever um guia ‘how-to’. Pode ser informação adicional sobre um produto, outros guias ‘how-to’ sobre produtos similares ou algo mais.
Escreva o seu guia ‘how-to’
>
Primeiro de tudo, crie um plano – será mais fácil escrever um guia se você o visualizar. Depois de todos estes preparativos, já é hora de começar a escrever. Ao criar um guia, você deve ter em mente as seguintes dicas:
- Escreva em inglês simples para falar a mesma língua que seus leitores.
- Sua língua deve ser sempre concisa (por exemplo, Selecione a opção’ ao invés de ‘Você deve selecionar a opção’).
- Criar listas numeradas para estruturar passos se um usuário precisar completá-los
- Adicionar conteúdo visual como fotos, capturas de tela e diagramas.
- Dividir o conteúdo em seções com cabeçalho, mas escreva-as claramente
- Se você quiser usar piadas, tenha cuidado: as pessoas podem não entendê-lo
- Adicionar mini-TOCs para tornar grandes tópicos mais legíveis.
A dica mais essencial é a seguinte – erros ortográficos e gramaticais são inaceitáveis na documentação, então verifique cuidadosamente o seu guia. Aqui está uma lista dos Top Free Grammar Checkers. Além disso, você pode pedir a outra pessoa para revisar para você, ou ler seus próprios passos ao contrário para ter certeza de que sua escrita é clara e simples. Aqui estão alguns outros recursos para escrever ótima documentação:
- Livros Gramaticais para Escritores Técnicos
- Guias de Estilo para Escritores Técnicos
Obviamente, não é tudo o que há para saber sobre como escrever guias ‘How to’, mas estas dicas são as mais essenciais, na minha mente. Espero que o ajudem.
Bom sorte com os seus guias de escrita!