Rédacteur d'ADR
Documentez les décisions d'architecture avec un contexte clair, des alternatives et des conséquences. Rédigez en français.
Modèle d'ADR
# ADR-[Numéro] : [Titre court de la décision]
**Statut :** [Proposé | Accepté | Déprécié | Remplacé par ADR-XXX]
**Date :** [AAAA-MM-JJ]
**Auteur :** [Nom/Pseudo]
## 1. Contexte
Quel problème résolvons-nous ? Quels facteurs l'affectent (objectifs métier, dette technique, budget) ?
**Contraintes :**
- [Contrainte 1]
- [Contrainte 2]
## 2. Décision
Un énoncé court de la décision. La thèse principale.
## 3. Détails techniques et mécanismes
_Section libre. Décrivez les éléments d'implémentation, structures de données, détails de protocole ou fonctionnalités clés du framework._
- [Listes, descriptions d'API, schémas de données]
- [Visualisation Mermaid (recommandée pour les interactions complexes)]
## 4. Alternatives envisagées
### 4.1. [Option 1]
- **Avantages :** ...
- **Inconvénients :** ...
- **Décision :** [Rejetée/Envisagée] (raison courte).
## 5. Conséquences et risques
### Points positifs (Avantages)
- En quoi cela aide-t-il le système/l'équipe ?
### Points négatifs / Risques (Inconvénients/Risques)
- Quels inconvénients acceptons-nous ? Quelles sont les menaces ?
- **Atténuation :** Comment allons-nous gérer les risques ?
## 6. Historique des révisions
- **[Date] :** [Description du changement] ([Auteur])
- **[Date] :** [Ex. : Statut modifié en Accepté] ([Auteur])
Numérotation des ADR
ADR-001 : Architecture initiale du système
ADR-002 : Sélection de base de données pour l'analyse
ADR-003 : Stratégie d'authentification
...
Workflow de statut
Proposé → Accepté → Implémenté
↓
Rejeté
Accepté → Déprécié → Remplacé par ADR-XXX
Bonnes pratiques
- Rédigez des ADR pour les décisions significatives : Tous les choix ne nécessitent pas un ADR.
- Documentez les alternatives : Montrez que vous avez envisagé des options.
- Soyez honnête sur les compromis : Chaque décision a des inconvénients.
- Soyez concis : 1 à 2 pages maximum.
- Mettez à jour le statut : Marquez les ADR dépréciés/remplacés.
- Lieze les ADR connexes : Créez des traces de décisions.
- Incluez des suivis : Actions avec responsables.
- Visualisez : Utilisez des diagrammes Mermaid pour montrer l'architecture et les flux.
- Écrivez pour les futurs lecteurs qui manquent de contexte actuel.
- Soyez honnête sur les compromis (chaque choix a des inconvénients).
Modèles courants
Pour la sélection de technologies :
- Mettez l'accent sur les capacités techniques par rapport aux exigences.
- Incluez des benchmarks de performance si disponibles.
- Documentez le niveau d'expertise de l'équipe.
- Tenez compte de la complexité opérationnelle.
Pour les changements architecturaux :
- Incluez la stratégie de migration dans les conséquences.
- Documentez l'impact sur la rétrocompatibilité.
- Tenez compte de l'impact sur la vélocité de l'équipe pendant la transition.
- Notez les plans de surveillance et de retour arrière.
Pour les normes et conventions :
- Incluez des exemples de la norme en pratique.
- Documentez les exceptions ou les échappatoires.
- Tenez compte des mécanismes d'application.
- Notez les implications en matière d'éducation/onboarding.
Pour les dépréciations :
- Mettez le statut sur « Déprécié » ou « Remplacé ».
- Lien vers l'ADR remplaçant.
- Documentez le calendrier de fin de vie.
- Incluez un guide de migration.
Anti-patrons
❌ Trop détaillé : ADR de 10 pages que personne ne lit. ❌ Aucune alternative : On dirait que la décision était prédéterminée. ❌ Conséquences manquantes : Ignorer les inconvénients. ❌ Aucun responsable : Personne n'est responsable. ❌ Statut obsolète : Anciens ADR marqués comme « Proposé ».
Liste de vérification pour la révision
- Énoncé clair du problème dans le Contexte.
- La décision est explicitement énoncée.
- 2+ alternatives envisagées.
- Compromis évalués honnêtement.
- Conséquences (positives et négatives) documentées.
- Risques identifiés avec atténuations.
- Responsable de la décision assigné.
- Actions de suivi avec échéances.
- Le statut est à jour.
Liste de vérification de sortie
- Document ADR créé.
- Le Contexte explique le problème.
- La décision est clairement énoncée.
- 2 à 3 alternatives documentées.
- Section Compromis remplie.
- Conséquences listées (positives et négatives).
- Risques identifiés avec atténuations.
- Date et responsables de la décision.
- Actions de suivi assignées.
- Le statut est défini.