Instructions

Le point central de ce chapitre est l’une des plus importantes de toutes les utilisations de la rédaction technique – les instructions. Comme vous le savez, les instructions sont ces explications étape par étape de la façon de faire quelque chose : comment construire, faire fonctionner, réparer ou entretenir des choses.

Ne manquez pas de consulter les exemples.

Écrire des instructions

L’une des utilisations les plus courantes et l’une des plus importantes de la rédaction technique sont les instructions – ces explications étape par étape de la façon de faire quelque chose : assembler quelque chose, faire fonctionner quelque chose, réparer quelque chose ou faire l’entretien courant de quelque chose. Mais pour quelque chose d’apparemment si facile et intuitif, les instructions sont parmi les documents les plus mal écrits que vous puissiez trouver. Comme moi, vous avez probablement eu de nombreuses expériences exaspérantes avec des instructions mal écrites. Ce qui suit dans ce chapitre ne sera peut-être pas un guide infaillible et infaillible de la rédaction d’instructions, mais il vous montrera ce que les professionnels considèrent comme les meilleures techniques.

En définitive, une bonne rédaction d’instructions nécessite :

• Une écriture claire et simple
• Une compréhension approfondie de la procédure dans tous ses détails techniques
• Votre capacité à vous mettre à la place du lecteur, de la personne qui essaie d’utiliser vos instructions
• Votre capacité à visualiser la procédure dans ses moindres détails et à capturer cette conscience sur le papier
• Enfin, votre volonté d’aller plus loin et de tester vos instructions sur le type de personne pour laquelle vous les avez écrites.

À présent, vous avez probablement étudié les titres, les listes et les notices spéciales – rédiger un ensemble d’instructions avec ces outils semble probablement évident. Il suffit de diviser la discussion en listes verticales numérotées et d’ajouter des avis spéciaux aux endroits évidents, et le tour est joué ! Enfin, pas tout à fait, mais c’est un bon début. Ce chapitre explore certaines des caractéristiques des instructions qui peuvent les rendre plus complexes. Vous pouvez à votre tour utiliser ces considérations pour planifier vos propres instructions.

Quelques préliminaires

Au début d’un projet de rédaction 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.

Audience et situation. 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 son niveau de familiarité avec le sujet ainsi que d’autres détails de ce type. Voir la discussion sur les publics et les étapes à suivre pour définir les publics.

Plus important encore, si vous suivez un cours de rédaction, vous devrez rédiger une description de votre public et la joindre à vos instructions. Cela permettra à votre instructeur d’évaluer vos instructions en fonction de leur adéquation avec le public visé. N’oubliez pas non plus que dans un cours de rédaction technique, il est préférable d’écrire pour des publics non spécialisés – ce qui représente un défi beaucoup plus grand pour vous en tant que rédacteur.

Nombre de tâches. Combien de tâches y a-t-il dans la procédure sur laquelle vous écrivez ? Utilisons le terme procédure pour désigner l’ensemble des activités que vos instructions sont censées aborder. 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 le changement d’huile dans 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 beaucoup de ces 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. (Les instructions sur l’utilisation d’un appareil photo sont organisées par tâches.)

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.

La meilleure approche de la discussion étape par étape. Une autre considération, que peut-être vous ne pouvez pas déterminer au début, est de savoir comment concentrer vos instructions. 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 par tâche (é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
• reproduire vos messages
• enregistrer vos messages
• transférer vos messages
• supprimer vos messages, et ainsi de suite

Ce sont des tâches – les choses typiques que nous voudrions faire avec la machine. Pour plus de détails, voir le chapitre sur l’analyse des tâches.

En revanche, dans une approche outils des instructions d’utilisation d’une photocopieuse, il y aurait ces sections improbables :

• 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 fonctionnalité 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.

Groupements de tâches. L’énumération 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 afin que les lecteurs puissent trouver plus facilement les tâches individuelles. Par exemple, voici des regroupements de tâches courants dans les instructions :

1. Tâches de déballage et de configuration
2. Tâches d’installation et de personnalisation
3. Tâches d’exploitation de base
4. Tâches de maintenance routinière
5. Tâches de dépannage ; et ainsi de suite

Sections communes dans les instructions

Ce qui suit est une revue des sections que vous trouverez couramment dans les instructions. Ne supposez pas que chacune d’entre elles doit être dans les instructions réelles que vous écrivez, ni qu’elles doivent être dans l’ordre présenté ici, ni que ce sont les seules sections possibles dans un ensemble d’instructions.

Alors que vous lisez ce qui suit sur les sections courantes dans les instructions, consultez les exemples d’instructions.

Vue schématique des instructions. N’oubliez pas qu’il s’agit d’un modèle typique ou commun pour le contenu et l’organisation – de nombreux autres sont possibles.

Introduction. Planifiez soigneusement l’introduction de vos instructions. Assurez-vous qu’elle fait l’une ou l’autre des choses suivantes (mais pas nécessairement dans cet ordre) qui s’appliquent à vos instructions particulières :

• Indique les tâches ou la procédure spécifiques à expliquer ainsi que l’étendue de la couverture (ce qui ne sera pas couvert).
• Indique 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 doivent (ou ne doivent pas) être utilisées.
• Donner un aperçu du contenu des instructions.

Voir la section sur les introductions pour une discussion plus approfondie.

Avertissement général, mise en garde, 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, bien sûr), 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 caméras, un peu de théorie pourrait être nécessaire également.

É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 un OU inséré entre les alternatives, ou le lead-in indiquant que des alternatives sont sur le point d’être présentées.
• Étapes imbriquées. Dans certains cas, les étapes individuelles d’une procédure peuvent être assez complexes en elles-mêmes et doivent être décomposées en sous-étapes. Dans ce cas, on indente davantage et on séquence les sous-étapes comme a, b, c, et ainsi de suite.
• Instructions « sans étapes ». Et enfin, il existe des instructions qui ne peuvent vraiment pas utiliser la liste verticale numérotée et qui ne font que peu, voire pas du tout, d’orientation directe de style instructionnel pour le lecteur. Certaines situations doivent être tellement généralisées ou tellement variables que les étapes ne peuvent être énoncées.

Voir le chapitre sur les listes pour le style et le format de ces possibilités.

Discussion complémentaire. Souvent, il ne suffit pas de dire aux lecteurs de faire ceci ou de faire cela. Ils ont besoin d’informations explicatives supplémentaires telles que la façon dont la chose devrait ressembler 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 que tout cela soit enterré 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.

Mettre en gras les étapes réelles de l’utilisateur dans les instructions. Le texte en gras permet de distinguer l’action réelle des informations supplémentaires.

Le style d’écriture. La façon dont vous rédigez réellement les instructions, phrase par phrase, peut sembler contradictoire avec ce que les cours d’écriture précédents vous ont appris. Cependant, remarquez comment les instructions du  » monde réel  » sont rédigées – elles utilisent beaucoup de types d’écriture impérative (commandement, ou adresse directe) ; elles utilisent beaucoup de  » vous « . C’est tout à fait approprié. Vous voulez vous adresser à votre lecteur, attirer son attention. C’est pourquoi les phrases de type instruction ressemblent à celles-ci : « Maintenant, appuyez sur le bouton Pause sur le panneau avant pour arrêter temporairement l’affichage » et « Vous devez faire attention à ne pas… »

Un problème particulier concerne l’utilisation de la voix passive dans les instructions. Pour une raison bizarre, certaines instructions ressemblent à ceci : « Le bouton Pause doit être enfoncé afin d’arrêter temporairement l’affichage. » Non seulement on s’inquiète de la santé mentale du bouton Pause, mais on se demande qui est censé appuyer sur ce truc (c’est à moi que vous parlez ?). Ou considérez cet exemple : « Le bouton Timer est ensuite réglé sur 3:00. » Là encore, en tant que personne qui suit ces instructions, vous pouvez passer à côté ; vous pouvez penser qu’il s’agit simplement d’une référence à un état existant, ou vous pouvez vous demander : « Est-ce qu’ils me parlent ? ». L’utilisation de la troisième personne est presque aussi mauvaise : « L’utilisateur doit ensuite appuyer sur le bouton Pause. » Là encore, c’est l’habituel double regard : vous regardez la pièce et vous vous demandez « Qui moi ? ». (Pour plus de détails, voir le problème de la voix passive.)

Un autre des problèmes typiques du style d’écriture dans les instructions est que les gens semblent vouloir omettre les articles : « Appuyez sur le bouton Pause du panneau avant pour arrêter temporairement l’affichage des informations » ou « Terrien, veuillez fournir l’adresse de la pizzeria la plus proche. » Pourquoi faisons-nous cela ? Voulons-nous tous secrètement être des robots ? Quoi qu’il en soit, assurez-vous d’inclure tous les articles (a, un, le) et d’autres mots de ce type que nous utiliserions normalement dans des instructions.

Graphiques dans les instructions

Probablement plus que dans toute autre forme d’écriture (sauf peut-être pour les bandes dessinées), 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.

Dans un cours de rédaction technique, les instructions peuvent vous demander d’inclure des illustrations ou d’autres types de graphiques – tout ce qui serait normalement utilisé dans les instructions. Le problème, bien sûr, peut être que vous n’avez pas accès aux graphiques qui conviendraient à vos instructions particulières et que vous n’avez pas une grande confiance dans vos capacités artistiques. Il existe des moyens de surmonter ces problèmes ! Jetez un coup d’œil aux suggestions du chapitre sur les graphiques. Dans ce chapitre, vous verrez non seulement des suggestions pour créer des graphiques, mais aussi des exigences sur leur format.

Format dans les instructions

En-têtes. Dans vos instructions, faites un bon usage des 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 dites, et des sous-titres pour les tâches ou les phases individuelles dans cette section. Jetez un coup d’œil aux exemples au début de ce chapitre. Voir les rubriques pour les exigences communes.

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 réelles étape par étape. 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. Voir les listes pour les exigences communes.

Avis spéciaux. Dans les instructions, vous devez avertir les lecteurs des possibilités dans lesquelles ils peuvent endommager leur équipement, gaspiller les fournitures, faire échouer l’ensemble de la procédure, se blesser ou blesser d’autres personnes – même gravement ou mortellement. Des entreprises ont été poursuivies en justice pour l’absence de ces avis spéciaux, pour des avis spéciaux mal rédigés ou pour des avis spéciaux qui n’étaient pas à leur place. 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.

Indentation des notices dans les instructions. Dans le premier exemple, remarquez comment la notice est en retrait par rapport au texte de l’étape précédente. Dans le deuxième exemple, remarquez que l’avis sévère est placé au début avant toute étape.

Nombre, abréviations et symboles. Les instructions utilisent également beaucoup de chiffres, d’abréviations et de symboles. Pour des directives sur ces domaines.

Liste de contrôle de la révision des instructions

Lorsque vous relisez et révisez vos instructions, faites attention aux problèmes tels que les suivants :

• Veuillez vous assurer que vous fournissez de véritables instructions – des explications sur la façon de construire, d’utiliser ou de réparer quelque chose.
• Rédigez une bonne introduction-dans celle-ci, indiquez la procédure exacte à expliquer, indiquez les exigences du public et donnez un aperçu du contenu.
• Veillez à utiliser les différents types de listes chaque fois que cela est approprié. En particulier, utilisez des listes verticales numérotées pour les étapes séquentielles.
• Utilisez des titres pour délimiter toutes les sections principales et des sous-titres pour les sous-sections. (Rappelez-vous qu’aucun titre « Introduction » n’est nécessaire entre le titre et le premier paragraphe. N’oubliez pas de ne pas utiliser les titres de premier niveau dans ce devoir ; commencez par le deuxième niveau.)
• Utilisez les notices spéciales comme il convient.
• Veillez à utiliser le style et le format pour tous les titres, listes, notices spéciales et graphiques tels que présentés dans ces chapitres. Si cela pose un problème, contactez votre instructeur.
• Utilisez des graphiques pour illustrer toute action ou objet clé.
• Fournissez des explications supplémentaires complémentaires des étapes, si nécessaire.
• N’oubliez pas de créer une section énumérant l’équipement et les fournitures, si nécessaire.

J’apprécierais vos pensées, réactions, critiques concernant ce chapitre : votre réponse-David McMurrey.