From 9edf4ac1bce64061ad47c41e5faff3475eec0282 Mon Sep 17 00:00:00 2001 From: Nicolas Cantu Date: Sat, 27 Dec 2025 21:34:31 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20Ajout=20r=C3=A8gle=20optimisation=20et?= =?UTF-8?q?=20mise=20=C3=A0=20jour=20syst=C3=A9matique=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Ajout section dédiée dans quality.mdc - Règles obligatoires pour fidélité au code - Éviter répétitions et centraliser documentation - Mise à jour systématique lors modifications - Optimisation continue et vérification --- .cursor/rules/quality.mdc | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/.cursor/rules/quality.mdc b/.cursor/rules/quality.mdc index 1965a57..86645fd 100644 --- a/.cursor/rules/quality.mdc +++ b/.cursor/rules/quality.mdc @@ -207,6 +207,32 @@ Les invariants critiques doivent être vérifiés explicitement. En cas de viola Les interfaces doivent éviter les paramètres optionnels fourre-tout. Les objets de configuration typés sont préférés, avec des champs requis ou optionnels clairement justifiés. +### Optimisation et mise à jour systématique de la documentation + +La documentation doit être optimisée et mise à jour systématiquement lors de toute modification du code. + +**Règles obligatoires** : + +* **Fidélité au code** : La documentation doit refléter fidèlement l’état actuel du code. Toute modification de code doit entraîner une mise à jour de la documentation correspondante. + +* **Éviter les répétitions** : Fusionner les documents redondants. Un même concept ne doit être documenté qu’une seule fois, dans le document le plus approprié. + +* **Centralisation** : La documentation technique doit être centralisée dans `docs/` et les fonctionnalités dans `features/`. Éviter la dispersion de l’information. + +* **Mise à jour lors des modifications** : Lors de toute modification de code, fonctionnalité ou architecture : + - Vérifier si la documentation existante est obsolète + - Mettre à jour ou supprimer les sections obsolètes + - Fusionner les documents similaires + - Supprimer les documents redondants + +* **Optimisation continue** : + - Supprimer les documents obsolètes (code supprimé, fonctionnalités remplacées) + - Fusionner les documents qui se chevauchent + - Maintenir une structure claire et navigable + - Éviter les doublons entre `docs/` et `features/` + +* **Vérification** : Avant de finaliser une modification, vérifier que la documentation est à jour et cohérente avec le code. + ### Critères d’acceptation implicites Le code final doit :