Comment rédiger des procédures par Richard Coulombe

1. Rédiger des
[bonnes] procédures
par Richard Coulombe

2. Anecdote
Souvent, lorsqu’une personne me demande quel est mon travail et que
je dis que je suis rédacteur technique, pour qu’ils saisissent en quoi
cela consiste, je leur spécifie que je rédige des guides de l’utilisateur.
Leur réplique est, presqu’invariablement : “Ah, oui, les instructions
qu’on ne comprends pas !”
À quoi je répond : “Les miennes, on les comprend.”

3. La procédure est un des types d’information, ou de
sujets, qui font partie d’une documentation technique.

4. Quels sont les différents types de sujets ?
• Concept
• Définition
• Référence
• Procédure

5. Anecdote
Je pratique le ski alpin, mais enfant je n’étais pas très habile.
Adolescent, je suis devenu instructeur de ski.
J’ai appris que le ski est une activité complexe qu’on peut décrire en un
enchaînement de mouvements.
Ces mouvements peuvent être découpés en exercices pour montrer
comment les exécuter afin de développer les habiletés et les enchaîner
fluidement.

6. Qu’est-ce qu’une procédure ?
• Outil pédagogique de transfert de connaissance
• Suite logique d’étapes qui composent une tâche
• Un algorithme

7. Anecdote
Au début de ma vie professionnelle, j’étais graphiste. Mon domaine de travail s’est
informatisé.
Un ami, professeur d’électro-technique au CÉGEP, a voulu m’enseigner à utiliser
un ordinateur avec interface graphique pour effectuer mon travail, mais sans grand
succès. Je n’arrivais pas à saisir le mode de fonctionnement de l’interface.
Puis, j’ai suivi des cours du soir sur le graphisme informatique.
Mon professeur m’a appris des concepts fondamentaux, qui se présentent sous la
forme d’outils et de commandes dans les interfaces graphiques, qui m’ont
rapidement permis d’utiliser efficacement les logiciels de dessin vectoriel, de
traitement d’images, de graphisme et de traitement de texte.

8. Anecdote
Je me suis servi de cette expérience dès que j’ai débuté en rédaction
technique.
• Lors de mes premiers contacts avec un produit, appareil ou logiciel à
documenter, je prend note des concepts, des notions, des définitions
que je dois acquérir pour bien comprendre, les questions que je me
suis posé et des difficultés que j’ai surmonté
• Lorsque je rédige les procédures et les autres sujets qui constituent la
documentation, je m’assure que tous les éléments pris en note sont
inclus dans le contenu

9. Quels objectifs
une procédure doit-elle atteindre ?
• Facile à comprendre
• Suffisamment précise
• Permettre d’exécuter et de réussir la tâche
• Donner à l’utilisateur toute l’information dont il a besoin
• Répondre aux questions de l’utilisateur
• Anticiper les difficultés, fournir des solutions
• Donner les choix selon les situations qui peuvent se présenter

10. Anecdote
Au début de ma carrière de rédacteur technique, je lisais régulièrement
la revue trimestrielle Technical Communication de la Society for
Technical Communication.
Un jour, j’ai lu un article de David K. Farkas sur les procédures qui a été
pour moi une sorte d’épiphanie. Son titre : “The Logical and Rhetorical
Construction of Procedural Discourse.”
Cet article décrit comment structurer efficacement un procédure.

11. Types de procédures
• Procédure simplifiée (streamlined procedure)
• Procédure scénarisée (playscript procedure)
• Procédure organigramme (flowchart procedure)
• Procédure assistant (wizard procedure) - assistant logiciel
• Annotations d’interfaces (interface annotation model)
• Procédure à étapes enrichies (rich-step procedure)
• Procédure en format paragraphes (paragraph-format procedure)

12. Procédure simplifiée
• Type de procédure le plus courant
• Construction structurée et concise
• Facile à comprendre

13. Procédure simplifiée
• Étapes simples et brèves
• Mise en forme simple
• Verbes a l’impératif
• Peu d’information fournie avant la procédure
• Références croisées ou hyperliens vers les définitions, les concepts
et les références complémentaires

14. Procédure scénarisée
• Documente une tâche qui implique plusieurs intervenants
• Mise en forme comme un scénario
• Les actions de chaque intervenant sont listées séparément
• Chacun sait ce qu’il doit faire
• Chacun voit son rôle dans la procédure complète

15. Procédure organigramme
• Utile dans les situations complexes qui présentent de multiples
conditions
• Décrit bien les processus de prise de décision
• Permet à l’utilisateur de naviguer aisément et de choisir les options
spécifiques à ses besoins
• Bien adapté pour présenter les arborescences décisionnelles
complexes
• Format qui représente graphiquement les points de décision et les
chemins à suivre

16. Procédure assistant (assistant logiciel)
• Tire avantage de la capacité de l’ordinateur à agir pour l’utilisateur
• Simplifie et standardise la présentation de l’information et fournit les
moyens pour exécuter les actions en séquence
• Réduit la complexité d’un logiciel en masquant l’interface normale à
l’utilisateur
• Élimine les interrogations potentielles de l’utilisateur en lui permettant
d’identifier pour chaque étape les conditions qui s’appliquent
spécifiquement à sa situation
• Simplifie pour l’utilisateur les branchements décisionnels complexes

17. Annotations d’interfaces
• Bulles d’aide et messages pop-up dans des systèmes d’aide
contextuelle, étiquettes sur boutons, interrupteurs, valves ou leviers
• Information procédurale disponible à proximité de chaque contrôle
spécifique d’une interface homme-machine
• Présume que l’utilisateur est déjà assez familier avec les fonctions
présentées par l’interface
• Conviennent mal aux novices

18. Procédure à étapes enrichies
• Variation moins restrictive de la procédure simplifiée
• Étapes ne suivent pas un ensemble de conventions spécifiques
• Étapes typiquement plus longues
• Syntaxe plus variée

19. Procédure en format paragraphes
• Abandonne les étapes numérotées
• Utilise une syntaxe encore plus variée que la procédure à étapes
enrichies

20. Procédure à étapes enrichies
Procédure en format paragraphes
• Tutoriels
• Longues procédures (Ex. : instructions de travail)
• Systèmes naturels complexes (Ex. : guides de premiers soins)
Exemples

21. Quels sont
les composants d’une procédure ?
• Le titre
• L’élément conceptuel
• Le sous-titre à l’infinitif
• Les étapes
• Les notes, incluant les mises en garde, les avertissements, les notes
importantes, les astuces

22. Le titre
• Introduit la procédure
• Donne l’objectif à atteindre
• Permet de distinguer chaque procédure par son sujet propre
• Sert d’outil de navigation : Table des matières, index, lien vers
d’autres procédures apparentées

23. L’élément conceptuel
• Optionnel
• Élabore sur l’objectif formulé dans le titre
• Donne les prérequis à l’exécution de la tâche
• Indique aussi les possibles résultats non-souhaités de la procédure
• Donne à l’utilisateur de l’information conceptuelle additionnelle et le
contexte d’utilisation qui lui permet de décider s’il est approprié
d’exécuter la procédure

24. Le sous-titre à l’infinitif
• Optionnel
• Utilisé le plus souvent lorsque plusieurs procédures sont présentées
dans le cadre du sujet
• Énonce clairement le but de chaque procédure
• Permet de grouper plusieurs procédures sous un élément conceptuel
commun, un même sujet

25. Les étapes
• Déclarations d’action
• Descriptions des réponses du système
• Informations qui permettent à l’utilisateur d’exécuter la procédure pas
à pas

26. Les types d’étapes
• Étape d’action : décrit l’action à exécuter
• Étape avec facilitateur : le plus souvent, indique l’emplacement de l’action
à exécuter, par exemple, un menu ou un panneau de contrôle
• Étape d’options pour l’utilisateur : indique les variantes disponibles
• Étape conditionnelle : décrit un état du système qui peut poser problème
et l’action qui permet de le résoudre
• Explication de but d’étape : précise un but intérimaire pour l’étape en
cours
• Déclaration de rétroaction d’étape : décrit la réponse du système à
l’action exécutée et son nouvel état

27. Les notes
• Donnent de l’information qui ne fait pas partie de la procédure
comme telle
• Présentent des informations supplémentaires relatives à la
procédure, par exemple des astuces
• Souvent placées à la fin de la procédure
• Les notes de mise en garde, d’avertissement ou autre notes
importantes seront placées immédiatement avant ou après l’étape
auxquelles elles font référence

28. Quels objectifs une procédure doit-elle atteindre
?
• Facile à comprendre
• Suffisamment précise
• Permettre d’exécuter et de réussir la tâche
• Donner à l’utilisateur toute l’information dont il a besoin
• Répondre aux questions de l’utilisateur
• Anticiper les difficultés

29. Comment atteindre ces objectifs ?
• Être attentif à notre propre processus d’exploration du système à
documenter
• Prendre en note les notions et les concepts que nous avons
assimilé pour comprendre le système à documenter
• Utiliser judicieusement les composants de procédure
• Rédiger des procédures simples, claires, qui guident efficacement
l’utilisateur et répondent à ses questions

30. Questions ?
•

31. Références
• D. K. Farkas, “The logical and rhetorical construction of procedural discourse,”
Tech. Commun., vol. 46, no. 1, pp. 42–54, 1999.
http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.586.4894&rep=rep1&ty
pe=pdf
• H. Van Der Meij, M. Gellevij, “The Four Components of a Procedure,” IEEE
Transactions on Professional Communication, vol. 47, no. 1,
pp. 5–14
https://ris.utwente.nl/ws/portalfiles/portal/6846479
• “Microsoft Manual of Style,” Microsoft Press, 2012, 460 p.