Mise en évidence et emphase

Dites-nous où vous vous trouvez !

Contenu de ce chapitre

Mise en avant des fondamentaux
Techniques d'accentuation spécifiques

Problèmes courants de surlignage
Explorations supplémentaires
Schéma de surlignage

Vos commentaires sur ce chapitre

Cherchez !

Index principal

Mise en évidence, tel que le terme est utilisé ici, désigne l'utilisation d'effets typographiques pour attirer l'attention sur un texte. Ces effets peuvent inclure l'italique, le gras, les majuscules, les guillemets, la couleur, et ainsi de suite. La mise en évidence attire l'attention des lecteurs—ou leur "indique"—les actions qu'ils doivent entreprendre ou les informations qu'ils doivent considérer avec soin.

L'un des problèmes dans l'écriture technique—en particulier, l'écriture technique sur les ordinateurs—implique l'utilisation des diverses techniques d'emphase. Malheureusement, certains textes techniques exagèrent l'utilisation des différentes techniques d'emphase qui sont discutées ici.

Les Fondamentaux de la Mise en Évidence

Considérez quelques principes fondamentaux de mise en avant :

• Pratiquement tout effet textuel spécial qui diffère du texte de corps régulier peut fonctionner comme une technique d'emphase. Des éléments comme l'italique, le gras, les soulignements, les lettres majuscules, les tailles de police différentes, les polices alternatives, la couleur, les diverses ingéniosités graphiques (montrant, couleur inversée, polices en contour) peuvent agir comme des techniques d'emphase.
• Utilisées en excès, toute technique d'accentuation ou combinaison de techniques d'accentuation peut perdre sa capacité à mettre en avant et devenir encombrante et distrayante. Utilisées en excès, toute technique d'accentuation ou combinaison de techniques d'accentuation peut amener les lecteurs à hésiter à lire un texte, voire à l'éviter complètement. Remarquez à quel point la version trop surlignée de l'avis est illisible dans ce popup; notez également qu'il n'utilise pas le type de notification recommandé dans avis.
• Lorsque le texte étendu doit être souligné, utilisez le format d'avis spécial (plutôt que de créer des paragraphes entièrement en gras ou en majuscules, par exemple).
• Une relation fonctionnelle soigneusement planifiée doit exister entre le texte qui est mis en avant et la technique d'emphase qui est utilisée.
• Les techniques d'accentuation doivent être utilisées de manière cohérente pour éviter que les lecteurs ne deviennent confus.
• Pour promouvoir la cohérence, vous devez utiliser un guide de style ou une feuille de style, qui enregistre et dicte ensuite toutes vos décisions sur la manière dont vous allez utiliser les techniques d'emphase.
• Pour aider vos lecteurs à comprendre votre schéma de mise en évidence, vous pouvez inclure une brève section quelque part dans votre document (généralement dans la préface) expliquant comment vous allez utiliser les techniques d'emphase.

Dans la discussion suivante, vous remarquerez que tout système de techniques d'emphase peut devenir assez compliqué et difficile à retenir pour les écrivains et les éditeurs. Vous constaterez qu'il existe de nombreuses façons tout aussi valables d'utiliser les techniques d'emphase : par exemple, dans certains cas, il est arbitraire d'utiliser le gras ou l'italique pour une simple emphase. Pour résoudre ce problème, vous devez documenter vos directives de mise en surbrillance dans un guide de style auquel les écrivains et les éditeurs (ou juste vous) peuvent se référer. A guide de style est tout simplement un enregistrement des décisions que vous et votre équipe de documentation avez prises sur la façon dont vous souhaitez que vos documents apparaissent.

Vos lecteurs doivent également être informés du schéma de mise en relief que vous prévoyez d'utiliser. Cela peut être traité dans la préface : incluez une section appelée "Mise en relief" ou "Conventions typographiques" où vous listez comment vous utilisez l'italique, le gras, les polices et d'autres effets similaires. Pour un exemple, voir la discussion sur les préfaces dans le chapitre sur composants standards des livres techniques

Techniques d'emphase spécifiques

Cette prochaine section passe en revue une à une les différentes techniques d'emphase, en expliquant les pratiques courantes.

Remarque : Pour garder les choses simples, mettre en évidence les problèmes pour tables, figures, titres, listes, et avertissements sont présentées dans ces sections.

Gras

Dans l'édition, et en particulier dans l'édition technique, l'usage est mitigé quant à l'utilisation du gras ou de l'italique pour l'emphase de base. Par exemple, si vous voulez souligner que les lecteurs ne doivent pas éteindre l'ordinateur sans l'avoir d'abord éteint correctement, le "pas" peut être en gras ou en italique. Traditionnellement, l'italique a été utilisé, mais, peut-être à cause des ordinateurs, le gras est également couramment utilisé.

Quelle que soit la technique que vous utilisez, appliquez-la de manière cohérente dans votre texte ou votre bibliothèque de textes connexes. D'ailleurs, les lecteurs ne sont pas susceptibles de pouvoir distinguer les niveaux d'emphase : par exemple, utiliser l'italique pour le texte important et le gras pour le texte très important risque d'être perdu pour la plupart des lecteurs.

Si vous êtes tenté de mettre un paragraphe entier en gras, rappelez-vous l'un des principes d'emphase discutés ci-dessus : utiliser trop de techniques d'emphase fait perdre l'effet de la technique. Non seulement cela, mais trop d'emphase rend les lecteurs moins enclins à lire. Au lieu de lire attentivement un paragraphe entièrement en gras, les lecteurs peuvent tout simplement l'ignorer !

Au lieu de créer un paragraphe entièrement en gras, utilisez le format d'avis spécial. Dans celui-ci, un mot clé (par exemple, Important, Remarque, Danger, Prudence, Avertissement) est en gras, tandis que le reste du texte est en romain régulier (c'est-à-dire dans la même police et le même style que le texte ordinaire).

L'utilisation légitime du gras dans les textes techniques varie considérablement. Tant que vous développez un schéma qui est directement lié aux besoins du lecteur et aux caractéristiques du texte (ou de la technologie) et qui ne conduit pas à un excès, votre utilisation du gras devrait bien fonctionner.

Voici quelques utilisations courantes et standards du gras :

• Simple accentuation. Comme discuté précédemment, certains textes techniques utilisent le gras pour une simple emphase au lieu des traditionnels italiques. Par exemple, "Faites pas éteignez l'ordinateur avant de le fermer.
• Commandes. Les textes informatiques utilisent couramment le gras pour les commandes, par exemple, "Utilisez le déplacer commande pour renommer des fichiers UNIX." Consultez la section sur la mise en évidence du texte informatique pour un aperçu complet des techniques d'accentuation.
• Boutons qui initient des commandes. Dans une interface utilisateur graphique, certains des boutons lancent des commandes. Par exemple, "appuyez sur le Sortie " bouton pour quitter l'application."
• Labels de champ. Bien que certains textes informatiques mettent en gras les étiquettes de champ, ce n'est pas une pratique générale car cela entraîne une surcharge de mise en relief. Par exemple, "Dans le Indentation zone de la boîte de dialogue, cliquez sur Gauche." Plus commun, c'est d'utiliser le style de majuscules utilisé à l'écran. Il est préférable d'écrire ceci : "Dans la zone d'indentation de la boîte de dialogue, cliquez sur Gauche."
• Icônes ou boutons de clavier ou de souris. Bien que cela ne soit pas universellement observé, une autre technique de mise en évidence qui suit ce système de manière logique est de mettre en gras le nom d'une touche de clavier ou d'un bouton de souris. Par exemple, "Appuyez sur le Q clé ou le gauche bouton de la souris." En accord avec ce système, il est également prévu d'utiliser du gras sur les icônes : "Cliquez sur le Commencer icône."
• Étiquettes sur le matériel. Une autre pratique courante dans l'édition informatique est de mettre en gras le nom d'une étiquette de matériel. Par exemple, "Appuyez sur le Réinitialiser " bouton pour redémarrer l'ordinateur."

Vous remarquerez que la discussion précédente n'énonçait aucune règle absolue. C'est ainsi—la pratique de l'édition technique est assez variée. L'idée principale est de développer un système logique et contrôlé de mise en évidence, de l'utiliser de manière cohérente et de le documenter dans un guide de style afin que vous et les membres de votre équipe de documentation puissiez vous y référer.

Italique

Voici quelques-unes des utilisations standard des italiques :

• Accent simple. Comme mentionné précédemment, l'utilisation est variée quant à l'emploi du gras ou de l'italique pour une simple emphase, bien que l'italique soit traditionnel : par exemple, "Faites pas "Éteignez l'ordinateur avant de l'éteindre." Peu importe celui que vous utilisez, soyez cohérent et documentez-le dans votre guide de style ou feuille de style afin que tout le monde dans votre équipe de documents puisse le voir. Si vous n'êtes pas sûr de celui à utiliser, utilisez l'italique pour une simple mise en valeur : c'est moins chargé.
• Variables . En publication informatique, l'un des usages les plus courants des italiques est pour les variables. Par exemple :
  
  copier ancienfichier nouveaufichier
  
  Les utilisateurs savent qu'il ne faut pas taper ancien fichier ou nouveau fichier mais pour substituer leurs propres noms de fichiers à la place.
• Définitions dans des listes (deux colonnes). Bien que le gras soit plus courant pour les éléments de la colonne de gauche d'une liste à deux colonnes, l'italique est également utilisé. (Voir la discussion sur les listes à deux colonnes dans la section précédente sur le gras.)
• Termes où le terme est défini. Une belle touche est d'italiser un mot lorsqu'il est défini dans le corps du texte régulier.

Tirets bas

Il y a presque aucune raison d'utiliser des traits de soulignement dans un texte technique. À l'époque des textes dactylographiés, il y en avait certainement une. Cependant, de nos jours, lorsque le gras, l'italique et d'autres effets typographiques similaires sont facilement accessibles, les traits de soulignement semblent obsolètes. Si vous souhaitez souligner quelque chose, utilisez vos directives standard—par exemple, utilisez l'italique ou le gras. N'essayez pas de créer des gradations d'accentuation : par exemple, une échelle d'importance croissante allant de l'italique au gras en passant par le souligné sera perdue pour vos lecteurs.

Si vous voyez un bon usage des soulignés dans un texte technique, cela se produira probablement dans la conception des titres.

Capitalisation

Dans l'édition technique, il semble y avoir une bataille constante entre les rédacteurs techniques et les experts techniques concernant la capitalisation. Les experts techniques aiment utiliser des majuscules pour pratiquement chaque composant et processus dans un système. De plus, les experts techniques (et la direction) utilisent généralement des majuscules pour le texte qu'ils considèrent important et sur lequel ils souhaitent que les lecteurs se concentrent. Pendant ce temps, les rédacteurs techniques et les éditeurs (à juste titre) insistent sur l'utilisation de majuscules uniquement pour les noms propres.

En tant que rédacteur technique, maintenez la ligne contre la capitalisation. Les lettres majuscules sont distrayantes ; le texte en majuscules est inconfortable à lire. Les lettres majuscules créent un texte chargé, ce qui envoie de nombreux signaux inutiles. Les lettres majuscules sont traditionnellement destinées aux noms propres tels que Microsoft, Netscape, Gateway, Dell Computers, WordPerfect, et ainsi de suite. La directive classique dans l’édition technique est de mettre en majuscule les noms de produits commandables séparément seulement. Cependant, la politique des organisations déforme considérablement cette directive. Si une entreprise est fière d'une certaine fonctionnalité dans sa nouvelle version, par exemple, EnergyMiser, elle l'écrira en majuscules, même si vous ne pouvez pas la commander séparément.

Voici quelques directives typiques pour la capitalisation :

• Utilisez le style de capitalisation exact des messages affichés sur l'écran de l'ordinateur, des menus ou des noms d'écran, des noms de champs, des étiquettes matérielles, etc. (Dans les interfaces plutôt anciennes, toutes les majuscules étaient utilisées pour des éléments tels que les noms de champs, de menus et d'écrans. Une pratique courante dans ces cas est d'utiliser des majuscules initiales pour les références à ces éléments dans le texte régulier. Le principe ici est que l'utilisation inutile de toutes les majuscules dans le texte régulier est distrayante.)
• Faites pas UTILISEZ DES LETTRES MAJUSCULES POUR L'EMPLOI ; UTILISEZ L'ITALIQUE OU LE GRAS À LA PLACE.
• Ne pas utiliser de lettres capitales pour un texte étendu ; utiliser le format d'avis spécial à la place.
• Ne pas mettre en majuscule les noms des composants ou des processus d'un produit. Mettre en majuscule uniquement les noms des produits, c'est-à-dire les composants qui peuvent être commandés séparément.
  
  Par exemple, votre produit peut s'appeler WordStuff et bien sûr, il doit être capitalisé selon le style dicté par les responsables marketing et de produit. Cependant, l'une des fonctionnalités de WordStuff appelée "correcteur orthographique" ne devrait pas être capitalisée—presque tout le monde en a un. Cependant, WordStuff peut avoir une fonctionnalité appelée "ZippyFormat" et une autre appelée "Image Worker". Bien que celles-ci ne soient pas commandables séparément, vous voudrez utiliser le style avec une majuscule initiale en raison de leur style spécial et de leur valeur marketing. "Image Worker" est évidemment quelque chose que WordStuff, Inc., souhaite mettre en avant—d'où les majuscules.
  
  Mais quand vous devez enfreindre des règles comme ça, les exceptions doivent figurer dans le guide de style ou la feuille de style.

Guillemets simples ou doubles

Les guillemets sont souvent utilisés à tort comme techniques d'emphase dans les textes techniques. En tant que rédacteur technique, limitez les guillemets à l'utilisation traditionnelle, qui inclut le discours cité ; les nombres, lettres ou mots mentionnés en tant que tels. Les guillemets, comme les lettres majuscules, tendent à créer un texte chargé et distrayant et doivent donc être évités.

Une utilisation légitime des guillemets est l'utilisation étrange, atypique et non standard des mots (appelée « guillemets d'effroi » par Manuel de style de Chicago). Par exemple :

Dans un vidage de mémoire, l'ordinateur "rend" toutes les données dans un seul fichier.

Un texte informatique bien conçu évite les guillemets de manière assez fervente. L'une des principales raisons est que certains lecteurs pourraient supposer à tort qu'ils doivent inclure les guillemets dans les commandes qu'ils saisissent.

Remarque : Bien que certains textes techniques aient des usages bien définis pour les guillemets simples, en général, il n'existe pas d'utilisation standard pour les guillemets simples, autre que la règle traditionnelle du citation-dans-une-citation et la règle d'usage particulier. Lorsque vous voyez des guillemets simples dans un texte technique, il n'y a généralement pas plus de raison pour leur utilisation que pour les guillemets doubles.

Polices alternatives

L'un des styles les plus courants utilisant des polices alternatives est d'utiliser Courier ou une police à chasse fixe similaire, de style machine à écrire, en contraste avec la police de corps standard (comme Times New Roman ou Helvetica). Vous pouvez créer cet effet dans une page web en utilisant un style CSS comme <span class="example_text">. Par exemple, "taper installer "pour installer le programme."

Voici un aperçu des usages courants des polices alternatives :

• Texte d'exemple. Pour signaler qu'un exemple plutôt qu'une entrée requise est affiché, une police alternative comme Courier est souvent utilisée :

Par exemple, si vous voulez copier un fichier, tapez copier yourfile.txt monfichier.txt. Un fichier appelé monfichier.txt sera créé, et son contenu sera le même que votrefichier.txt.

• Texte affiché. Les ordinateurs et autres équipements affichent généralement des éléments tels que des avertissements, des codes d'état ou des messages d'erreur. Ceux-ci apparaissent sur les moniteurs ou dans des panneaux LCD et similaires. Lorsque vous faites référence à ce texte affiché, vous pouvez utiliser une police alternative comme Courier. Par exemple, "Si le répertoire n'existe pas, le système répondra par Aucun fichier ou répertoire de ce type." Ou, "Au démarrage de l'ordinateur, la fenêtre d'affichage numérique affichera 8888."
• Exemples de code étendus. Dans les textes de programmation informatique, des échantillons de programmation étendus sont souvent présentés en Courier, par exemple :

#vérifier les hackers moyens if ($address1 eq "" & $address2 eq "") { &wicked_address (500, "Erreur de recherche", "Veuillez entrer un nom."); } elsif ($address1 =~ /[;<>&\*`\|]/ | $address2 =~ /[;<>&\*`\|]/) { &wicked_address (500, "Erreur de recherche", "Adresse e-mail mal formée. Veuillez ne pas détruire notre pauvre, humble, école virtuelle à une seule salle!."); }

Couleur

La couleur est utilisée dans les textes techniques mais elle est coûteuse et difficile à gérer tout au long du cycle de publication.

Cependant, la couleur est facile à utiliser dans les informations en ligne. Il est courant de voir des liens hypertexte, par exemple, utilisant de la couleur. Les aides en ligne utilisent généralement le vert tandis que les pages web utilisent typiquement le bleu pour les nouveaux liens et le violet pour les liens que l'utilisateur a déjà explorés.

La tendance à utiliser la couleur de manière indiscriminée dans les informations en ligne est très semblable à la tendance à abuser du gras, des italiques, des tailles de police et des polices alternatives dans les informations sur papier. Le sentiment doit être quelque chose comme : « C'est là, c'est cool, donc utilisons-le ! »

Si vous souhaitez utiliser des couleurs, planifiez-le soigneusement. Ne vous attendez pas à ce que les lecteurs se souviennent que le rouge signale une idée, le bleu une autre idée et le vert encore une autre idée. En général, évitez d'utiliser des couleurs pour un texte étendu. Au lieu de rendre toute une alerte rouge, faites simplement que le mot Alerte soit rouge et laissez le texte d'avertissement en romain régulier (texte comme le corps normal du texte).

Mieux encore, lisez quelques-unes des publications standards sur la couleur dans le domaine de la communication technique. Il existe des questions de conception générales et des questions internationales :

• Utiliser des couleurs. Fournie par le Système de conception Web des États-Unis (USWDS).
• Un guide international sur l'utilisation de la couleur dans le marketing et la publicité. Différentes significations que le rouge, par exemple, a au niveau international. Découvrez son Tableau de Symbolisme des Couleurs Internationales. Source : Six Degrees, LLC
• N'oubliez pas que, selon un article Dans Wikipédia, "Environ 8 % des hommes, et 0,4 % des femmes, sont daltoniens rouge–vert d'une manière ou d'une autre, que ce soit une couleur, une combinaison de couleurs, ou une autre mutation."

Combinaisons de ce qui précède

En général, c'est une mauvaise idée de combiner des techniques d'emphase, par exemple, le gras et les italiques. Dans un texte technique non professionnel, vous verrez de telles combinaisons criardes comme le gras-italique en toutes majuscules ou le gras-italique en toutes majuscules avec des guillemets doubles. Évitez cela !

Une combinaison légitime est d'utiliser des italiques avec des polices alternatives. Par exemple, lorsque vous montrez la syntaxe d'une commande, vous voulez que tout le texte soit en Courier, mais vous voulez aussi que les variables soient en italique :

copier AncienNomDeFichier NouveauNomDeFichier

Noms fonctionnels pour les styles de caractère et les étiquettes

Si vous avez déjà été en contact avec l'industrie de l'édition, vous avez peut-être rencontré quelque chose appelé balisage sémantique. Cela signifie nommer des sections de texte en fonction du rôle structurel qu'elles jouent dans le document—par exemple, titre. Le lecteur ne voit pas ces noms, mais ils jouent un rôle important dans la façon dont le document est formaté et comment il peut être réutilisé.

Cette même idée s'applique aux mots dans les phrases au sein du texte. Par exemple, dans le HTML d'une page web, vous pouvez utiliser le <b>mot en gras</b> tags pour rendre un mot en gras. Mais en gras n'indique pas la fonction du mot ou de la phrase. Au lieu de, commande ou bien étiquette_interface Donc, en utilisant le balisage sémantique avec HTML et CSS, les choses sont plus fonctionnelles si elles ressemblent à ceci : <span class="command">mot en gras</span>.

Les fichiers utilisant HTML et CSS sont généralement convertis en d'autres formats tels que PDF ou même d'un et vers XML. Utilisant fonctionnellement Les styles de surlignage nommés, comme décrit juste au-dessus, peuvent grandement faciliter le processus de conversion.

Explorations supplémentaires

Une fois que vous avez lu ce qui précède, une bonne chose à faire ensuite est d'explorer les publications techniques pour voir quels schémas de mise en relief elles utilisent. Observez la façon dont des éléments comme le gras, l'italique, les lettres majuscules, les polices alternées et d'autres effets similaires sont utilisés. Très probablement, vous verrez des usages très différents de ce que vous avez lu ici. En explorant, réfléchissez à la logique des techniques d'accentuation que vous voyez être utilisées ; essayez de formuler les règles que les écrivains semblent utiliser ; surveillez les incohérences dans la mise en relief ; et pensez de manière critique à l'utilisation que vous constatez. Est-elle logique ? Excessive ? Insuffisante ?

Après avoir fait un peu d'exploration comme cela, l'étape logique suivante est de lire le chapitre sur guides de style, si vous ne l'avez pas déjà fait. Les schémas de mise en évidence doivent être documentés dans des guides de style afin que vous ne les oubliiez pas et que les membres de votre équipe de documentation puissent y faire référence.

Schéma de mise en valeur

Si toutes les options et alternatives discutées précédemment vous submergent, envisagez d'utiliser le schéma de mise en surbrillance suivant. Il est basé sur la mise en surbrillance que vous trouverez dans de nombreux documents UNIX, Windows et Linux.

Notes :

1. Roman régulier se réfère à la police et à la taille de police utilisées pour le texte de corps.
2. Bien que ces suggestions recommandent un "style majuscule à l'écran", les développeurs ont parfois une tendance malheureuse à utiliser des majuscules. Comme un style en majuscules réduit la lisibilité, utilisez tout de même des majuscules initiales (case de titre).
3. Si vous montrez aux utilisateurs comment entrer une commande en incluant un texte d'exemple, ne mettez pas en gras la commande qui se trouve dans le texte d'exemple :

Utilisez le mv commande pour changer le nom d'emplacement d'un fichier, par exemple :
mv ce_fichier.txt cet_autre_fichier.txt.

4. Si vous montrez aux utilisateurs comment entrer une commande en incluant un texte d'exemple, et que vous incluez des variables dans le texte d'exemple, utilisez des italiques pour les variables.

Utilisez le mv commande pour changer le nom ou l'emplacement d'un fichier :
mv mon_fichier.txt votre_fichier.txt.

5. Si vous faites simplement référence au nom d'un écran ou d'un menu qui n'est pas cliqué ou qui n'initie aucun événement, utilisez le style majuscule pour l'écran et le romain standard.
6. Certains styles mettent en évidence l'action que les utilisateurs doivent entreprendre (par exemple, presse, entrer, supprimer). C'est certainement une option, mais pour moi, c'est trop de mise en évidence.

Les guides d'utilisation incluent souvent un tableau des significations des polices en surbrillance, des couleurs et de la typographie dans la préface :

Je serais reconnaissant de vos pensées, réactions, critiques concernant ce chapitre : votre réponse.