Notes :
- Ce chapitre, ainsi que le reste de ce manuel de rédaction technique, se concentre sur compétences en rédaction technique. Le contenu technique ici n'est pas garanti de réussir, d'être précis ou d'être à jour.
- Veuillez cliquer ici pour aider. David McMurrey payez pour l'hébergement web : Faites un don du montant que vous pouvez ! La rédaction technique en ligne restera gratuite.
Le sujet de ce chapitre est l'une des utilisations les plus importantes de l'écriture technique—instructions. Comme vous le savez, instructions Ce sont des explications étape par étape sur la façon de faire quelque chose : comment construire, fonctionner, réparer ou entretenir des choses.
Assurez-vous de jeter un œil au exemples.
Rédiger un ensemble d'instructions pour le travail ou pour un cours de rédaction technique ? Essayez ceci. guide de planification des instructions.
Instructions d'écriture
L'une des utilisations les plus courantes et l'une des plus importantes de l'écriture technique est les instructions—ces explications étape par étape sur la façon de faire des choses : assembler quelque chose, faire fonctionner quelque chose, réparer quelque chose ou effectuer un entretien routinier sur quelque chose. Mais pour quelque chose de si apparemment 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 frustrantes avec des instructions mal écrites. Ce qui suit dans ce chapitre n'est peut-être pas un guide infaillible et à l'abri des erreurs pour écrire des instructions, mais il vous montrera ce que les professionnels considèrent comme les meilleures techniques.
En fin de compte, une bonne rédaction d'instructions nécessite :
- É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, la personne qui essaie d'utiliser vos instructions
- Votre capacité à visualiser la procédure en détail et à capturer cette conscience sur papier.
- Enfin, votre volonté de faire ce petit effort supplémentaire et de tester vos instructions sur le type de personne pour qui vous les avez écrites.
D'ici là, vous avez probablement étudié les titres, les listes et les avis spéciaux—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 quelques avis spéciaux aux points évidents, et c'est fait ! Eh bien, pas tout à fait, mais c'est un excellent 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.
Infographie générée par NotebookLM de ce chapitre
Quelques préliminaires
Au début d'un projet d'écriture 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.
Public et situation. Au début du processus, définissez le public et la situation de vos instructions. N'oubliez pas que définir un public signifie définir son niveau de familiarité avec le sujet ainsi que d'autres détails similaires. Voir la discussion de publics et étapes à suivre pour définir des audiences.
Plus important encore, si vous suivez un cours d'écriture, vous devrez rédiger une description de votre public et l'attacher à vos instructions. Cela permettra à votre instructeur d'évaluer vos instructions en fonction de leur adéquation au public visé. Et n'oubliez pas aussi que dans un cours d'écriture technique, il est préférable d'écrire pour des publics non spécialistes, ce qui constitue un défi beaucoup plus grand pour vous en tant qu'écrivain.
Nombre de tâches. Combien de tâches y a-t-il dans la procédure dont vous parlez ? Utilisons le terme procédure pour se référer à l'ensemble des activités que vos instructions sont censées discuter. Un tâche est un groupe d'actions semi-indépendantes dans la procédure : par exemple, programmer l'horloge d'un micro-ondes est une tâche dans la grande procédure globale d'utilisation d'un micro-ondes.
Une procédure simple comme changer l'huile d'une voiture contient une seule tâche ; il n'y a pas de regroupements semi-indépendants d'activités. Une procédure plus complexe comme utiliser un four à micro-ondes contient de nombreuses tâches semi-indépendantes : régler l'horloge ; régler le niveau de puissance ; utiliser le minuteur ; nettoyer et entretenir le micro-ondes, entre autres. (Le instructions sur l'utilisation d'une caméra sont organisées par tâches.)
Certaines instructions n'ont qu'une seule tâche, mais comportent de nombreuses étapes au sein de cette tâche unique. 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, puis à recommencer à numéroter les étapes à chaque nouvelle phase. A phase alors est un groupe d'étapes similaires au sein d'une procédure de tâche unique. Dans l'exemple du toboggan, mettre en place le cadre serait une phase ; ancrer l'objet dans le sol en serait une autre ; assembler la balançoire en boîte serait encore une autre.
Utilisez une orientation vers les tâches. Concentrez-vous sur les tâches que vos lecteurs souhaitent accomplir ; utilisez des formulations de type comment faire ou –ing dans les titres.
Meilleure approche pour la discussion étape par étape. Une autre considération, que vous ne pouvez peut-être pas déterminer au début, est comment cibler 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 fonctionnalités des outils).
Dans un approche de la tâche (aussi connu sous le nom d'orientation vers la tâche) pour des instructions sur l'utilisation d'un service de réponse téléphonique, vous auriez ces sections :
- enregistrant votre message d'accueil
- lecture de vos messages
- sauvegarder vos messages
- transmettre vos messages
- supprimer vos messages, et ainsi de suite
Ce sont des tâches—les choses typiques que nous aimerions faire avec la machine. Pour une discussion plus approfondie, voir le chapitre sur analyse de tâche.
D'autre part, dans un approche par outils Pour les instructions sur l'utilisation d'un photocopieur, il y aurait ces sections improbables :
- bouton copier
- bouton annuler
- bouton agrandir/réduire
- bouton de collectage/agrafeuse
- bouton de taille de copie, et ainsi de suite
Si vous conceviez un ensemble d'instructions sur ce plan, vous rédigeriez des étapes pour utiliser chaque bouton ou fonctionnalité du photocopieur. Les instructions utilisant cette approche par outils sont difficiles à faire fonctionner. Parfois, le nom du bouton ne correspond pas tout à fait à la tâche qui lui est associée ; parfois, vous devez utiliser plus qu'un seul bouton pour accomplir la tâche. Cela dit, il peut y avoir des moments où l'approche par outils/fonctionnalités peut être préférable.
Groupes de tâches. Lister des tâches peut ne pas être tout ce que vous devez faire. Il peut y avoir tant de tâches que vous devez les regrouper afin que les lecteurs puissent trouver des tâches individuelles plus facilement. Par exemple, les regroupements de tâches suivants sont courants dans les instructions :
- déballage et tâches de configuration
- installation et personnalisation des tâches
- tâches opérationnelles de base
- tâches d'entretien régulier
- tâches de dépannage ; etc.
Sections communes dans les instructions
Les sections suivantes sont un aperçu des parties que vous trouverez couramment dans les instructions. Ne supposez pas que chacune d'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.
En lisant ce qui suit sur les sections communes dans les instructions, consultez le exemple d'instructions.
Vue schématique des instructions. N'oubliez pas que ceci est un modèle typique ou commun pour le contenu et l'organisation—de nombreux autres sont possibles.
Introduction. Planifiez l'introduction de vos instructions avec soin. Assurez-vous qu'elle réalise l'une des choses suivantes (mais pas nécessairement dans cet ordre) qui s'appliquent à vos instructions particulières :
- Indiquez les tâches ou procédures spécifiques à expliquer ainsi que l'étendue de la couverture (ce que ne va pas être couvert).
- Indiquez ce dont le public a besoin en termes de connaissances et de contexte pour comprendre les instructions.
- Donnez une idée générale de la procédure et de ce qu'elle accomplit.
- Indiquez les conditions dans lesquelles ces instructions doivent (ou ne doivent pas) être utilisées.
- Donnez un aperçu du contenu des instructions.
Voir la section sur introductions pour une discussion supplémentaire.
Avertissements généraux, précautions, avis de danger. Les instructions doivent souvent alerter les lecteurs sur la possibilité d'endommager leur équipement, de ratatiner la procédure et de se blesser eux-mêmes. De plus, les instructions doivent souvent souligner des points clés ou des exceptions. Pour ces situations, vous utilisez avis spéciaux—note, avertissement, précaution et avis de danger. Remarquez comment ces avis spéciaux sont utilisés dans les instructions d'exemple énumérées ci-dessus.
Contexte technique ou théorie. Au début de certains types d'instructions (après l'introduction, bien sûr), vous pourriez avoir besoin d'une discussion sur le contexte lié à la procédure. Pour certaines instructions, ce contexte est crucial—sinon, les étapes de la procédure n'ont aucun sens. Par exemple, vous avez peut-être eu une certaine expérience avec ces applets logiciels dans lesquelles vous définissez vos propres couleurs en déplaçant des barres de défilement rouge, verte et bleue. Pour vraiment comprendre ce que vous faites, vous devez avoir des connaissances sur la couleur. De même, vous pouvez imaginer que, pour certaines instructions utilisant des caméras, une certaine 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 inclut équipement, les outils que vous utilisez dans la procédure (comme les bols à mélanger, cuillères, moules à pain, marteaux, perceuses et scies) et fournitures, les choses qui sont consommées dans la procédure (comme du bois, de la peinture, de l'huile, de la farine et des clous). Dans les instructions, celles-ci sont généralement énumérées 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 articles—par exemple, des marques, des tailles, des quantités, des types, des numéros de modèle, etc.
Discussion des étapes. Lorsque vous en arrivez à la rédaction 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 d'écriture général.
Structure et format. Normalement, nous imaginons un ensemble d'instructions étant formaté sous forme de listes numérotées verticales. Et la plupart le sont en effet. Normalement, vous formatez vos instructions étape par étape de cette manière. Cependant, il existe certaines variations ainsi que d'autres considérations :
- Étapes en ordre fixe sont des étapes qui doivent être effectuées dans l'ordre présenté. Par exemple, si vous changez l'huile d'une voiture, vidanger 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).
- Étapes à ordre variable sont des étapes qui peuvent être effectuées dans pratiquement n'importe quel ordre. De bons exemples sont ces guides de dépannage qui vous disent de vérifier ceci, de vérifier cela lorsque vous essayez de réparer quelque chose. Vous pouvez faire ce genre d'étapes dans pratiquement n'importe quel ordre. Avec ce type, la liste à puces est le format approprié.
- Étapes alternatives sont ceux dans lesquels deux ou plusieurs façons d'accomplir la même chose sont présentées. Des étapes alternatives sont également utilisées lorsque diverses conditions peuvent exister. Utilisez des listes à puces avec OR inséré entre les alternatives, ou l'introduction indiquant que des alternatives vont être présentées.
- Étapes imbriquées. Dans certains cas, des é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, vous indentez davantage et séquencez les sous-étapes sous forme de a, b, c, etc.
- "Sans étapes" instructions. Et enfin, il existe des instructions qui ne peuvent vraiment pas utiliser de liste verticale numérotée et qui peu ou pas dirigent le lecteur de manière claire et directe. Certaines situations doivent être si généralisées ou si variables que les étapes ne peuvent pas être énoncées.
Voir le chapitre sur listes pour le style et le format de ces possibilités.
Discussion complémentaire. Souvent, il ne suffit pas de dire simplement aux lecteurs de faire ceci ou cela. Ils ont besoin d'informations explicatives supplémentaires telles que l'apparence de la chose avant et après l'étape ; pourquoi ils devraient se soucier de réaliser cette étape ; quel principe mécanique est à l'œuvre dans ce qu'ils font ; une explication encore plus détaillée 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 entreprendre—se démarque. Vous ne voulez pas que tout soit enfoui sous une tonne de mots. Il existe au moins deux techniques pour éviter ce problème : vous pouvez séparer l'instruction du supplément en paragraphes distincts ; ou vous pouvez mettre l'instruction en gras.
Mettre en gras les étapes réelles des utilisateurs dans les instructions. Le texte en gras aide à distinguer l'action réelle des informations supplémentaires.
Évitez l'écriture télégraphique—en omettant les articles "compris" (le, la, un). Certes, les robots écrivent de cette façon, mais nous n'avons pas à le faire.
Style d'écriture. La manière dont vous rédigez effectivement des instructions, phrase par phrase, peut sembler contradictoire à ce que des cours d'écriture précédents vous ont enseigné. Cependant, remarquez comment "les instructions du monde réel" sont écrites—elles utilisent beaucoup d'écriture impérative (commandement, ou adresse directe) ; elles utilisent beaucoup de "vous." C'est tout à fait approprié. Vous voulez attirer l'attention de votre lecteur, capter son plein intérêt. Pour cette raison, les phrases de style instruction ressemblent à ceci : "Maintenant, appuyez sur le bouton Pause sur le panneau avant pour arrêter l'affichage temporairement" et "Vous devez faire attention à ne pas ..."
Un problème particulier concerne l'utilisation de la voix passive dans les instructions. 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 pour la santé mentale du bouton Pause, mais nous nous demandons qui est censé enfoncer ce truc (vous me parlez ?). Ou considérez cet exemple : "Le bouton Timer est alors réglé sur 3:00." Encore une fois, en tant que personne suivant ces instructions, vous pourriez le manquer ; vous pourriez penser qu'il s'agit simplement d'une référence à un état existant, ou vous pourriez vous demander, "Me parlent-ils ?" Presque aussi mauvais est l'utilisation de la troisième personne : "L'utilisateur doit alors appuyer sur le bouton Pause." Encore une fois, c'est le vieux double-prise : vous regardez autour de vous et vous vous demandez, "Moi ?" (Pour plus de détails, voir problème de voix passive.)
Un autre des problèmes typiques de style d'écriture dans les instructions est que les gens semblent vouloir omettre les articles : "Appuyez sur le bouton Pause sur le panneau avant pour arrêter temporairement l'affichage des informations" ou "Terrestre, 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, veillez à inclure tous les articles (a, un, le) et d'autres mots similaires 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 de visualiser ce qu'ils sont censés faire.
Dans un cours de rédaction technique, les instructions peuvent exiger que vous incluiez 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 à des graphiques qui conviendraient à vos instructions particulières, et que vous ne vous sentez pas très confiant dans vos capacités artistiques. Il existe des moyens de surmonter ces problèmes ! Jetez un œil aux suggestions dans graphismes. 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
Titres. Dans vos instructions, utilisez bien les titres. Normalement, vous voudriez des titres pour toute section de contexte que vous pourriez avoir, la section sur l'équipement et les fournitures, un titre général pour la section des instructions proprement dite, et des sous-titres pour les tâches ou phases individuelles dans cette section. Regardez les exemples au début de ce chapitre. Voir titres pour des 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 étape par étape. Des listes verticales simples ou des listes à deux colonnes sont généralement bonnes pour la section équipement et fournitures. Les listes en phrase sont utiles chaque fois que vous donnez un aperçu des choses à venir. Voir listes pour des exigences communes.
Avis spéciaux. Dans les instructions, vous devez alerter les lecteurs sur les possibilités où ils pourraient endommager leur équipement, gaspiller des fournitures, faire échouer l'ensemble de la procédure, se blesser eux-mêmes ou autrui—même gravement ou mortellement. Des entreprises ont été poursuivies pour 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 avis spéciaux pour une discussion complète sur l'utilisation appropriée de ces avis spéciaux ainsi que leur format et leur placement dans les instructions.
Numéro, abréviations et symboles. Les instructions utilisent également de nombreux chiffres, abréviations et symboles. Pour directives sur ces domaines.
Retrait des avis dans les instructions. Dans le premier exemple, remarquez comment l'avis est indenté vers le texte de l'étape précédente. Dans le deuxième exemple, notez que l'avertissement sévère est placé au début, avant chacune des étapes.
Instructions de invites IA
Les listes de contrôle, qui restent généralement non lues, peuvent être utilisées comme source pour des invites d'IA avec quelques modifications. Copiez ce qui suit, collez-le dans un système d'IA tel que Gemini de Google, et voyez ce que vous avez peut-être manqué.
Remarque : Toutes les références au contenu, au format, au style des instructions ou à leurs composants peuvent être trouvées dans le manuel de rédaction technique en ligne.
Lorsque vous souhaitez utiliser l'IA pour évaluer un projet d'écriture, présentez-vous, indiquez à l'IA qui vous êtes, ce que vous souhaitez. Donnez à l'IA un point de référence pour effectuer des évaluations, comme un manuel en ligne. Ensuite, publiez ce que vous voulez que l'IA vérifie dans son évaluation.
Modifiez l'introduction pour qu'elle corresponde à votre identité.
|
Instructions de Prompts IA Bonjour, IA. Je demande que vous évaluiez des instructions rédigées par un étudiant en deuxième année de collège aux États-Unis. Ci-dessous se trouve un résumé des chapitres de manuel sur instructions et avis pour servir de base à votre évaluation. (Informations d'identification masquées) :
|
Informations connexes
Quiz de lecture. Utilisez ce quiz pour tester votre compréhension de ce chapitre.
Quiz : grammaire, usage, ponctuation.
Comment puis-je créer des manuels d'instructions efficaces ?
Le coût caché de si intuitif qu'il n'a pas besoin de mode d'emploi.
Les manuels d'exploitation contribuent-ils à la performance des entreprises ?
Comment écrire des instructions. techscribe
J'apprécierais vos pensées, réactions, critiques concernant ce chapitre : votre réponse—David McMurrey.
