Qu'est-ce que la documentation du logiciel? (Avec des photos)
Le terme logiciel désigne les routines et les programmes développés pour un système informatique permettant à l'utilisateur d'effectuer des tâches ou d'interagir avec l'ordinateur. Le logiciel peut être fourni par le fabricant en tant que composant système ou créé sous la forme d'applications distinctes par le fabricant ou par des tiers. La documentation est une description d'un produit et de son utilisation. La documentation logicielle décrit les applications logicielles et leur utilisation.
La documentation logicielle imprimée, parfois appelée manuels de logiciel, est souvent configurée comme un livre, avec une page de titre, une table des matières, un corps et un index, et comporte souvent des composants typiques. Le premier composant dont la plupart des utilisateurs ont besoin est un guide d'installation. Des guides distincts sont fournis pour les différents systèmes d'exploitation sur lesquels le logiciel fonctionne, selon les besoins. Le guide d'installation répertorie les spécifications requises pour exécuter le logiciel, notamment le (s) système (s) d'exploitation, la mémoire vive (RAM), l'espace disque, une connexion Internet et toute autre configuration requise ou complémentaire, tels que des périphériques. Cette opération est suivie d'instructions pas à pas pour l'installation, qui peuvent provenir d'un CD-ROM, d'un DVD ou d'un téléchargement, par exemple. Toute caractéristique inhabituelle du programme d'installation et toute explication des choix d'installation personnalisée, tels que les emplacements alternatifs ou les installations simplifiées, sont généralement expliquées.
Un guide de «démarrage rapide» constitue souvent la partie suivante de la documentation du logiciel imprimé utilisée. Relevant l'endroit où le guide d'installation s'arrête, le guide de démarrage rapide aide l'utilisateur à se familiariser avec le logiciel et ses opérations de base. Cette section peut être agencée de différentes manières, selon le logiciel utilisé. Une méthode populaire pour les applications orientées tâche est une introduction basée sur un projet dans laquelle l'utilisateur apprend les fonctionnalités de base du logiciel tout en effectuant quelques mini-leçons.
Parmi les autres éléments que l’on pourrait s’attendre à trouver dans la documentation du logiciel imprimé, on peut citer un aperçu complet des fonctionnalités, en mettant l’accent sur les fonctionnalités nouvelles de la dernière version; une liste des mises à jour depuis les versions précédentes, avec éventuellement des bugs corrigés; des informations sur la manière d'obtenir un support technique; explications des messages d'erreur; et des informations pour les utilisateurs avancés ou «puissants». Les jeux et autres applications logicielles peuvent inclure des aide-mémoire ou des astuces dans leur documentation.
La documentation logicielle imprimée n'est pas la seule. Tout d'abord, la documentation imprimée peut également être disponible en ligne ou en pdf. Une documentation supplémentaire peut également être disponible sous la forme de bulles d’outils et d’écrans d’aide dans l’application elle-même, des FAQ - listes de questions fréquemment posées ainsi que des réponses, des articles interrogeables, une formation Web, des vidéos et d’autres formats.
La qualité de la documentation des logiciels varie quelque peu, et cela est particulièrement vrai des manuels de logiciels. Les bons peuvent être excellents, tandis que ceux qui ne sont pas bien exécutés peuvent laisser de nombreuses questions aux utilisateurs. Il existe également des utilisateurs qui ne chercheront pas dans la documentation avant de poser des questions sur les forums du fabricant du logiciel.