Comment rédiger un manuel
category Éducation et communications
Quatre parties:Apprenez à connaître le sujetPlanifiez votre disposition manuelleCommencez à écrireFormatage
Rédaction d'un manuel d'instruction peut sembler une tâche ardue, mais il est plus facile que vous le pensez! Ces étapes se appliquent à toute instruction écrite, de la plus simple (Comment Applaudissement) À l'intensément compliquée (Comment construire une Semiconductor.)
Les Étapes
Partie 1 de 4: Apprenez à connaître le sujet
2
Dialoguez avec des experts. Si votre rôle est tout simplement l'écrivain plutôt que l'expert en la matière de l'objet, impliquer les personnes bien informées au long du processus et se assurer qu'ils examinent votre travail. Leurs connaissances et leurs conseils sont précieux.
3
Essayez une approche pratique. Si possible, faire la chose que vous écrivez au sujet de la volonté, à tout le moins, vous donner une idée de ce que l'utilisateur voudra apprendre.
4
Lire sur le sujet. Apprenez à parler pour parler, et se familiariser dans le produit que vous écrivez.
- Manuels de produits similaires vont vous montrer comment d'autres auteurs ont abordé le sujet. # ** Chercher des similitudes entre les écrivains, ce qui indique à la fois la fonctionnalité commune et des approches communes pour décrire quelque chose.
Partie 2 de 4: Planifiez votre disposition manuelle
1
Décomposer. Si une feuille simple étape par étape instructions, ou un manuel pour un appareil photo numérique 35mm, de le décomposer en morceaux digestibles a plusieurs avantages:
- Il permet de vous concentrer sur les différentes parties de l'ensemble. Votre but est de familiariser l'utilisateur avec la façon d'apprendre le processus. Comment faire pour effectuer la fonction peut être laissé pour un tutoriel à la fin, si on le souhaite, ou vers la gauche pour l'utilisateur à découvrir sur leur propre.
2
Suivez une séquence logique. Il ne servirait à rien, par exemple, pour décrire comment le flash d'un appareil photo fonctionne jusqu'à ce que vous avez montré comment fixer l'objectif, chargez le film, allumer l'appareil photo, et d'ajuster la mise au point. Ceci est particulièrement utile si vous ne connaissez pas le sujet ainsi.
3
Utilisez-le comme votre modèle pour votre table des matières.
4
Passez en revue vos étapes. Une fois que vous avez défini les sections logiques, les examiner pour se assurer que tout est couvert.
5
Rassemblez vos fournitures. Avoir les éléments que vous décrivant en main et prêt à utiliser comme décrit dans le manuel. Si vous faites une boîte de papier, avoir du papier, ciseaux, ruban adhésif, colle, et une règle à portée de main. Si vous écrivez sur un appareil photo, assurez-vous que votre appareil est démonté. Si possible, le produit que vous écrivez au sujet devrait être de retour dans la zone à ce point.
Partie 3 de 4: Lancer écriture
1
Ecrire l'introduction. Cela va régler le ton de l'ensemble du manuel, et donner à l'utilisateur une idée de ce genre de manuel ils sont sur le digérer. Sera-ce la lumière et amusant, ou simple et sans fioritures? Cela dépend de votre lectorat. Il ya beaucoup plus de place pour les enfants verbales d'enseignement de la lecture pour faire une boîte de papier que son enseignement est à un médecin comment procéder à une chirurgie à cœur ouvert. Établir le ton dès le début et de garder ce ton dans le manuel.
2
Effectuez chaque étape que vous écrivez. Non seulement cela donne votre écriture l'air d'honnêteté et d'authenticité, vous assurez également rien ne sera laissé de côté.
- Si, pour une raison quelconque, il ne est pas possible de faire les étapes, les penser à travers soigneusement et consulter quelqu'un qui est un expert.
3
Numéroter les étapes. Cela rend plus facile pour les gens à suivre le long, et renvoient à doivent-ils perdre leur place.
4
Inclure des conseils et des avertissements. Comme vous écrivez, vous pouvez réaliser que si l'utilisateur effectue une étape négligemment, il pourrait causer un problème.
5
Testez-le. En utilisant seulement vos instructions écrites, faire ce que vous écrivez. Si vous trouver des endroits où vos instructions font défaut, ajoutez les informations nécessaires. Répétez cette étape jusqu'à ce que vous avez toutes les étapes et vous pouvez faire ce que vous enseignez sans avoir à ajouter des notes.
6
Relisez votre manuel. Vous ne voulez pas envoyer votre correcteur final (être que votre agence ou votre conjoint) d'un manuel complet des erreurs flagrantes.
Partie 4 de 4: Mise en forme
1
Commencez par le plus haut niveau. Une fois que vous avez toutes les mesures nécessaires détaillés, passez par votre manuel pour trouver la catégorie têtes évidentes.
2
Ecrire une table des matières, le cas échéant. Regardez la façon dont wikiHow est aménagé comme un exemple. La page principale offre de nombreux chefs de section. Lorsque vous accédez à une section, il énumère de nombreuses sous-catégories, et les sous-catégories Liste des articles. La plus détaillée votre manuel est, les plus de catégories et sous-catégories dont vous aurez besoin. (Comment Whistle n'a besoin de rien, Comment tailler un sifflet doit quelques-uns, et comment jouer de la flûte doit beaucoup!)
3
Relisez nouveau. Oui, vous l'avez fait à fond une fois déjà. Faire une deuxième fois sera sans doute prendre un peu plus de lieux ou erreurs mineures où votre manuel est tout simplement pas clair.
- Pour un manuel plus complet, vous pouvez également profiter de cette occasion de noter tous les petits sujets, et utiliser cette information pour créer un index.
4
Sélectionnez un titre.