Comment rédiger un manuel

Instructions

1. Connaître le matériau - et le produit - intérieur. Assurez-vous que vous comprenez la procédure complètement - à la fois une pratique et d`un point de vue théorique. Assurez-vous que vous pouvez mener à bien le processus, vous serez décriviez en passant par les étapes nécessaires vous-même à plusieurs reprises jusqu`à ce que vous êtes convaincu que vous savez comment les remplir correctement et expliquer clairement.

2. Supposons que votre lecteur ne sait rien du tout sur le processus, vous serez décriviez lorsque vous écrivez votre manuel. Cela vous rappelle de ne rien prendre pour acquis que vous expliquez comment remplir la procédure et vous empêcher de quitter les lacunes dans votre explication que votre lecteur trouvera frustrant.

3. 
   
   
   
   

   Utilisez des diagrammes pour clarifier l`information qui serait difficile à transmettre avec précision des mots. Également utiliser eux pour l`information qui est aussi complexe que d`être déroutant pour le lecteur sans une représentation visuelle de l`élément, une partie ou d`un processus auquel il peut se référer comme il exécute les instructions du manuel.

4. Faire le lecteur à comprendre le but de chaque action et chaque étape du processus, de motiver son pour terminer chacun en expliquant la raison et les avantages de suivre les instructions présentées dans le manuel. Ne faites pas le lecteur deviner pourquoi une action pourrait être nécessaire ou se demander comment il serait utile. Cela pourrait lui causer de sauter une étape nécessaire ou d`éviter tout un processus qui pourrait grandement simplifier sa vie - et d`accroître considérablement son enthousiasme pour votre produit.

5. Casser le processus en petit, facile à mémoriser étapes. Ensuite, présenter les étapes dans l`ordre, du premier au dernier, en étant sûr que chaque étape conduit logiquement à l`autre. Assurez-vous de ne pas omettre toute information de fond importante qui permettra de clarifier l`étape suivante et le placer dans le contexte approprié.

6. Ecrire dans la plaine, langage clair et simple, et être sûr que le libellé que vous utilisez pour écrire votre manuel est pas ambigu. Si une instruction peut être comprise dans plus d`une façon, réécrire jusqu`à ce qu`il devienne limpide précisément ce que vous voulez que le lecteur à faire.

7. Testez le manuel sur un groupe de sujets qui correspondent au profil du groupe utilisateur prévu de l`échantillon. Observez comment facile ou il est difficile pour le groupe pour terminer la procédure pour laquelle la société vous a chargé d`écrire ce manuel. Solliciter des commentaires de votre groupe expérimental au sujet de leur expérience et des suggestions sur ce que vous pourriez faire différemment pour l`améliorer. Ensuite, écrire des modifications dans le manuel qui faciliterait une plus grande facilité d`utilisation par ceux qui achètent ce produit à l`avenir.