Como escrever um manual

instruções

1. Conhecer o material - e o produto - de dentro para fora. Certifique-se de que você entenda o procedimento completamente - tanto de um prático e um ponto de vista teórico. Certifique-se que você pode realizar com sucesso o processo você estará descrevendo atravessando as medidas necessárias a si mesmo repetidamente até que você esteja convencido de que você sabe como preenchê-los corretamente e explicá-los claramente.

2. Suponha que seu leitor sabe nada sobre o processo você estará descrevendo quando você escreve o seu manual. Isso irá lembrá-lo tomar nada como garantido como você explicar como para concluir o procedimento e vai impedi-lo de deixar lacunas na sua explicação de que o leitor vai encontrar frustrante.

3. Use diagramas para esclarecer informações que seriam difíceis de transmitir com precisão em palavras. Também usá-los para a informação que é tão complexo quanto a ser confuso para o leitor, sem uma representação visual do item, peça ou processo ao qual ele pode se referir a ele carrega as instruções do manual.

4. 
   
   
   

   Faça o leitor a compreender a finalidade de cada ação e cada etapa do processo, motivando-a para completar cada um por explicar a razão para isso e os benefícios de seguir as instruções apresentadas no manual. Não fazer o leitor adivinhar por que uma ação pode ser necessário ou se perguntar como seria útil. Isso pode fazer com que ela pule uma etapa necessária ou evitar a todo um processo que pode simplificar muito a sua vida - e aumentar significativamente o seu entusiasmo para o seu produto.

5. Dividir o processo em pequeno, fácil de lembrar etapas. Em seguida, apresentamos os passos em ordem sequencial, do primeiro ao último, sendo certo que cada passo leva logicamente para o próximo. Cuidado para não omitir qualquer informação de fundo importante que irá esclarecer o próximo passo e colocá-lo no contexto apropriado.

6. Escrever na planície, linguagem clara e simples, e não se esqueça o texto que você usa para escrever o seu manual não é ambígua. Se uma instrução pode ser entendida em mais de uma maneira, reescrevê-lo até que se torne claro exatamente o que você quer o leitor a fazer.

7. Teste o manual sobre uma amostra de indivíduos que se encaixam no perfil do grupo de utilizadores a que se destina. Observe quão fácil ou difícil é para o grupo a concluir o procedimento para o qual a empresa encomendou a escrever este manual. Solicitar feedback de seu grupo experimental sobre a sua experiência e sugestões sobre o que você pode fazer de diferente para melhorá-lo. Em seguida, escreva qualquer outra alteração no manual que facilitaria uma maior facilidade de uso por aqueles que compram este produto no futuro.