- Ajouter ADR-018 (librairies Go) dans TECHNICAL.md - Transformer Shared en menu dépliable dans mkdocs (cohérence avec autres domaines) - Corriger listes markdown (ajout lignes vides avant listes) - Corriger line breaks dans génération BDD (étapes "Et" sur nouvelles lignes) - Ajouter script fix-markdown-lists.sh pour corrections futures Impacte 86 fichiers de documentation et 164 fichiers BDD générés.
127 lines
4.3 KiB
Markdown
127 lines
4.3 KiB
Markdown
# 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](001-langage-backend.md) | Langage Backend | ✅ Accepté | 2025-01-17 |
|
|
| [ADR-010](010-architecture-backend.md) | Architecture Backend | ✅ Accepté | 2025-01-25 |
|
|
| [ADR-011](011-orm-acces-donnees.md) | ORM et Accès Données | ✅ Accepté | 2025-01-26 |
|
|
| [ADR-012](012-frontend-mobile.md) | Frontend Mobile | ✅ Accepté | 2025-01-26 |
|
|
| [ADR-014](014-organisation-monorepo.md) | Organisation en Monorepo | ✅ Accepté | 2025-01-28 |
|
|
|
|
### Data & Infrastructure
|
|
|
|
| ADR | Titre | Statut | Date |
|
|
|-----|-------|--------|------|
|
|
| [ADR-005](005-base-de-donnees.md) | Base de données | ✅ Accepté | 2025-01-20 |
|
|
| [ADR-021](021-solution-cache.md) | Solution de Cache | ✅ Accepté | 2025-02-01 |
|
|
| [ADR-015](015-hebergement.md) | Hébergement | ✅ Accepté | 2025-01-28 |
|
|
| [ADR-019](019-geolocalisation-ip.md) | Géolocalisation par IP | ✅ Accepté | 2025-01-30 |
|
|
|
|
### Streaming & Content
|
|
|
|
| ADR | Titre | Statut | Date |
|
|
|-----|-------|--------|------|
|
|
| [ADR-002](002-protocole-streaming.md) | Protocole Streaming | ✅ Accepté | 2025-01-18 |
|
|
| [ADR-003](003-codec-audio.md) | Codec Audio | ✅ Accepté | 2025-01-19 |
|
|
| [ADR-004](004-cdn.md) | CDN | ✅ Accepté | 2025-01-20 |
|
|
|
|
### Security & Auth
|
|
|
|
| ADR | Titre | Statut | Date |
|
|
|-----|-------|--------|------|
|
|
| [ADR-006](006-chiffrement.md) | Chiffrement | ✅ Accepté | 2025-01-21 |
|
|
| [ADR-008](008-authentification.md) | Authentification | ✅ Accepté | 2025-01-24 |
|
|
| [ADR-025](025-securite-secrets.md) | Sécurité & Secrets | ✅ Accepté | 2025-02-04 |
|
|
|
|
### Testing & Quality
|
|
|
|
| ADR | Titre | Statut | Date |
|
|
|-----|-------|--------|------|
|
|
| [ADR-007](007-tests-bdd.md) | Tests BDD | ✅ Accepté | 2025-01-22 |
|
|
| [ADR-013](013-strategie-tests.md) | Stratégie Tests | ✅ Accepté | 2025-01-27 |
|
|
| [ADR-022](022-strategie-cicd-monorepo.md) | CI/CD Monorepo | ✅ Accepté | 2025-02-02 |
|
|
|
|
### Features & Operations
|
|
|
|
| ADR | Titre | Statut | Date |
|
|
|-----|-------|--------|------|
|
|
| [ADR-009](009-solution-paiement.md) | Solution Paiement | ✅ Accepté | 2025-01-24 |
|
|
| [ADR-016](016-service-emailing.md) | Service Emailing | ✅ Accepté | 2025-01-29 |
|
|
| [ADR-017](017-notifications-geolocalisees.md) | Notifications Géolocalisées | ✅ Accepté | 2025-01-30 |
|
|
| [ADR-018](018-librairies-go.md) | Librairies Go | ✅ Accepté | 2025-01-30 |
|
|
| [ADR-020](020-librairies-flutter.md) | Librairies Flutter | ✅ Accepté | 2025-01-31 |
|
|
| [ADR-023](023-architecture-moderation.md) | Architecture Modération | ✅ Accepté | 2025-02-03 |
|
|
| [ADR-024](024-monitoring-observabilite.md) | 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](../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 :
|
|
|
|
1. Créer un fichier `XXX-titre-court.md` (numérotation séquentielle)
|
|
2. Utiliser le template suivant :
|
|
|
|
```markdown
|
|
# 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
|
|
```
|
|
|
|
3. Ajouter l'ADR dans ce fichier README.md et dans `mkdocs.yml`
|
|
|
|
---
|
|
|
|
**Dernière mise à jour** : 2026-02-07
|