Remarques:
- 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 fourni ici n'est pas garanti comme étant efficace, exact ou à jour.
- Veuillez cliquer ici pour aider David McMurrey payer 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 la rédaction technique—instructions. Comme vous le savez, instructions sont-ce ces explications étape par étape sur la façon de faire quelque chose: comment construire, utiliser, réparer ou entretenir des choses.
Assurez-vous de consulter le 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 les plus importantes de la rédaction technique est instructions—ces explications étape par étape sur la manière de faire les choses: assembler quelque chose, utiliser quelque chose, réparer quelque chose, ou effectuer l'entretien courant de quelque chose. Mais pour quelque chose apparemment si facile et intuitif, les instructions font partie des documents les plus mal rédigés que l'on puisse trouver. Comme moi, vous avez probablement eu de nombreuses expériences exaspérantes avec des instructions mal rédigées. Ce qui suit dans ce chapitre n'est peut-être pas un guide infaillible, à l'épreuve des erreurs, pour rédiger des instructions, mais il vous montrera ce que les professionnels considèrent comme les meilleures techniques.
En fin de compte, la rédaction d'instructions de qualité 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 de manière très détaillée et à consigner cette compréhension sur papier
- Enfin, votre volonté d'aller plus loin et de tester vos instructions sur le type de personne pour laquelle vous les avez écrites.
À ce stade, vous avez probablement étudié les titres, les listes et les avis spéciaux—rédiger un ensemble d'instructions avec ces outils vous paraît probablement évident. Il suffit de scinder la discussion en listes verticales numérotées, d'ajouter quelques avis spéciaux aux endroits évidents et le tour est joué ! Eh bien, pas tout à fait, mais c'est un excellent début. Ce chapitre explore quelques-unes 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 de rédaction d'instructions, il est important de déterminer la structure ou les caractéristiques de la procédure particulière dont vous allez écrire.
Public et situation. Au début du processus, définissez le public et le contexte 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 de ce type. Voir la discussion de audiences et des étapes à suivre pour définir des audiences.
Surtout, si vous suivez un cours d'écriture, vous devrez rédiger une description de votre public et l'annexer à vos consignes. Cela permettra à votre enseignant d'évaluer vos consignes quant à leur adéquation au 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écialistes—cela constitue un défi bien plus important 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 désigner l'ensemble des activités que vos instructions sont destinées à aborder. A tâche est un groupe d'actions semi-indépendant au sein de la procédure : par exemple, régler l'horloge d'un four à micro-ondes est une tâche dans la procédure globale d'utilisation d'un four à micro-ondes.
Une procédure simple comme changer l'huile d'une voiture ne comporte qu'une seule tâche ; il n'y a pas de regroupements d'activités semi-indépendantes. Une procédure plus complexe comme l'utilisation d'un four à micro-ondes comprend de nombreuses tâches semi-indépendantes : régler l'horloge ; régler le niveau de puissance ; utiliser la minuterie ; nettoyer et entretenir le four à micro-ondes, entre autres. (Le instructions pour utiliser un appareil photo sont organisés par tâches.)
phase ensuite est un groupe d'étapes similaires au sein d'une procédure mono-tâche. Dans l'exemple du portique de balançoires, monter la structure serait une phase; ancrer l'ensemble dans le sol serait une autre; assembler la balançoire en boîte serait encore une autre.
Adoptez une orientation axée sur les tâches. Concentrez-vous sur les tâches que vos lecteurs veulent accomplir; utilisez la formulation « 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 dès le début, est la façon de 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 connue sous le nom d'orientation vers la tâche) aux instructions sur l'utilisation d'un service de réponse téléphonique, vous auriez ces sections :
- enregistrement de votre salutation
- rejouer vos messages
- sauvegarde de vos messages
- faire suivre 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 une discussion plus approfondie, voir le chapitre sur analyse des tâches.
D'autre part, dans un approche des outils pour des instructions sur l'utilisation d'une photocopieuse, il y aurait ces sections improbables :
- bouton de copie
- bouton annuler
- bouton agrandir/réduire
- regrouper/agrafer bouton
- bouton copier la taille, et ainsi de suite
Si vous conceviez un ensemble d'instructions selon ce plan, vous rédigeriez des étapes pour utiliser chaque bouton ou fonctionnalité du photocopieur. Les instructions basées sur 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, il faut utiliser plus d'un bouton pour accomplir la tâche. Pourtant, il peut y avoir des moments où l'approche outils/fonctionnalité peut être préférable.
Groupes de tâches. La simple énumération des tâches peut ne pas suffire. Il peut y avoir tellement de tâches que vous devez les regrouper pour que les lecteurs puissent trouver plus facilement chacune d'elles. Par exemple, les regroupements de tâches suivants sont courants dans les instructions :
- tâches de déballage et d'installation
- installation et personnalisation des tâches
- tâches opérationnelles de base
- tâches d'entretien de routine
- tâches de dépannage; et ainsi de suite
Sections communes dans les instructions
Ce qui suit est un aperçu des sections que vous trouverez couramment dans les instructions. Ne supposez pas que chacune d'entre elles doit ni qu'elles figurent 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.
En lisant ce qui suit sur les sections courantes dans les instructions, consultez le exemples d'instructions.
Vue schématique des instructions. N'oubliez pas que ceci est un modèle typique ou courant pour les contenus et l'organisation—beaucoup d'autres sont possibles.
Introduction. Planifiez soigneusement l'introduction de vos instructions. Assurez-vous qu'elle fasse l'une des choses suivantes (mais pas nécessairement dans cet ordre) qui s'appliquent à vos instructions particulières :
- Indiquez les tâches spécifiques ou la procédure à expliquer ainsi que l'étendue de la couverture (ce que ne ... pas être couvert).
- Indiquez quels prérequis, en termes de connaissances et d'expérience, le public doit avoir 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 ultérieure.
Avertissement général, mise en garde, avis de danger. Les instructions doivent souvent avertir les lecteurs de la possibilité d'endommager leur équipement, de compromettre la procédure et de se blesser. De plus, les instructions doivent souvent mettre l'accent sur des points clés ou des exceptions. Pour ces situations, vous utilisez avis spéciaux—notes, avertissements, mises en garde et avis de danger. Remarquez comment ces avis spéciaux sont utilisés dans les instructions d'exemple listées ci-dessus.
Contexte technique ou théorie. Au début de certains types d'instructions (après l'introduction, bien sûr), il peut être nécessaire d'inclure une discussion du 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à eu de l'expérience avec ces applets logiciels dans lesquels vous définissez vos propres couleurs en faisant glisser des curseurs rouge, vert et bleu. Pour vraiment comprendre ce que vous faites, il faut avoir quelques notions sur la couleur. De même, on peut imaginer que, pour certaines instructions utilisant des appareils photo, une certaine théorie pourrait également être nécessaire.
Équipement et fournitures. Remarquez que la plupart des instructions incluent une liste des éléments que vous devez rassembler avant de commencer la procédure. Cela inclut équipement, les outils que vous utilisez dans la procédure (tels que des bols à mélanger, des cuillères, des moules à pain, des marteaux, des perceuses et des scies) et 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, 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 éléments—par exemple, noms de marque, tailles, quantités, types, numéros de modèle, et ainsi de suite.
Discussion des étapes. Lorsque vous passez à la rédaction effective des étapes, il y a plusieurs points à garder à l'esprit : (1) la structure et le format de ces étapes, (2) les informations complémentaires qui pourraient être nécessaires, et (3) le point de vue ainsi que le style d'écriture général.
Structure et format. Normalement, nous imaginons un ensemble d'instructions formaté comme des listes numérotées verticales. Et la plupart le sont en effet. Normalement, vous formatez vos instructions réelles étape par étape de cette façon. Il existe cependant quelques variations, ainsi que d'autres considérations:
- Étapes d'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 viennent avant de mettre la nouvelle huile. Ce sont des listes numérotées (généralement, des listes numérotées verticales).
- Étapes d'ordre variable Ce 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, vérifier cela lorsque vous essayez de réparer quelque chose. Vous pouvez effectuer ce genre d'étapes dans pratiquement n'importe quel ordre. Avec ce type, la liste à puces est le format approprié.
- Étapes alternatives sont celles dans lesquelles deux façons ou plus 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 pour ce type, avec OU inséré entre les alternatives, ou une phrase d'introduction indiquant que des alternatives vont ê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, vous les indentez davantage et séquencez les sous-étapes a, b, c, et ainsi de suite.
- "Stepless" instructions. Et enfin il existe des instructions qui ne peuvent vraiment pas utiliser une liste verticale numérotée et qui n'orientent guère, voire pas du tout, le lecteur de façon pédagogique et directive. Certaines situations doivent être si généralisées ou si variables que l'on ne peut pas énoncer d'étapes.
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 à quoi la chose devrait ressembler avant et après l'étape; pourquoi ils devraient se soucier de réaliser cette étape; quel principe mécanique se cache derrière ce qu'ils font; une explication encore plus détaillée, au niveau micro, 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 masquer l'étape réelle. Vous voulez que l'étape réelle—les actions spécifiques que le lecteur doit entreprendre—ressorte. Vous ne voulez pas que tout soit enfoui dans un amas 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 de l'utilisateur dans les instructions. Le texte en gras aide à distinguer l'action réelle des informations complémentaires.
Évitez l'écriture télégraphique—en omettant les articles "sous-entendus" (the, a, an). Certes, les robots écrivent ainsi, mais nous n'avons pas à le faire.)
Style d'écriture.
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, veillez à inclure tous les articles (un, 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 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 déterminantes pour la capacité des lecteurs à visualiser ce qu'ils sont censés faire.
Dans un cours de rédaction technique, les consignes peuvent exiger que vous incluiez des illustrations ou d'autres types de graphiques—ce que l'on utiliserait normalement dans les consignes. Le problème, bien sûr, peut être que vous n'avez pas accès à des graphiques adaptés à vos consignes particulières, et que vous ne vous sentez pas très confiant quant à vos capacités artistiques. Il existe des moyens de surmonter ces problèmes ! Consultez les suggestions dans graphismes. Dans ce chapitre, vous verrez non seulement des suggestions pour créer des graphiques, mais aussi des exigences concernant leur format.
Mise en forme dans les instructions
Titres. Dans vos instructions, utilisez judicieusement les titres. Normalement, vous voudriez des titres pour toute section de contexte que vous pourriez avoir, la section équipement et fournitures, un titre général pour la section des instructions proprement dites, et des sous-titres pour les tâches individuelles ou les phases au sein de cette section. Consultez les exemples au début de ce chapitre. Voir titres pour des exigences courantes.
Listes. De même, les instructions font généralement un usage intensif des listes, en particulier des listes numérotées verticales pour les explications étape par étape. Les listes verticales simples ou les listes à deux colonnes conviennent généralement pour la section sur l'équipement et les fournitures. Les listes intégrées dans une phrase sont utiles chaque fois que vous donnez un aperçu des éléments à venir. Voir listes pour des exigences courantes.
Avis spéciaux. Dans les instructions, vous devez avertir les lecteurs des possibilités selon lesquelles ils peuvent endommager leur équipement, gaspiller des fournitures, faire échouer l'ensemble de la procédure, se blesser eux-mêmes ou blesser d'autres—voire gravement ou mortellement. Des entreprises ont été poursuivies en justice pour absence de ces avis particuliers, pour des avis particuliers mal rédigés, ou pour des avis particuliers mal placés. Voir avis spéciaux pour une discussion complète de la bonne utilisation de ces avis spéciaux ainsi que de leur format et de leur placement au sein des instructions.
Nombre, abréviations et symboles. Les instructions utilisent également de nombreux chiffres, d'abréviations et de symboles. Pour lignes directrices dans ces domaines.
Indentation des remarques dans les instructions. Dans le premier exemple, remarquez comment la notice est indentée à la 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 n'importe laquelle des étapes.
Invites d'IA pour les instructions
Les checklists, qui restent généralement non lues, peuvent être utilisées comme source d'invites pour l'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 pu manquer.
Remarque : Toutes les références au contenu, au format, au style des instructions ou à leurs composants se trouvent dans le manuel de rédaction technique en ligne.
Lorsque vous voulez utiliser l'IA pour évaluer un projet d'écriture, présentez-vous, dites à l'IA qui vous êtes et ce que vous voulez. Donnez à l'IA un point de référence pour effectuer les évaluations, comme un manuel en ligne. Ensuite, publiez ce que vous voulez que l'IA vérifie dans son évaluation.
Adaptez l'introduction à votre identité.
|
Instructions pour les invites d'IA Bonjour, IA. Je vous demande d'évaluer des instructions rédigées par un étudiant américain en deuxième année d'université. Ci-dessous se trouve un résumé de chapitres de manuel sur instructions et avis à utiliser comme base de votre évaluation. (Informations d'identification masquées):
|
Informations connexes
Quiz de lecture. Utilisez ce quiz pour tester votre compréhension de ce chapitre.
Tests : grammaire, usage, ponctuation.
Comment puis-je créer des manuels d'instructions efficaces
Le coût caché d'être tellement intuitif qu'il n'a pas besoin de manuel
Les manuels d'exploitation contribuent-ils à la performance de l'entreprise?
Comment rédiger des instructions. scribe technologique
J'apprécierais vos réflexions, réactions et critiques concernant ce chapitre: votre réponse—David McMurrey.
