Comment faire un manuel d'instruction

Identifier les personnes pour qui la tâche est destiné, et écrire à leur niveau de compréhension. Connaissant votre public est un élément crucial de la bonne rédaction technique.

Ecrire une table des matières à l'avant du manuel si votre manuel sera plus que quelques pages. Si votre manuel sera très long, comprendre un index à l'arrière.

Ecrire une brève introduction qui décrit la tâche en termes qualitatifs. Donner à l'utilisateur un sentiment de ce que la tâche est et ce que le résultat final sera. Profitez de cette occasion de donner un avis général important qui aidera l'utilisateur d'effectuer la tâche correctement et efficacement.

Fournir, le cas échéant, une liste de l'équipement et des articles pertinents à l'utilisateur aura besoin pour accomplir la tâche. Si votre manuel d'instruction est pour l'assemblage de produits et accompagne le produit à assembler, inclure une liste distincte de toutes les parties qui auraient dû être fournis à l'utilisateur.

Étiqueter clairement tous les risques importants qui peuvent entraîner la mort, des blessures, des dégâts matériels et d'autres dangers. Utilisez un langage qui est conforme aux codes juridiques dans la juridiction où votre manuel sera vendu.

Écrivez chaque action individuelle dans le processus d'enseignement comme son propre, étape distincte, fournir toute information spécifique que l'utilisateur aura besoin pour terminer cette étape. Ces différentes étapes doivent être sans ambiguïté, littérale et droit au but.

Illustrer le manuel avec des diagrammes et des chiffres chaque fois que cela lui permet de contribuer à clarifier une étape difficile pour l'utilisateur, à condition qu'il n'y a de place dans votre manuel pour vous d'inclure les graphiques.

Inclure, à votre discrétion, une liste détaillée des conseils pour aider à guider l'utilisateur dans la réalisation de la tâche.