Les avis spéciaux sont une caractéristique importante de la documentation technique professionnelle: ils mettent en évidence les informations particulières que les lecteurs doivent connaître pour comprendre ce qu'ils lisent, pour accomplir ce qu'ils veulent faire, pour prévenir les dommages au matériel, et pour éviter de se blesser eux-mêmes ou de blesser autrui.
Avis très spéciaux. Notices ultramodernes avec commentaires astucieux.
Lignes directrices pour des types spécifiques d'avis
Ce chapitre présente un un style spécifique d'avis. Soyez très conscient que d'autres styles et formats existent.
- Utilisez des avis spéciaux pour mettre en évidence les points clés ou avertir les lecteurs d'éventuels dommages ou blessures.
- Veillez à utiliser les types d'avis spéciaux avec précision, pour les usages qui leur sont définis. Utilisez les quatre types d'avis spéciaux de la manière suivante:
Remarque—Pour souligner des points ou des rappels, ou pour indiquer des problèmes mineurs dans une procédure.
Attention—Pour avertir les lecteurs d'éventuels dommages à l'équipement ou aux données, de problèmes possibles quant au résultat de ce qu'ils font, ou d'expériences négatives potentielles (comme l'embarras).
Avertissement—Avertir les lecteurs de la possibilité de blessures légères pour eux-mêmes ou pour autrui.
Danger—Pour avertir les lecteurs de la possibilité de blessures graves ou mortelles pour eux-mêmes ou pour autrui.
Remarque: Jetez un coup d'œil dans votre garage ou votre cuisine, et regardez les mentions particulières que vous voyez sur les produits. Vous constaterez une grande variété, qui dépend probablement de normes spécifiques à l'industrie ou à l'entreprise.
Choisir quel type d'avis utiliser n'est pas une science exacte. N'utilisez pas un avis de danger lorsqu'un avertissement est plus approprié (tout comme "crying wolf"). De plus, utilisez les avis de manière cohérente dans l'ensemble d'un document. Faites pas créez vos propres avis, par exemple en mettant "Important:" à la place de "Warning."
- Placez des avis spéciaux à l'endroit du texte où ils sont nécessaires. Par exemple, placez une mise en garde ou un avis de danger juste avant ou juste après discutant d'une étape au cours de laquelle les lecteurs pourraient se blesser.
- Évitez d'avoir trop de notices spéciales au même endroit du texte. Sinon, l'efficacité de leur format spécial sera perdue. (Si vous en avez trop, regroupez-les.)
- Avec des avertissements, des mises en garde et des avis de danger, expliquez les conséquences de ne pas prêter attention à l'avis. Indiquez ce qui arrivera si le lecteur ne tient pas compte de l'avis.
- Les exemples de cette section utilisent le gras. Évitez le texte entièrement en majuscules pour tout avis spécial.
Remarque: Dans un espace de publication correctement configuré, les rédacteurs techniques n'auraient pas à décider quel type d'avis utiliser ni même à rédiger le texte des avis. Cela devrait être le travail des avocats de l'organisation. Pourtant, ces avocats pourraient être trop occupés pour examiner vos avis, et donc la charge pourrait encore reposer sur vous le rédacteur technique ou l'éditeur.
Format des avis spéciaux
Utilisez ce qui suit pour des détails spécifiques sur la capitalisation, la typographie (gras, soulignement, polices différentes, différentes tailles de caractères), et l'espacement pour chaque type de notice spéciale.
Remarque
Utilisez le format suivant pour des notes simples:
- Tapez le libellé "Note" suivi d'un deux-points. (Bien que certains des exemples suivants utilisent le gras, préférez l'italique pour éviter toute confusion visuelle avec les titres.)
- Commencez à taper le texte de la note un espace après le deux-points. (Mais ne mettez pas le texte de la note en gras ni en italique.)
- Mettre un interligne simple dans le texte de la note; laisser une ligne vide au-dessus et en dessous de la note.
- Commencez les lignes reportées sur la marge gauche habituelle.
- Alignez la note sur le texte auquel elle se réfère (comme illustré dans le deuxième exemple).
Exemple d'une note simple
Exemple d'une note dans une liste à puces (pas du texte courant). Ce même principe (selon lequel les avis spéciaux s'alignent sur le texte auquel ils se réfèrent) s'applique également aux autres types d'avis spéciaux.
Notes
Utilisez le format suivant pour plusieurs notes :
- Utilisez ce format lorsque vous avez tellement de notes qu'il serait distrayant de les présenter individuellement.
- Tapez l'étiquette "Notes" suivie d'un deux-points. (Bien que certains des exemples suivants utilisent le gras, privilégiez l'italique pour éviter toute confusion visuelle avec les titres.)
- Utilisez une liste numérotée pour les notes individuelles; dans celle-ci, suivez les règles des listes numérotées. (N'utilisez ni le gras ni l'italique pour les notes individuelles.)
- Alignez les notes avec le texte auquel elles se rapportent ; laissez l'équivalent d'une ligne vide au-dessus et au-dessous des notes.
Exemple d'une note multiple. Utilisez ce format si vous avez beaucoup de notes et souhaitez toutes les rassembler au même endroit pour éviter les distractions.
Attention
Utilisez le format suivant pour les avis de précaution :
- Tapez l'étiquette "Caution" suivez-la d'un deux-points, et mettez en gras à la fois l'étiquette et le deux-points.
- Laissez une ligne vide et commencez le texte de la mise en garde aligné sur le début de l'étiquette.
- Mettez le texte de l'avertissement en simple interligne; laissez une ligne vide au-dessus et au-dessous de l'avis.
- Alignez l'avis de précaution sur le texte auquel il se réfère (dans l'exemple précédent, l'avis d'avertissement figure dans une liste numérotée et est indenté en conséquence).
Exemple d'avis de prudence. Utilisez celui-ci pour avertir les lecteurs d'éventuels dommages à l'équipement ou de problèmes liés à la procédure.
Avertissement
Utilisez le format suivant pour les avertissements :
- Tapez l'étiquette "Warning," mettez-la en italique, et suivez-la d'un deux-points.
- Faites soit une tabulation jusqu'au début du texte de l'avertissement, soit utilisez le format à retrait suspendu (qui est bien meilleur). Le format à retrait suspendu pour l'avertissement dans l'exemple ci-dessous utilise 0,63 pouce pour la tabulation et pour le retrait suspendu, mais la taille des polices fera varier cette valeur.
Remarque: Voir Créer un retrait suspendu pour une vidéo sur la création du format de retrait suspendu dans Microsoft Word.
- Utilisez une police de caractères normale pour le texte de l'avis d'avertissement (pas de gras, pas d'italique, pas de texte entièrement en majuscules, pas de couleur).
- Alignez la notice d'avertissement sur le texte auquel elle se réfère.
- Laisser l'équivalent d'une ligne au-dessus et au-dessous de l'avis d'avertissement.
Exemple d'avis d'avertissement. Utilisez celui-ci pour alerter les lecteurs de la possibilité de blessures mineures.
Danger
Utilisez le format suivant pour les avis de danger :
- Tapez le label "DANGER" en majuscules et en gras.
- Alignez l'avis de danger avec le texte auquel il se réfère.
- Mettez le texte de l'avis de danger en interligne simple; laissez une ligne vide au-dessus et en dessous de l'avis de danger.
- Mettez en gras le texte de l'avis de danger si vous l'avez (mais jamais entièrement en majuscules).
- Si vous disposez de capacités graphiques, dessinez un encadré autour de l'avis de danger (y compris l'étiquette).
Avis de danger. Utilisez ceci pour avertir les lecteurs de la possibilité de blessures graves ou de décès.
Images de notification (icônes)
Veuillez consulter images d'avis courants.
Autres problèmes de mise en forme
Voici quelques points supplémentaires à prendre en compte concernant les avis spéciaux :
Alignement spécial. Les avis spéciaux doivent être alignés sur le texte auquel ils se réfèrent. Par exemple, si vous avez une note qui ajoute un détail particulier à quelque chose dans un élément de liste à puces, vous devez aligner cette note sur le texte texte de l'élément de la liste à puces. Bien sûr, si la note suit une liste à puces mais concerne l'ensemble de la liste, alors vous pouvez utiliser la marge de gauche habituelle.
Texte à simple interligne. Tous les exemples et les discussions de cette unité sont basés sur du texte à interligne simple. Laissez une ligne vide entre le texte courant et les avis spéciaux—selon ce qui vous semble le mieux. (Et bien sûr, tant le texte courant que le texte des avis spéciaux seraient à simple interligne.)
Emplacement des avis spéciaux. Placer des avis spéciaux juste avant ou juste après le moment où ils sont pertinents. Par exemple, vous pouvez avertir les lecteurs de sauvegarder toutes leurs données avant vous leur dites de reformater leur disque dur. Cependant, en pratique, des avertissements spéciaux et sérieux sont placés au tout début d'une procédure où un dommage important aux données, à l'équipement ou aux personnes est susceptible de se produire.
Une technique utilisée par des rédacteurs très prudents (peut-être ceux qui ont été brûlés) consiste à placer tous les avis sérieux (avertissements, mises en garde et dangers) quelque part au début du document, puis à les répéter individuellement là où ils s'appliquent. Une organisation est susceptible d'avoir un guide de style qui énonce des exigences sur le placement des avis.
Tableau des significations des avis spéciaux. Les guides d'utilisation comportent souvent un tableau expliquant la signification des différents types d'avis dans la préface, comme partiellement illustré en bas de cette figure. Remarquez que dans cet exemple il n'y a pas de type d'avis de prudence, ce qui illustre simplement comment les avis varient selon les secteurs :
Tableau des avis. Notez que dans cet exemple, il n'existe pas de type d'avis de mise en garde, ce qui illustre comment les avis varient selon les secteurs d'activité.
Plusieurs avis spéciaux. Vous vous retrouvez dans des situations où vous avez trois ou quatre avis spéciaux, tous entassés dans
Informations connexes
Définitions ANSI pour les panneaux Danger, Avertissement, Attention ou Avis. Inclut des images téléchargeables.
1910.145 - Spécifications pour les panneaux et étiquettes de prévention des accidents. Administration de la sécurité et de la santé au travail (OSHA)
Catégories de panneaux de sécurité OSHA (50487). Beaucoup d'images téléchargeables.
Que signifient les différentes couleurs des panneaux de sécurité ?. comprend des images téléchargeables. Creative Safty Supply
Pourquoi le "12:00" clignotant est devenu le symbole ultime de la frustration technologique des années 90. Sydney Butler, howtogeek.com
J'apprécierais vos avis, réactions et critiques concernant ce chapitre : votre réponse—David McMurrey.
