README.md 2.2 KB
Architecture Decision Records (ADR)
Ce dossier contient les Architecture Decision Records pour le projet Videothèque.
Qu'est-ce qu'un ADR ?
Un ADR (Architecture Decision Record) est un document qui capture une décision architecturale importante, son contexte, et ses conséquences. C'est un outil léger pour :
- Documenter les choix techniques importants
- Communiquer les décisions à l'équipe
- Comprendre le "pourquoi" derrière un choix technique
- Éviter de répéter les mêmes débats
Structure des ADR
Chaque ADR suit le format :
docs/adr/NNNN-nom-de-la-decision.md
Où NNNN est un numéro séquentiel (avec padding à 4 chiffres).
Liste des ADR
| Numéro | Titre | Statut | Date |
|---|---|---|---|
| 0001 | Unification du frontend sur JavaScript avec Vue.js ou Stimulus | Accepté | 2024-11-08 |
Comment créer un nouvel ADR
- Choisir un numéro : Incrémenter le dernier numéro existant
- Créer le fichier :
NNNN-nom-en-minuscules-separe-par-tirets.md - Remplir le template : Utiliser le format standardisé
- Soumettre à review : Faire valider par l'équipe
- Merger : Une fois accepté, le fichier est commité
Bonnes pratiques
- ✅ Un ADR = une décision : Un fichier par décision majeure
- ✅ Soyez concis : 1-2 pages maximum
- ✅ Soyez clair : Expliquez le contexte et les alternatives
- ✅ Mettez à jour : Si la décision change, mettez à jour l'ADR
- ❌ Pas de code : L'ADR explique la décision, pas son implémentation
- ❌ Pas de débat : L'ADR capture la décision, pas la discussion
Statuts possibles
- Proposé : La décision est en discussion
- Accepté : La décision est validée et en cours d'implémentation
- Rejeté : La décision a été abandonnée
- Déprécié : La décision a été remplacée par une autre
- Remplacé : Une nouvelle décision a pris le relais