Ce dossier docs/ regroupe l’ensemble des documents de conception, organisation et développement du projet numérique du club de volley de Saint Barthélemy d’Anjou.
L’objectif de cette documentation est double :
- Fournir une vision claire et structurée du projet pour tous les contributeurs
- Servir de référence technique tout au long du développement et de la maintenance
Ce README agit comme un sommaire détaillé, expliquant le rôle de chaque document et la manière dont ils s’enchaînent dans le cycle de développement.
- Type de projet : Site web + back-office
- Architecture : MERN (MongoDB, Express, React, Node.js)
- Public cible : visiteurs, adhérents, bénévoles, administrateurs du club
- Objectif principal : structurer et professionnaliser la présence numérique du club
docs/
├── workflow/
├── cahier-des-charges/
├── uml/
├── cartographies/
├── maquettes/
├── data-conception/
└── README.md
Chaque dossier correspond à une étape clé du cycle projet, de l’idée au code.
- Résumé du workflow Git (branches, commits, releases)
- Règles de nommage (branches, commits, versions)
- Processus CI/CD (GitHub Actions)
- Fonctionnement de pre-commit (linters, formatters)
- Garantir une qualité de code constante
- Uniformiser les pratiques entre développeurs
- Sécuriser les merges vers
main
👉 À consulter avant de commencer à coder
- Contexte du club
- Objectifs fonctionnels et stratégiques
- Périmètre du projet
- Contraintes (budget, RGPD, technique)
- Planning prévisionnel
- Critères de validation
- Servir de référence fonctionnelle
- Justifier les choix techniques
- Éviter les dérives fonctionnelles (scope creep)
👉 Document de référence fonctionnel (non technique)
- Diagrammes de cas d’utilisation
- Diagrammes de classes
- Diagrammes de séquence
- Diagrammes d’activité (si présents)
- Décrire le comportement de l’application
- Clarifier les interactions :
- utilisateur ↔ front
- front ↔ API
- API ↔ base de données
👉 Pont entre le fonctionnel et le code
- Cartographie applicative
- Cartographie des flux de données
- Séparation Front / Back / Services externes
- Intégrations tierces (FFVB, SportEasy, Google Maps…)
- Visualiser l’architecture globale
- Identifier les dépendances
- Anticiper les points critiques (scraping, APIs externes)
👉 Très utile pour l’onboarding et la maintenance
- Maquettes desktop & mobile
- Parcours utilisateur
- Pages publiques
- Interfaces back-office
- Aligner design, UX et développement
- Réduire les allers-retours front-end
- Garantir la cohérence avec la charte graphique
👉 Référence principale pour le développement React
- Dictionnaire de données
- MCD (Modèle Conceptuel de Données)
- MLD (Modèle Logique de Données)
- MPD (Modèle Physique – MongoDB)
- Règles de gestion des données
- Structurer la base MongoDB
- Garantir la cohérence des schémas
- Faciliter l’écriture des modèles Mongoose
- Préparer l’historisation (saisons, archives)
👉 Document central pour le back-end