refactor(docs): réorganiser la documentation selon principes DDD
Réorganise la documentation du projet selon les principes du Domain-Driven Design (DDD) pour améliorer la cohésion, la maintenabilité et l'alignement avec l'architecture modulaire du backend. **Structure cible:** ``` docs/domains/ ├── README.md (Context Map) ├── _shared/ (Core Domain) ├── recommendation/ (Supporting Subdomain) ├── content/ (Supporting Subdomain) ├── moderation/ (Supporting Subdomain) ├── advertising/ (Generic Subdomain) ├── premium/ (Generic Subdomain) └── monetization/ (Generic Subdomain) ``` **Changements effectués:** Phase 1: Création de l'arborescence des 7 bounded contexts Phase 2: Déplacement des règles métier (01-19) vers domains/*/rules/ Phase 3: Déplacement des diagrammes d'entités vers domains/*/entities/ Phase 4: Déplacement des diagrammes flux/états/séquences vers domains/*/ Phase 5: Création des README.md pour chaque domaine Phase 6: Déplacement des features Gherkin vers domains/*/features/ Phase 7: Création du Context Map (domains/README.md) Phase 8: Mise à jour de mkdocs.yml pour la nouvelle navigation Phase 9: Correction automatique des liens internes (script fix-markdown-links.sh) Phase 10: Nettoyage de l'ancienne structure (regles-metier/, diagrammes/, features/) **Configuration des tests:** - Makefile: godog run docs/domains/*/features/ - scripts/generate-bdd-docs.py: features_dir → docs/domains **Avantages:** ✅ Cohésion forte: toute la doc d'un domaine au même endroit ✅ Couplage faible: domaines indépendants, dépendances explicites ✅ Navigabilité améliorée: README par domaine = entrée claire ✅ Alignement code/docs: miroir de backend/internal/ ✅ Onboarding facilité: exploration domaine par domaine ✅ Tests BDD intégrés: features au plus près des règles métier Voir docs/REFACTOR-DDD.md pour le plan complet.
This commit is contained in:
36
docs/domains/advertising/README.md
Normal file
36
docs/domains/advertising/README.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Domaine : Advertising
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Le domaine **Advertising** gère la diffusion de publicités audio ciblées. C'est un **Generic Subdomain** qui constitue une source de revenus importante pour la plateforme.
|
||||
|
||||
## Responsabilités
|
||||
|
||||
- **Campagnes publicitaires** : Création et gestion des campagnes
|
||||
- **Ciblage** : Ciblage géographique et par centres d'intérêt
|
||||
- **Métriques** : Suivi des impressions, écoutes et performances
|
||||
- **Insertion dynamique** : Insertion de publicités dans les flux audio
|
||||
|
||||
## Règles métier
|
||||
|
||||
- [Publicités](rules/publicites.md)
|
||||
|
||||
## Modèle de données
|
||||
|
||||
- [Diagramme entités publicités](entities/modele-publicites.md) - Entités : AD_CAMPAIGNS, AD_METRICS, AD_IMPRESSIONS
|
||||
|
||||
## Ubiquitous Language
|
||||
|
||||
**Termes métier du domaine** :
|
||||
- **Ad Campaign** : Campagne publicitaire avec budget et durée
|
||||
- **Ad Impression** : Affichage/lecture d'une publicité
|
||||
- **Ad Targeting** : Critères de ciblage (geo + intérêts)
|
||||
- **CPM (Cost Per Mille)** : Coût pour 1000 impressions
|
||||
- **Ad Insertion** : Insertion dynamique dans le flux audio
|
||||
- **Skip Rate** : Taux de publicités sautées par les utilisateurs
|
||||
|
||||
## Dépendances
|
||||
|
||||
- ✅ Dépend de : `_shared` (users, listening history)
|
||||
- ✅ Dépend de : `recommendation` (ciblage par intérêts)
|
||||
- ⚠️ Bloqué par : `premium` (pas de pub pour abonnés premium)
|
||||
Reference in New Issue
Block a user