BHDicaire

Bibliothèque de motifs

Règles de gouvernance

Utilisez cette page pour ajouter ou auditer une page de motif. La gouvernance définit lorsqu’une composition mérite un motif; cette page définit comment le site le consigne et le rend.

Profil de motif#

pattern_kind: "pattern"
pattern_category: "navigation"
pattern_status: "implemented"
pattern_components:
  - /docs/site-implementation/components/navigation/
  - /docs/site-implementation/components/language-toggle/
pattern_content:
  - menu configuration per language
pattern_accessibility:
  - visible keyboard focus
  - landmark label distinct from other navigation
pattern_implementation:
  partial:
    - layouts/partials/header.html
  css:
    - assets/css/site.css
  js:
    - assets/js/site.js

pattern_kind vaut toujours pattern. pattern_category identifie la tâche récurrente, pas un traitement visuel. pattern_status vaut implemented, specified ou deprecated. Utilisez pattern_components pour les chemins de documentation des composants qui composent le motif; ne répétez jamais leurs fichiers d’implémentation dans la prose.

pattern_content consigne les exigences de rédaction ou de données. pattern_accessibility consigne seulement les attentes au niveau du motif — les règles qui émergent de la composition, pas la copie de chaque contrat de composant. pattern_implementation utilise les mêmes noms de mécanismes de carte de preuves que les manifestes d’interface : partial, shortcode, layout, data, css, js, i18n et configuration.

Structure de page#

Rédigez seulement les sections qui aident une personne à appliquer le motif :

  1. Tâche — qui doit faire quoi, et quand ce motif est approprié.
  2. Composition — les composants concernés et leurs responsabilités.
  3. Contenu et données — configuration requise, intrants de rédaction et états vides ou d’erreur.
  4. Comportement adaptatif — ce qui change aux tailles étroites et larges.
  5. Accessibilité — comportement de repère, clavier, focus, ordre de lecture et annonce créé par la composition.
  6. Implémentation — explication fondée sur les sources seulement lorsqu’elle ajoute du contexte au-delà du manifeste.
  7. Manifeste de motif — la fiche de preuves générée.

Recette de migration#

  1. Confirmez la tâche utilisateur récurrente et la frontière dans Bibliothèque de motifs.
  2. Auditez l’implémentation et les composants existants. Consignez seulement les chemins vérifiés et les vraies pages de documentation de composants.
  3. Ajoutez une paire de pages bilingues sous docs/site-implementation/patterns/; utilisez le front matter standard pour le titre, la description et la date de mise à jour.
  4. Ajoutez les champs pattern_*, puis rendez {{< pattern-manifest >}} avant la section d’accessibilité.
  5. Exécutez npm run lint:patterns, puis vérifiez la sortie anglaise et française, les liens internes, le comportement clavier et les états adaptatifs avant de définir pattern_status: "implemented".

Un motif est spécifié — et non implémenté — jusqu’à ce que sa tâche, sa composition de composants et ses preuves sources existent ensemble.