Aller au contenu principal

Règles documentation

Statut

Document de règles projet — version initiale.

Objectif

Faire de la documentation DMV une mémoire fiable pour humains, développeurs, IA, agents et futures équipes.

Règles strictes

  • Chaque document important doit avoir une section Statut.
  • Ne jamais présenter une vision cible comme livrée.
  • Ne jamais inventer de chiffres, dates ou fonctionnalités.
  • Ne modifier que les fichiers demandés lors d'une tâche cadrée.
  • Garder les documents en français clair.
  • Mentionner les points à clarifier.
  • Ne pas dupliquer inutilement un document voisin.

Structure standard

Recommandation :

  • titre ;
  • statut ;
  • objectif ;
  • périmètre ;
  • état actuel ;
  • vision cible ;
  • règles ou principes ;
  • risques ;
  • points à clarifier.

Statuts utiles

StatutUsage
Version initialePremière rédaction.
À confirmerHypothèse non validée.
ValidéDécision confirmée.
En révisionDocument en transition.
ObsolèteRemplacé mais conservé.

Règles pour IA

Une IA doit :

  • lire les documents existants avant de rédiger ;
  • conserver le ton officiel ;
  • éviter les contradictions ;
  • distinguer visible, cible et à confirmer ;
  • ne pas modifier le code pour une tâche documentaire ;
  • contrôler le périmètre final.

Anti-patterns

  • Documentation marketing.
  • Documentation copiée-collée entre apps.
  • Absence de statut.
  • Longs paragraphes abstraits.
  • Liste de fonctionnalités non livrées sans mention cible.
  • Règles dispersées dans plusieurs fichiers contradictoires.

État actuel vs cible

SujetÉtat actuelCible
Master BookEn construction.Référence officielle maintenue.
RulesAnciennes pages vides et nouvelles pages numérotées.Source stable et organisée.
IAUtilise docs comme contexte.Documentation exploitable par agents.

Points à clarifier

  • Responsable documentaire.
  • Fréquence de revue.
  • Processus de validation.
  • Index officiel des règles.