Comment rédiger un manuel?

Comment sculpter un sifflet en a besoin de quelques-uns — (Comment siffler n'en a pas besoin, comment sculpter un sifflet en a besoin de quelques-uns, et comment jouer de la flûte en a besoin de beaucoup!).

La rédaction d'un manuel d'instructions peut sembler une tâche ardue, mais c'est plus facile que vous ne le pensez! Ces étapes s'appliquent à toute instruction écrite, de la très simple (Comment applaudir) à l'intensément compliquée (Comment construire un semi-conducteur.)

Partie 1 sur 4: apprenez à connaître le sujet

1

C'est la clé. Cela peut sembler évident, mais la connaissance est la clé de la réussite de la rédaction d'un manuel. Par exemple, si vous rédigez le manuel d'un appareil photo, sachant qu'un diaphragme et la vitesse d'obturation ne sont pas seulement 2 fonctions distinctes - ils le sont - mais savoir comment ils interagissent les uns avec les autres vous permettra de décrire beaucoup plus facilement chaque fonction. en ce qui concerne l’ensemble.
2

Parlez à des experts. Si votre rôle est simplement l'écrivain plutôt que l'expert en la matière, impliquez des personnes compétentes tout au long du processus et assurez-vous qu'elles examinent votre travail. Leurs connaissances et leurs conseils sont inestimables.
3

Essayez une approche pratique. Si possible, faire ce que vous écrivez vous donnera au moins une idée de ce que l'utilisateur voudra apprendre.
4
Renseignez-vous sur le sujet. Apprenez à parler et à vous familiariser avec le produit sur lequel vous écrivez.
- Des manuels de produits similaires vous montreront comment d'autres auteurs ont abordé le sujet.
  - Recherchez des similitudes entre les auteurs, ce qui indique à la fois des fonctionnalités communes et des approches communes pour décrire quelque chose.
  - Recherchez les différences qui ressortent. Il s'agit probablement de fonctions propres à un produit donné. Votre produit peut inclure ou non ces fonctions, ou peut avoir d'autres moyens de résoudre le problème que vous pouvez décrire, améliorant ainsi la valeur de votre produit. Bien que votre travail soit d'écrire un guide pratique, montrer aux clients la valeur de leur achat est un excellent moyen de les encourager à continuer à lire.
- Dévorez les magazines spécialisés. Découvrez comment les personnes qui utilisent les produits travaillent avec eux au quotidien. Ils souhaiteront peut-être qu'une fonction ait résolu leur problème particulier, et si votre produit est la solution, cela doit être mis en évidence.

Comment créer une table des matières pour un manuel expliquant comment devenir propriétaire de votre entreprise?

Partie 2 sur 4: Planifiez votre mise en page manuelle

1
Décomposez-le. Qu'il s'agisse d'une simple feuille d'instructions étape par étape ou d'un manuel pour un appareil photo numérique 35 mm, le décomposer en morceaux digestibles présente plusieurs avantages:
- Il vous permet de vous concentrer sur des parties individuelles de l'ensemble. Votre objectif est de familiariser l'utilisateur avec la manière d'apprendre le processus. L'exécution de la fonction peut être laissée pour un didacticiel à la fin, si vous le souhaitez, ou laissée à l'utilisateur à découvrir par lui-même.
2

Suivez une séquence logique. Il ne servirait à rien, par exemple, de décrire le fonctionnement du flash d'un appareil photo tant que vous n'avez pas montré comment fixer l'objectif, charger le film, allumer l'appareil photo et régler la mise au point. Ceci est particulièrement utile si vous ne connaissez pas bien le sujet.
3

Utilisez-le comme modèle pour votre table des matières.
4

Passez en revue vos étapes. Une fois que vous avez défini les sections logiques, examinez-les pour vous assurer que tout est couvert.
5

Rassemblez vos fournitures. Ayez les éléments que vous décrivez sous la main et prêts à être utilisés comme décrit dans le manuel. Si vous fabriquez une boîte en papier, ayez du papier, des ciseaux, du ruban adhésif, de la colle et une règle à portée de main. Si vous écrivez sur un appareil photo, assurez-vous que votre appareil photo est démonté. Si possible, le produit sur lequel vous écrivez devrait être de retour dans la boîte à ce stade.

Finissez d'abord par rédiger le manuel — Si vous écrivez le manuel dans un ordre chronologique, finissez d'abord par rédiger le manuel.

Partie 3 sur 4: commencez à écrire

1

Écrivez l'introduction. Cela donnera le ton à l'ensemble du manuel et donnera à l'utilisateur une idée du type de manuel qu'il s'apprête à digérer. Sera-ce léger et amusant, ou simple et sans fioritures? Cela dépend de votre lectorat. Il y a beaucoup plus de place pour le jeu verbal pour apprendre aux enfants à fabriquer une boîte en papier que pour apprendre à un médecin comment procéder à une chirurgie à cœur ouvert. Établissez le ton tôt et gardez-le tout au long du manuel.
2
Effectuez chaque étape au fur et à mesure que vous écrivez. Non seulement cela donne à votre écriture un air d'honnêteté et d'authenticité, mais vous vous assurez également que rien ne sera laissé de côté.
- Si, pour une raison quelconque, il n'est pas possible de suivre les étapes, réfléchissez-y attentivement et consultez quelqu'un qui est un expert.
3
Numérotez les étapes. Cela permet aux gens de suivre plus facilement et de se référer s'ils perdent leur place.
- Si vous écrivez sur papier, assurez-vous de laisser un espace pour les ajouts entre chaque étape. N'oubliez pas de renuméroter vos étapes si vous en ajoutez d'autres.
4
Incluez des conseils et des avertissements. Au fur et à mesure que vous écrivez, vous vous rendrez peut-être compte que si l'utilisateur effectue une étape de manière imprudente, cela peut poser un problème.
- À l'inverse, s'il y a des connaissances qui rendront la tâche de l'utilisateur plus facile ou plus intéressante, ajoutez-les.
5
Testez-le. En utilisant uniquement vos instructions écrites, faites ce que vous écrivez. Si vous trouvez des endroits où vos instructions manquent, ajoutez les informations nécessaires. Répétez cette étape jusqu'à ce que vous ayez toutes les étapes et que vous puissiez faire ce que vous enseignez sans avoir à ajouter de notes.
- Pensez à demander à un ami ou à deux d'utiliser le manuel. Surveillez-les attentivement lorsqu'ils apprennent à utiliser le produit. Voyez où ils se faufilent. Voyez où ils se perdent, se perdent ou échouent dans la tâche. Écoutez ce qu'ils ont à dire, puis ajustez votre manuel en conséquence.
6

Relisez votre manuel. Vous ne voulez pas envoyer à votre relecteur final (que ce soit votre agence ou votre conjoint) un manuel plein d'erreurs flagrantes.

Partie 4 sur 4: formatage

1
Commencez au plus haut niveau. Une fois que vous avez toutes les étapes nécessaires détaillées, parcourez votre manuel pour trouver les têtes de catégorie évidentes.
- Donnez-leur un titre et notez leur emplacement.
2

Rédigez une table des matières, le cas échéant. Regardez la façon dont le guide est présenté à titre d'exemple. La page principale propose de nombreuses têtes de section. Lorsque vous accédez à une section, elle répertorie de nombreuses sous-catégories et les sous-catégories répertorient des articles. Plus votre manuel est détaillé, plus vous aurez besoin de catégories et de sous-catégories. (Comment siffler n'en a pas besoin, comment sculpter un sifflet en a besoin de quelques-uns, et comment jouer de la flûte en a besoin de beaucoup!)
3
Relisez à nouveau. Oui, vous l'avez fait à fond une fois déjà. Le faire une deuxième fois détectera sans aucun doute quelques erreurs mineures supplémentaires ou des endroits où votre manuel n'est tout simplement pas clair.
- Pour un manuel plus complet, vous pouvez également profiter de cette occasion pour noter tous les petits sujets et utiliser ces informations pour créer un index.
4

Sélectionnez un titre.

Demandez à un novice de faire un test de votre manuel — Si vous le pouvez, demandez à un novice de faire un test de votre manuel et d'écrire toutes les questions qu'il pose!

Conseils

Même si quelque chose vous semble évident, écrivez les étapes! Cela vous aidera à éviter de passer sous silence quelque chose que votre utilisateur ne sait pas. Il est préférable de fournir des informations supplémentaires plutôt que d'omettre des étapes importantes.
Si vous écrivez un manuel très détaillé qui nécessite des chapitres, tels que Comment jouer de la flûte, votre première étape pourrait en fait être de lister tous les chapitres, tels que Sélection d'une flûte, Assemblage et entretien, Production de son, Méthodes de doigté, Votre Première pièce, etc. Vous appliqueriez alors les règles de base pour rédiger un manuel à chaque chapitre car chaque chapitre est comme un manuel séparé en lui-même!
Autant que possible, illustrez vos instructions! Si vous ne pouvez pas insérer d'images, référez votre élève à quelque chose de commun comme exemple. Par exemple, dans la mise en forme, étape 2 de ces instructions, l'aspect de la mise en page du guide est utilisé pour illustrer la façon dont une table des matières peut être créée.
Ecrire chaque section sur une page distincte (ou sur un ordinateur) facilitera l'édition. Vous pouvez réorganiser plus facilement si vous avez de la place pour travailler et pouvez trouver vos marques d'édition. Sur l'ordinateur, laissez 3 ou 4 lignes (en appuyant plusieurs fois sur Entrée) entre chaque étape afin de trouver facilement les pauses.
Si vous le pouvez, demandez à un novice de faire un test de votre manuel et d'écrire toutes les questions qu'il pose! Cela vous aidera à remplir les espaces vides et à rendre votre manuel beaucoup plus utile.

Lisez aussi: Comment rédiger un e-mail professionnel à une personne que vous ne connaissez pas?