Gabarit module¶
Utiliser ce gabarit pour chaque nouveau module documente.
Principes de redaction¶
- Documenter ce qui aide directement un developpeur a reprendre le module : fichiers, responsabilites, routes, schema, invariants, flux, risques, tests.
- Ne pas ajouter d'informations de contexte git qui ne guident pas l'action. Une branche n'est utile que si elle explique ou trouver le code a modifier pour un flux donne.
- Distinguer clairement ce qui est verifie dans le code, ce qui est deduit, et ce qui reste a confirmer.
- Ne pas lister des absences de fichiers ou de branches sauf si cette absence explique un risque concret de reprise, par exemple une migration manquante.
- Preferer les noms techniques exacts : classes, methodes, routes, tables, colonnes, statuts, permissions.
- Expliquer pourquoi une regle existe quand elle protege une decision metier ou un invariant technique.
- Retirer les details qui creent du doute sans changer l'action du lecteur.
# Nom du module
## Objectif
## Perimetre documente
## Points d'entree
## Architecture
## Donnees et schema
## Flux principaux
## Etats et statuts
## Integrations externes
## Risques et points d'attention
## Bugs connus ou signales
## Tests recommandes
## Commandes utiles
## Checklist de reprise
## Questions ouvertes