Génération du glossaire

Le glossaire de marque est une surface documentaire pilotée par les données. Les termes du système de marque vivent dans data/brand/glossary.yml; la page de documentation rend ces termes avec le shortcode glossary-table.

Cette séparation garde la frontière claire :

CoucheResponsableRôle
Gouvernancedocs/site-governance/glossary/Règles de sens, termes privilégiés et portée
Donnéesdata/brand/glossary.ymlTermes, définitions, alias et sources canoniques
Rendulayouts/shortcodes/glossary-table.htmlTableau de glossaire triable dans le shell documentaire
Consultationdocs/glossary/Accès rapide depuis l’aperçu de la documentation

Règles de rendu#

  • La page rendue devrait rester dans le layout de documentation pour que les lecteurs gardent la barre latérale documentaire.
  • La page racine du glossaire devrait être liée sous Aperçu pour un accès rapide.
  • Le tableau devrait lire des données structurées, pas des lignes Markdown écrites à la main.
  • Les pages anglaise et française devraient être rendues depuis les mêmes données sources.
  • Les définitions manquantes devraient être ignorées plutôt que rendues comme lignes vides.
  • Chaque ligne de terme devrait garder un id stable basé sur la clé de données afin de permettre la copie d’un lien direct.
  • Le regroupement des termes et des abréviations devrait venir du champ kind plutôt que de tableaux manuels séparés. Les distinctions entre acronyme et sigle appartiennent aux définitions.
  • Les définitions en ligne devraient continuer d’utiliser le shortcode definition.

Règles de données#

Le fichier de données est maintenu manuellement aujourd’hui. Ajoutez de l’automatisation seulement lorsqu’il existe une source amont fiable ou une transformation répétable qui peut être relue proprement.

Le glossaire de référence du site principal continue d’utiliser data/series/ref/glossary.yml. Il utilise le même partial de tableau que le glossaire de marque, tout en gardant son propre bloc de titre, son introduction et sa source de données orientée technologie et sécurité.

Si le glossaire dépasse un seul tableau de consultation, envisagez des pages de catégories générées ou des filtres plus riches. Ne séparez pas la source de vérité sauf si un second glossaire a une audience ou un modèle de responsabilité réellement différent.