Une documentation donne des informations sur les différents aspects d'un logiciel. Il existe donc différentes documentations en fonction des aspects tels que :
- La documentation du code
- La documentation utilisateur.
- La documentation administrateur.
Le principal aspect de qualité d'une documentation vient de son utilité et du fait qu'elle soit à jour.
Par là, on entend le fait que la documentation doit avant toute chose intéresser sa cible. Par exemple, une documentation utilisateur doit détailler toutes les fonctionnalités accessibles par l'utilisateur.
Toutes les documentations ne sont pas obligatoires. L'existance d'une documentation est subjective et contextuelle.
Pour autant, nous qu'il faut au moins prêter attention :
- à la documentation du code (même si tout le code ne doit pas être commenté)
- à la documentation utilisateur (mais uniquement pour les points où il en aura absolument besoin)
- à la documentation administrateur (pour déployer et exécuter le logiciel)
Enfin, pour faire en sorte que la documentation soit à jour, il faut que celle-ci soit versionnée et qu'il soit possible de mesurer sa cohérence avec le logiciel.