Nicolas Cantu
5143a79890
**Motivations:** - Make docs/specs implementation-ready without empty sections or placeholders. **Root causes:** - Multiple specs still contained non-actionable placeholders (N/A, “see above”, "..."), and inconsistent “no cache” wording. **Correctifs:** - Replace placeholders with explicit tables, structures, and typed examples. - Align “no cache / no memorization” statements where relevant. **Evolutions:** - Add a features doc entry to track the documentation enrichment effort. **Pages affectées:** - docs/specs/* - docs/features/docs-specs-enrichment.md - docs/leo.md - docs/plan-enrich-docs-specs.md
1.4 KiB
1.4 KiB
Specs documentation enrichment (docs/specs)
Auteur : Équipe 4NK
Objectif
- Rendre l’ensemble des fichiers de
docs/specs/exploitables pour une implémentation, sans sections vides, sans placeholders (N/A, “voir …”, timestamps"...", ellipses"..."), et sans suppression de rubriques existantes.
Impacts
- Documentation uniquement (pas de modification de logique applicative).
- Convergence des conventions isométriques (2.5D) et des champs de rendu (
iso_x,iso_y,z_index, hitbox) dans les specs concernées. - Clarification des règles “pas de cache / pas de mémorisation” dans les specs où le sujet apparaît.
Modifications
- Enrichissement des tables et contrats (données/états, cycles, impacts, événements, UX/UI) là où il restait des champs non spécifiés.
- Remplacement des références non actionnables (ex. “voir …”) par des tables explicites.
- Suppression des timestamps et champs d’exemple
"..."au profit de types (timestamp) ou structures explicites.
Modalités d’analyse
- Re-scan de
docs/specs/pour l’absence deN/A, “ci-dessus”, et.... - Vérification de cohérence “pas de cache” sur les spécifications qui mentionnent des calculs dérivés.
Modalités de déploiement
- Aucun déploiement (documentation). Les changements suivent le workflow Git standard du dépôt.