4nk/story-research-zapwall
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Ajout règle optimisation et mise à jour systématique documentation

Browse Source 
- 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
This commit is contained in:
Nicolas Cantu 2025-12-27 21:34:31 +01:00
parent a099f3c24a
commit 9edf4ac1bc
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.cursor/rules/quality.mdc
View File

@ -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. 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 ### Critères d’acceptation implicites
Le code final doit : Le code final doit :