Aller au contenu principal

Processus documentation

Statut​

Document de cadrage opérations — version initiale.

Objectif​

La documentation DMV doit rester vivante, versionnée, maintenue et utile aux humains comme aux assistants IA.

Elle doit aider à comprendre le produit, l'architecture, les opérations, les décisions et les limites.

Périmètre​

La documentation couvre :

  • vision et gouvernance ;
  • produit ;
  • business ;
  • architecture ;
  • backend ;
  • frontend ;
  • data ;
  • sécurité ;
  • DevOps ;
  • apps connectées ;
  • opérations ;
  • roadmap ;
  • finance.

Principes​

  • Écrire en français clair.
  • Distinguer état actuel et vision cible.
  • Ne pas inventer de fonctionnalités.
  • Indiquer les points à clarifier.
  • Préférer des documents courts et structurés.
  • Mettre à jour quand une décision change.
  • Ne pas documenter une promesse comme un fait livré.

Processus de mise à jour​

  1. Identifier le changement : produit, technique, opérationnel ou business.
  2. Trouver les documents impactés.
  3. Modifier uniquement les pages concernées.
  4. Préciser état actuel, cible ou décision validée.
  5. Relire pour cohérence avec les documents voisins.
  6. Vérifier le format Markdown.
  7. Versionner avec le changement projet associé si possible.

Statuts recommandés​

StatutUsage
Version initialePremière rédaction structurée.
À confirmerHypothèse ou point non tranché.
ValidéDécision confirmée par le projet.
ObsolèteDocument conservé mais remplacé.
En révisionSujet en cours d'arbitrage.

Documentation et IA​

La documentation sert aussi de contexte aux assistants IA.

Elle doit donc :

  • être factuelle ;
  • éviter les contradictions ;
  • expliciter les limites ;
  • nommer les modules et fichiers quand utile ;
  • éviter les ambiguïtés entre cible et livré ;
  • contenir des points à clarifier.

L'IA peut aider à rédiger, résumer ou détecter des incohérences, mais la validation documentaire reste humaine.

Gouvernance documentaire​

Chaque document important doit avoir :

  • un titre clair ;
  • une section statut ;
  • un périmètre ;
  • des principes ;
  • un état actuel si pertinent ;
  • une vision cible si pertinente ;
  • des risques ou points à clarifier.

Risques et points à clarifier​

  • Responsable de maintenance documentaire.
  • Fréquence de revue.
  • Processus d'approbation.
  • Gestion des documents obsolètes.
  • Liens entre documentation et roadmap.
  • Usage documentaire par IA et agents.