L’une des utilisations les plus courantes et les plus importantes de la rédaction technique consiste à fournir des instructions, ces explications étape par étape de la façon d’assembler, de faire fonctionner, de réparer ou d’effectuer la maintenance de routine de quelque chose. Bien qu’elles puissent sembler intuitives et simples à rédiger, les instructions font partie des documents les plus mal écrits que l’on puisse trouver. La plupart d’entre nous ont probablement eu de nombreuses expériences exaspérantes avec des instructions mal écrites. Ce chapitre vous montrera ce que les professionnels considèrent comme les meilleures techniques pour fournir des instructions.
Un ensemble efficace d’instructions nécessite ce qui suit :
- Une écriture claire, précise et simple
- Une compréhension approfondie de la procédure dans tous ses détails techniques
- La capacité de se mettre à la place du lecteur, de la personne qui essaie d’utiliser vos instructions
- La capacité de visualiser la procédure en détail et de capturer cette conscience sur papier
- La volonté de tester vos instructions sur le type de personne pour laquelle vous les avez écrites.
Au début d’un projet de rédaction d’un ensemble d’instructions, il est important de déterminer la structure ou les caractéristiques de la procédure particulière sur laquelle vous allez écrire. Voici quelques étapes à suivre :
Faire une analyse minutieuse du public et de la tâche
Au début du processus, définissez le public et la situation de vos instructions. Rappelez-vous que définir un public signifie définir le niveau de familiarité de vos lecteurs avec le sujet.
Déterminer le nombre de tâches
Combien de tâches y a-t-il dans la procédure sur laquelle vous écrivez ? Utilisons le terme de procédure pour désigner l’ensemble des activités dont vos instructions sont censées traiter. Une tâche est un groupe semi-indépendant d’actions au sein de la procédure : par exemple, le réglage de l’horloge d’un four à micro-ondes est une tâche dans la grande procédure globale d’utilisation d’un four à micro-ondes.
Une procédure simple comme la vidange de l’huile d’une voiture ne contient qu’une seule tâche ; il n’y a pas de groupements semi-indépendants d’activités. Une procédure plus complexe comme l’utilisation d’un four à micro-ondes contient plusieurs tâches semi-indépendantes : réglage de l’horloge ; réglage du niveau de puissance ; utilisation de la minuterie ; nettoyage et entretien du four à micro-ondes, entre autres.
Certaines instructions n’ont qu’une seule tâche, mais comportent de nombreuses étapes au sein de cette seule tâche. Par exemple, imaginez un ensemble d’instructions pour assembler une balançoire pour enfants. Dans ma propre expérience, il y avait plus de 130 étapes ! Cela peut être un peu décourageant. Une bonne approche consiste à regrouper les étapes similaires et connexes en phases, et à commencer à renuméroter les étapes à chaque nouvelle phase. Une phase est donc un groupe d’étapes similaires dans une procédure à tâche unique. Dans l’exemple de la balançoire, la mise en place du cadre serait une phase ; l’ancrage de la chose dans le sol en serait une autre ; l’assemblage de la balançoire en boîte en serait encore une autre.
3. Déterminer la meilleure approche de la discussion pas à pas
Pour la plupart des instructions, vous pouvez vous concentrer sur les tâches, ou vous pouvez vous concentrer sur les outils (ou les caractéristiques des outils). Dans une approche axée sur les tâches (également connue sous le nom d’orientation vers les tâches) des instructions sur l’utilisation d’un service de réponse téléphonique, vous auriez ces sections :
- Enregistrer votre message d’accueil
- Lire vos messages
- Sauvegarder vos messages
- Retourner vos messages
- Supprimer vos messages, et ainsi de suite
Ce sont des tâches – les choses typiques que nous voudrions faire avec la machine.
D’autre part, dans une approche outils des instructions sur l’utilisation d’une photocopieuse, il y aurait probablement des sections sur la façon d’utiliser des fonctionnalités spécifiques :
- Bouton de copie
- Bouton d’annulation
- Bouton d’agrandissement/réduction
- Bouton de collage/agrafage
- Bouton de taille de copie, et ainsi de suite
Si vous conceviez un ensemble d’instructions sur ce plan, vous écririez des étapes pour utiliser chaque bouton ou fonction de la photocopieuse. Les instructions utilisant cette approche par outils sont difficiles à faire fonctionner. Parfois, le nom du bouton ne correspond pas tout à fait à la tâche à laquelle il est associé ; parfois, vous devez utiliser plus d’un bouton pour accomplir la tâche. Pourtant, il peut y avoir des moments où l’approche outils/fonctionnalités peut être préférable.
4. Concevoir des regroupements de tâches
La liste des tâches peut ne pas être tout ce que vous devez faire. Il peut y avoir tellement de tâches que vous devez les regrouper pour que les lecteurs puissent trouver plus facilement les tâches individuelles. Par exemple, voici des regroupements de tâches courants dans les instructions :
- Tâches de déballage et de configuration
- Tâches d’installation et de personnalisation
- Tâches d’exploitation de base
- Tâches de maintenance de routine
- Tâches de dépannage.
Sections courantes dans les instructions
Ce qui suit est un examen des sections que vous trouverez couramment dans les instructions. Ne supposez pas que chacune d’entre elles doit figurer dans les instructions réelles que vous rédigez, ni qu’elles doivent être dans l’ordre présenté ici, ni que ce sont les seules sections possibles dans un ensemble d’instructions.
Pour des formats alternatifs, consultez les exemples d’instructions.
Introduction : planifiez soigneusement l’introduction de vos instructions. Elle pourrait inclure l’un des éléments suivants (mais pas nécessairement dans cet ordre) :
- Indiquer les tâches ou la procédure spécifiques à expliquer ainsi que le champ d’application (ce qui sera et ne sera pas couvert)
- Indiquer ce dont le public a besoin en termes de connaissances et de contexte pour comprendre les instructions
- Donner une idée générale de la procédure et de ce qu’elle accomplit
- Indiquer les conditions dans lesquelles ces instructions devraient (ou ne devraient pas) être utilisées
- Donner un aperçu du contenu des instructions.
Avertissements généraux, précautions, avis de danger : les instructions doivent souvent avertir les lecteurs de la possibilité de ruiner leur matériel, de foirer la procédure et de se blesser. De même, les instructions doivent souvent souligner des points clés ou des exceptions. Pour ces situations, vous utilisez des notices spéciales (note, avertissement, prudence et danger). Remarquez comment ces notices spéciales sont utilisées dans les exemples d’instructions listés ci-dessus.
Contexte technique ou théorie : au début de certains types d’instructions (après l’introduction), vous pouvez avoir besoin d’une discussion sur le contexte lié à la procédure. Pour certaines instructions, ce contexte est essentiel – sinon, les étapes de la procédure n’ont aucun sens. Par exemple, vous avez peut-être déjà utilisé ces applets logiciels dans lesquels vous définissez vos propres couleurs en déplaçant les barres de défilement rouge, vert et bleu. Pour vraiment comprendre ce que vous faites, vous devez avoir des connaissances sur les couleurs. De même, vous pouvez imaginer que, pour certaines instructions utilisant des appareils photo, un peu de théorie pourrait également être nécessaire.
Équipement et fournitures : remarquez que la plupart des instructions comprennent une liste des choses que vous devez rassembler avant de commencer la procédure. Cela comprend l’équipement, les outils que vous utilisez dans la procédure (comme les bols à mélanger, les cuillères, les moules à pain, les marteaux, les perceuses et les scies) et les fournitures, les choses qui sont consommées dans la procédure (comme le bois, la peinture, l’huile, la farine et les clous). Dans les instructions, ces éléments sont généralement énumérés soit dans une simple liste verticale, soit dans une liste à deux colonnes. Utilisez la liste à deux colonnes si vous devez ajouter des spécifications à certains ou à tous les éléments – par exemple, les noms de marque, les tailles, les quantités, les types, les numéros de modèle, et ainsi de suite.
Discussion des étapes : lorsque vous en arrivez à la rédaction proprement dite des étapes, il y a plusieurs choses à garder à l’esprit : (1) la structure et le format de ces étapes, (2) les informations supplémentaires qui pourraient être nécessaires, et (3) le point de vue et le style général d’écriture.
Structure et format : normalement, nous imaginons un ensemble d’instructions comme étant formaté sous forme de listes verticales numérotées. Et la plupart le sont en fait. Normalement, vous mettez en forme vos instructions réelles étape par étape de cette façon. Il existe cependant quelques variations, ainsi que d’autres considérations :
- Les étapes à ordre fixe sont des étapes qui doivent être exécutées dans l’ordre présenté. Par exemple, si vous changez l’huile dans une voiture, la vidange de l’huile est une étape qui doit venir avant de mettre la nouvelle huile. Ce sont des listes numérotées (généralement, des listes numérotées verticales).
- Les étapes à ordre variable sont des étapes qui peuvent être exécutées dans pratiquement n’importe quel ordre. Les bons exemples sont ces guides de dépannage qui vous disent de vérifier ceci, vérifier cela où vous essayez de réparer quelque chose. Vous pouvez effectuer ce type d’étapes dans pratiquement n’importe quel ordre. Avec ce type, la liste à puces est le format approprié.
- Les étapes alternatives sont celles dans lesquelles deux ou plusieurs façons d’accomplir la même chose sont présentées. Les étapes alternatives sont également utilisées lorsque diverses conditions peuvent exister. Utilisez des listes à puces avec ce type, avec OR inséré entre les alternatives, ou le lead-in indiquant que les alternatives sont sur le point d’être présentées.
- Les étapes imbriquées peuvent être utilisées dans les cas où les étapes individuelles d’une procédure sont plutôt complexes en soi et doivent être décomposées en sous-étapes. Dans ce cas, vous indentez davantage et séquencez les sous-étapes comme a, b, c, et ainsi de suite.
- Les instructions « sans étape ». peuvent être utilisées lorsque vous ne pouvez vraiment pas utiliser une liste verticale numérotée ou fournir une direction directe de style instructionnel au lecteur. Certaines situations doivent être si généralisées ou si variables qu’il est impossible d’énoncer des étapes.
Discussion complémentaire : souvent, il ne suffit pas de dire aux lecteurs de faire ceci ou cela. Ils ont besoin d’informations explicatives supplémentaires telles que l’aspect de la chose avant et après l’étape ; pourquoi ils devraient se soucier de faire cette étape ; quel principe mécanique est derrière ce qu’ils font ; même une explication plus micro-niveau de l’étape-discussion des actions spécifiques qui composent l’étape.
Le problème avec la discussion supplémentaire, cependant, est qu’elle peut cacher l’étape réelle. Vous voulez que l’étape réelle – les actions spécifiques que le lecteur doit prendre – ressorte. Vous ne voulez pas qu’elle soit enfouie dans un tas de mots. Il existe au moins deux techniques pour éviter ce problème : vous pouvez séparer l’instruction du supplément dans des paragraphes distincts ; ou vous pouvez mettre l’instruction en gras.
Writing Style
Placer les étapes clés de l’utilisateur en gras peut être un moyen très utile de signaler clairement ce que le lecteur doit faire. Souvent, le verbe de commande est en gras ; parfois, la police en gras met en évidence l’élément clé abordé.
L’utilisation de la voix passive dans les instructions peut être problématique. Pour une raison étrange, certaines instructions ressemblent à ceci : « Le bouton Pause doit être enfoncé afin d’arrêter temporairement l’affichage. » Non seulement nous nous inquiétons de la santé mentale du bouton Pause, mais nous nous demandons qui est censé appuyer sur ce bouton (les ninjas ?). Il serait plus utile d’indiquer quand le lecteur doit « appuyer sur le bouton Pause ». Prenons cet exemple : « Le bouton de la minuterie est alors réglé sur 3:00. » Là encore, on peut se demander : « est réglé par qui ? Les ninjas ? » La personne qui suit ces instructions peut penser qu’il s’agit simplement d’une référence à un état existant, ou elle peut se demander : « Est-ce qu’ils me parlent ? ». L’utilisation de la troisième personne peut également conduire à une certaine maladresse : « L’utilisateur doit ensuite appuyer sur le bouton Pause. » Les instructions doivent généralement être rédigées à l’aide de formes verbales de commande et en utilisant le « vous » pour rendre parfaitement clair ce que le lecteur doit faire.
Illustrer vos instructions
Peut-être plus que dans toute autre forme d’écriture technique, les graphiques sont cruciaux pour les instructions. Parfois, les mots ne peuvent tout simplement pas expliquer l’étape. Les illustrations sont souvent essentielles à la capacité des lecteurs à visualiser ce qu’ils sont censés faire. Assurez-vous que les graphiques représentent l’image du point de vue du lecteur.
Formater vos instructions
Puisque les gens veulent rarement lire les instructions, mais doivent souvent le faire, formatez vos instructions pour une lisibilité réticente. Essayez de faire en sorte que votre lecteur ait envie de les lire, ou du moins ne soit pas réfractaire à l’idée de les consulter. Un format très lisible permettra aux lecteurs qui ont compris certains aspects des instructions par eux-mêmes de passer directement à la section où ils sont bloqués. Utilisez ce que vous avez appris sur les titres, les listes, les visuels et l’espace passif pour créer des instructions efficaces et lisibles :
Les titres : normalement, vous voudrez des titres pour toute section de contexte que vous pourriez avoir, la section de l’équipement et des fournitures, un titre général pour la section des instructions proprement dite, et des sous-titres pour les tâches ou les phases individuelles au sein de cette section.
Les listes : de même, les instructions font généralement un usage intensif des listes, en particulier des listes verticales numérotées pour les explications pas à pas proprement dites. Les listes verticales simples ou les listes à deux colonnes sont généralement bonnes pour la section sur l’équipement et les fournitures. Les listes en phrases sont bonnes chaque fois que vous donnez un aperçu des choses à venir.
Avis spéciaux : vous devrez peut-être avertir les lecteurs des possibilités dans lesquelles ils peuvent endommager leur équipement, gaspiller les fournitures, faire échouer toute la procédure, se blesser ou blesser d’autres personnes – même gravement ou mortellement. Des entreprises ont été poursuivies pour l’absence de ces avis spéciaux, pour des avis spéciaux mal rédigés ou pour des avis spéciaux mal placés. Voir les avis spéciaux pour une discussion complète sur l’utilisation appropriée de ces avis spéciaux ainsi que sur leur format et leur emplacement dans les instructions.
Lorsque vous relisez et révisez vos instructions, vérifiez qu’elles font ce qui suit :
- Décrire clairement la procédure exacte à expliquer
- Présenter un aperçu du contenu
- Indiquer les besoins du public
- Utiliser divers types de listes lorsque cela est approprié ; en particulier, utilisez des listes numérotées pour les étapes séquentielles
- Utilisez des titres et des sous-titres pour diviser les sections et sous-sections principales dans un ordre logique et cohérent
- Utilisez des avis spéciaux, le cas échéant
- Utilisez des graphiques pour illustrer les actions et les objets clés
- Provisez des explications supplémentaires complémentaires des étapes, le cas échéant
- Créez une section énumérant l’équipement et les fournitures, si nécessaire.
.