Skip to content

Latest commit

 

History

History
22 lines (13 loc) · 1.19 KB

coherence.md

File metadata and controls

22 lines (13 loc) · 1.19 KB

Garder la cohérence de la documentation

La documentation (utilisateur, administrateur, code) cible une release du logiciel. Elle se doit d'être en cohérence avec cette release.

Il faut donc pouvoir contrôler la cohérence de la documentation avec la release ciblée.

Si la documentation n'est pas cohérente avec la release cela veut dire que la documentation utilisateur ne documente pas les fonctionnalités supportées par le logiciel, qu'elle n'explique pas comment installer le logiciel, etc.

Objectif

Mettre en place un suivi de la cohérence nécessite de bien versionner la documentation (c.f. versionner la documentation), de bien versionner les releases (c.f. horodater les releases) et enfin de préciser la cohérence entre ces versions.

L'objectif est de pouvoir mesurer le niveau de cohérence d'une documentation par rapport à une release donnée.

Contrôle

Vérifier la documentation du code source ne peut se faire que par l'audit d'un expert.

L'expert va vérfier que la cohérence entre les versions de la documentation et les version des releases.