Aller au contenu

docs-check

docs-check est la première étape obligatoire du workflow documentaire.

Cette page décrit uniquement son usage opérateur.

Rôle pratique

docs-check sert à bloquer une publication documentaire tant que la base n'est pas propre.

En pratique, on l'utilise pour détecter :

  • problèmes de build ;
  • incohérences de navigation ;
  • pages vides ou incomplètes ;
  • liens cassés ;
  • défauts documentaires bloquants.

Position dans le workflow

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

On ne saute pas cette étape.

Quand l’utiliser

Lancer docs-check :

  • avant toute publication de documentation ;
  • après une réorganisation de structure ;
  • après création ou déplacement de pages ;
  • avant docs-report si le lot a beaucoup bougé.

Ce qu’on attend du résultat

Résultat attendu :

  • build documentaire OK ;
  • navigation cohérente ;
  • aucun blocage structurel ;
  • base prête pour un rapport.

Si docs-check échoue, on corrige d’abord. On ne publie pas.

Garde-fous

docs-check ne doit pas :

  • modifier les fichiers ;
  • masquer les défauts ;
  • être traité comme une formalité facultative ;
  • remplacer une relecture documentaire humaine.

Voir aussi