Como fazer um manual de instrção

Como fazer um manual de instruções
Escrito por Josh Fredman | Traduzido por Sergio Mosquim Junior
Manuais de instruções são uma excelente aplicação no campo da escrita técnica. Um bom manual de instruções dirá ao usuário tudo que ele precisa fazer para ser capaz de dar sequência a uma determinada tarefa de maneira eficiente e com segurança.
Nível de Dificuldade:
Moderada
Instruções
1
Identifique as pessoas para quem a tarefa será destinada e escreva pensando no nível de compreensão delas. Saber seu público alvo é uma parte fundamental na escrita técnica.
2
Escreva um sumário na frente do manual se ele for ter mais do que algumas páginas. Se o manual for muito longo, inclua um índice remissivo na parte de trás.
3
Escreva uma breve introdução que descreva a tarefa em termos qualitativos. Dê ao usuário uma ideia da tarefa e qual será o resultado final. Esta oportunidade deve ser usada para fornecer conselhos importantes que ajudarão o usuário a fazer a tarefa correta e eficientemente.
4
Conforme necessário, dê uma lista de equipamentos e itens relevantes que o usuário precisará para completar a tarefa. Se o seu manual de instruções for para a montagem de um produto e acompanha o produto a ser montado, inclua uma lista separada de todas as partes que devem ter sido fornecidas ao usuário.
5
Cite claramente qualquer risco significante que possa causar machucados, morte, danos a propriedade e outros perigos. Use uma linguagem apropriada com as leis do local onde o manual será vendido.
6
Escreva cada ação da instrução em um passo distinto, provendo toda informação que o usuário precisará para concluir aquele passo. A escrita deve ser literal, direta ao ponto e não pode ser ambígua.
7
Se houver espaço em seu manual, inclua figuras e diagramas toda vez que for esclarecer uma etapa difícil para o usuário.
8
Caso julgue necessário, crie e inclua uma lista de conselhos para guiar o usuário a completar a