Documentation logicielle
Documentation logicielle La documentation logicielle est un texte, souvent accompagné de captures d'écran, qui décrit le fonctionnement et/ou l'utilisation d'un logiciel. Sa signification peut varier selon les profils. Elle est une partie importante, et souvent négligée, de l'ingénierie logicielle.
Types de documentation[modifier]
Il existe différents types de documentation :
- Expression de besoin : Définition du besoin métier.
- Architecture / Conception : Vue d'ensemble du logiciel, relations avec l'environnement et principes de conception.
- Technique : Documentation du code, algorithmes, interfaces et interfaces de programmation (API).
- Utilisateur : Manuels pour utilisateurs, administrateurs et support.
- Marketing : Instructions produit et promotion.
Architecture et conception[modifier]
La documentation d'architecture est un type particulier de document de conception. Elle décrit les exigences générales motivant l'existence d'une fonction, sans détailler son implémentation. Un bon document d'architecture est concis et riche en explications.
Un autre type de document de conception est le document de comparaison, souvent sous forme de livre blanc. Il se concentre sur un aspect du système et propose des alternatives, en soulignant les avantages et inconvénients de chacune. L'objectif est d'identifier la meilleure solution de manière impartiale.
Documentation technique[modifier]
La documentation technique décrit le fonctionnement interne du logiciel. On distingue :
- La documentation du logiciel d'exploitation, expliquant l'utilisation du matériel.
- La documentation des logiciels d'application, expliquant l'utilisation du logiciel.
Elle est généralement incluse dans le code source pour faciliter l'accès. Des outils comme Doxygen ou Javadoc permettent de générer automatiquement la documentation à partir des commentaires du code source. Donald Knuth recommande la programmation lettrée, où documentation et code sont écrits ensemble.
Documentation utilisateur[modifier]
Contrairement à la documentation technique, la documentation utilisateur décrit l'utilisation du logiciel sans entrer dans les détails du code. Elle décrit chaque fonctionnalité et les étapes pour l'utiliser. Il existe trois manières d'organiser la documentation utilisateur :
- Tutoriel : Guide pas-à-pas pour les nouveaux utilisateurs.
- Thématique : Organisation par thèmes pour les utilisateurs intermédiaires.
- Liste : Liste alphabétique des commandes pour les utilisateurs avancés.
Documentation marketing[modifier]
La documentation marketing vise à promouvoir le logiciel. Ses objectifs sont :
- Susciter l'intérêt et le désir d'utiliser le produit.
- Informer sur les fonctionnalités du produit.
- Positionner le produit par rapport à la concurrence.
