Glossaire

Le glossaire est le contrat de sens partagé des sites. Il définit les termes à privilégier, les définitions utilisées et les équivalents bilingues qui devraient rester cohérents dans les pages, les métadonnées, les libellés et la documentation.

Utilisez le glossaire rendu pour les recherches. Utilisez cette page pour décider quand et comment un terme devient une partie du système.

Ce qui appartient au glossaire#

Ajoutez un terme lorsqu’il change la façon dont le site communique ou la façon dont les contributeurs prennent des décisions.

  • Termes privilégiés utilisés sur plus d’une page
  • Termes dont le sens peut facilement devenir flou
  • Équivalents anglais et français qui doivent rester alignés
  • Alias, acronymes et graphies de rechange acceptés
  • Termes qui ne devraient pas être traduits
  • Termes déconseillés, évités ou propres à un contexte lorsque la distinction prévient la dérive

N’ajoutez pas chaque mot ordinaire. Le glossaire devrait réduire l’ambiguïté, pas devenir une taxe de maintenance.

Relation avec le nommage#

Les conventions de nommage gouvernent les fichiers, les URL, les composants, les classes, les clés de données et les scripts. Le glossaire gouverne le sens dans la prose et le langage d’interface.

Lorsque le même mot apparaît aux deux endroits, utilisez la règle la plus stricte :

  • Le code et les URL ont besoin de noms stables et portables.
  • La prose et les libellés ont besoin de termes clairs pour les lecteurs.
  • Les libellés partagés devraient suivre le glossaire, sauf lorsqu’un composant a une raison d’utilisabilité forte d’employer une forme plus courte.

Règles d’entrée#

Chaque entrée structurée du glossaire devrait inclure :

  • une clé stable
  • un terme anglais
  • un terme français lorsqu’un équivalent naturel ou officiel existe
  • une courte définition dans les deux langues lorsque le terme apparaît dans des pages bilingues
  • un type, comme terme ou abréviation
  • une catégorie
  • des alias lorsque les lecteurs peuvent chercher une autre forme
  • des sources lorsqu’une définition dépend d’une norme externe ou d’une terminologie officielle

Utilisez une terminologie française canadienne ou québécoise pour les entrées françaises. Préservez les noms officiels, les noms de produits, les noms de protocoles et les identifiants de code.

Les alias sont des libellés de recherche alternatifs, pas des termes canoniques distincts. Utilisez-les pour les sigles, anciens libellés, graphies courantes ou expressions de recherche qui devraient ramener au terme privilégié.

Utilisez abbreviation comme type de glossaire pour les formes raccourcies. Expliquez dans la définition si l’entrée est un acronyme ou un sigle, au lieu de créer des catégories de filtre séparées.

Règles de rédaction#

Préférez le terme du glossaire lorsqu’une page a besoin de cohérence. Utilisez l’alias seulement lorsqu’il reflète la façon dont l’audience cherchera ou reconnaîtra le sujet.

N’inventez pas une traduction à l’intérieur d’une seule page. Si un terme a besoin d’un équivalent français, ajoutez-le d’abord aux données du glossaire ou gardez le terme officiel inchangé avec assez de contexte pour le lecteur.

Utilisez les définitions en ligne avec retenue. Une définition devrait aider au moment de la lecture; elle ne devrait pas transformer la prose ordinaire en labyrinthe d’infobulles.