cf7a46be27
- Déplacer TECHNICAL.md vers docs/ pour cohérence - Renommer docs/index.md en docs/README.md (convention GitHub) - Créer docs/adr/README.md comme index des ADR - Supprimer docs/REFACTOR-DDD.md (plan appliqué) - Supprimer docs/technical.md (doublon) - Mettre à jour tous les liens internes - Mettre à jour mkdocs.yml pour nouvelle structure Structure finale : - README.md : vue d'ensemble projet (GitHub) - docs/README.md : page d'accueil documentation (MkDocs) - docs/TECHNICAL.md : architecture technique - docs/adr/README.md : index des 25 ADR
4.3 KiB
4.3 KiB
Architecture Decision Records (ADR)
Documentation des décisions architecturales importantes du projet RoadWave
Vue d'ensemble
Les Architecture Decision Records (ADR) documentent les décisions techniques importantes prises au cours du développement de RoadWave. Chaque ADR suit un format standardisé : contexte, décision, alternatives considérées et conséquences.
Index des ADR
Core Architecture
| ADR | Titre | Statut | Date |
|---|---|---|---|
| ADR-001 | Langage Backend | ✅ Accepté | 2025-01-17 |
| ADR-010 | Architecture Backend | ✅ Accepté | 2025-01-25 |
| ADR-011 | ORM et Accès Données | ✅ Accepté | 2025-01-26 |
| ADR-012 | Frontend Mobile | ✅ Accepté | 2025-01-26 |
| ADR-014 | Organisation en Monorepo | ✅ Accepté | 2025-01-28 |
Data & Infrastructure
| ADR | Titre | Statut | Date |
|---|---|---|---|
| ADR-005 | Base de données | ✅ Accepté | 2025-01-20 |
| ADR-021 | Solution de Cache | ✅ Accepté | 2025-02-01 |
| ADR-015 | Hébergement | ✅ Accepté | 2025-01-28 |
| ADR-019 | Géolocalisation par IP | ✅ Accepté | 2025-01-30 |
Streaming & Content
| ADR | Titre | Statut | Date |
|---|---|---|---|
| ADR-002 | Protocole Streaming | ✅ Accepté | 2025-01-18 |
| ADR-003 | Codec Audio | ✅ Accepté | 2025-01-19 |
| ADR-004 | CDN | ✅ Accepté | 2025-01-20 |
Security & Auth
| ADR | Titre | Statut | Date |
|---|---|---|---|
| ADR-006 | Chiffrement | ✅ Accepté | 2025-01-21 |
| ADR-008 | Authentification | ✅ Accepté | 2025-01-24 |
| ADR-025 | Sécurité & Secrets | ✅ Accepté | 2025-02-04 |
Testing & Quality
| ADR | Titre | Statut | Date |
|---|---|---|---|
| ADR-007 | Tests BDD | ✅ Accepté | 2025-01-22 |
| ADR-013 | Stratégie Tests | ✅ Accepté | 2025-01-27 |
| ADR-022 | CI/CD Monorepo | ✅ Accepté | 2025-02-02 |
Features & Operations
| ADR | Titre | Statut | Date |
|---|---|---|---|
| ADR-009 | Solution Paiement | ✅ Accepté | 2025-01-24 |
| ADR-016 | Service Emailing | ✅ Accepté | 2025-01-29 |
| ADR-017 | Notifications Géolocalisées | ✅ Accepté | 2025-01-30 |
| ADR-018 | Librairies Go | ✅ Accepté | 2025-01-30 |
| ADR-020 | Librairies Flutter | ✅ Accepté | 2025-01-31 |
| ADR-023 | Architecture Modération | ✅ Accepté | 2025-02-03 |
| ADR-024 | Monitoring & Observabilité | ✅ Accepté | 2025-02-03 |
Vue d'ensemble technique consolidée
Pour une vue d'ensemble de l'architecture et de la stack technique, consultez docs/TECHNICAL.md.
Légende des statuts
- ✅ Accepté : Décision validée et appliquée
- 🟡 Proposé : En discussion
- ⏸️ Suspendu : Temporairement en attente
- ❌ Rejeté : Décision rejetée (conservée pour historique)
- 🔄 Révisé : Décision modifiée, voir ADR plus récent
Créer un nouvel ADR
Pour documenter une nouvelle décision architecturale :
- Créer un fichier
XXX-titre-court.md(numérotation séquentielle) - Utiliser le template suivant :
# ADR-XXX : Titre de la décision
**Statut** : Proposé/Accepté/Rejeté
**Date** : YYYY-MM-DD
## Contexte
Pourquoi cette décision est nécessaire ? Quel problème résout-elle ?
## Décision
Quelle solution avons-nous choisie ?
## Alternatives considérées
Quelles autres options ont été évaluées ?
## Conséquences
### Positives
- Avantage 1
- Avantage 2
### Négatives
- Limitation 1
- Compromis accepté
## Références
- Liens vers documentation externe
- Benchmarks
- Articles de référence
- Ajouter l'ADR dans ce fichier README.md et dans
mkdocs.yml
Dernière mise à jour : 2026-02-07