Aller au contenu

docs-report

docs-report est l’étape de mesure documentaire qui suit docs-check.

Cette page décrit son usage opérateur et sa lecture rapide.

Rôle pratique

docs-report sert à répondre à une question simple :

où en est réellement la documentation après validation structurelle ?

En pratique, il permet de mesurer :

  • le volume documentaire ;
  • le niveau de complétude ;
  • l’état des sections ;
  • les zones encore faibles ou vides.

Position dans le workflow

docs-check
-> docs-report
-> docs-deploy

Quand l’utiliser

Lancer docs-report :

  • après un docs-check propre ;
  • avant une publication ;
  • après une grosse campagne de rédaction ;
  • pour suivre la progression documentaire d’un chantier.

Comment lire le rapport

Lire en priorité :

  • nombre total de pages ;
  • pages rédigées vs incomplètes ;
  • sections encore fragiles ;
  • cohérence globale de la couverture documentaire.

Le rapport ne juge pas toute la qualité rédactionnelle. Il donne d’abord une vision structurelle et quantitative.

Décision après rapport

Après docs-report :

  • si le lot est propre et cohérent : on peut envisager docs-deploy ;
  • si la structure est propre mais le contenu encore faible : on complète avant publication ;
  • si certaines zones critiques sont vides : on bloque la diffusion.

Garde-fous

docs-report ne doit pas :

  • remplacer une revue humaine ;
  • faire croire qu’un bon score suffit ;
  • publier à lui seul ;
  • masquer des incohérences métier dans la documentation.

Voir aussi