Dossiers de décision

Les dossiers de décision sont une mémoire pour les mainteneurs, pas un format de publication.

Les ADR du dépôt expliquent pourquoi une décision structurelle a été prise. La documentation de marque explique la règle actuelle que le lecteur devrait suivre.

Règle#

Écrivez un ADR pour les décisions durables qui changent la structure, la responsabilité, la qualité, la confidentialité, le DNS, le déploiement ou les frontières techniques. Publiez seulement les directives dérivées là où le lecteur a besoin de la règle actuelle.

Utiliser un ADR pour#

  • la structure de documentation
  • les frontières de responsabilité entre les sites
  • les frontières de configuration DNS et Cloudflare
  • les modèles de qualité et la stratégie de test
  • les frontières de confidentialité et de code tiers à l’exécution
  • les décisions de source de vérité
  • les décisions susceptibles d’être questionnées plus tard

Ne pas utiliser un ADR pour#

  • les modifications ordinaires de contenu
  • les changements de texte
  • les ajustements de navigation propres à une page
  • les détails d’implémentation déjà évidents dans le code
  • les notes de travail temporaires

Dériver, pas dupliquer#

Lorsqu’un ADR touche les directives publiques, réécrivez-le dans la bonne page :

  • la règle va dans la Gouvernance du site
  • le mécanisme va dans l’Implémentation du site
  • les contraintes visuelles vont dans les Fondations
  • la reconnaissance de marque va dans Identité

La page publique peut mentionner discrètement un ADR comme source de décision, mais elle devrait tout de même se lire comme une directive.

Statut#

Les ADR acceptés restent valides jusqu’à ce qu’un autre ADR les remplace ou les supplante. Ne modifiez pas les anciens ADR pour rendre l’historique plus propre; ajoutez une nouvelle décision lorsque la décision change.