Qu'est-ce que la documentation logicielle?
Logiciel fait référence aux routines et aux programmes développés pour un système informatique qui permettent à l'utilisation d'effectuer des tâches ou d'interagir autrement avec l'ordinateur.Le logiciel pourrait être fourni par le fabricant en tant que composant système ou créé comme applications distinctes par le fabricant ou les tiers. Documentation est une description d'un produit et comment l'utiliser.La documentation logicielle décrit les applications logicielles et comment les utiliser.
La documentation logicielle imprimée, parfois appelée manuels logiciels, est souvent configurée comme un livre, avec une page de titre, une table des matières, un corps et un index, et ils ont souventQuelques composants typiques.Le premier composant dont les utilisateurs ont besoin est un guide d'installation, et des guides séparés sont donnés 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 nécessaires pour exécuter le logiciel, y compris le ou les systèmes d'exploitation informatique, la RAM, l'espace de disque dur, une connexion Internet et toute autre exigence ou complément, telles que les périphériques.Ceci est suivi avec des instructions étape par étape pour l'installation, qui pourraient provenir d'un CD-ROM, d'un DVD ou d'un téléchargement, par exemple.Toutes les caractéristiques inhabituelles de l'installateur et l'explication des choix d'installation personnalisées, telles que des emplacements alternatifs ou des installations rationalisées, sont généralement expliquées.
Un guide de «démarrage rapide» est souvent la partie suivante de la documentation logicielle imprimée utilisée.Ramassant là où le guide d'installation quitte, le guide de démarrage rapide aide l'utilisateur à démarrer avec le logiciel et ses opérations de base.Cette section peut être organisée de diverses manières, car il convient au logiciel particulier.Une méthode populaire pour les applications axées sur les tâches est une introduction basée sur des projets dans laquelle l'utilisateur apprend les fonctionnalités de base du logiciel tout en terminant certaines mini-unités.
D'autres éléments que l'on s'attendrait à trouver dans la documentation logicielle imprimée incluent un aperçu complet des fonctionnalités, en mettant l'accent sur les fonctionnalités nouvelles de la dernière version;une liste de mises à jour depuis les versions précédentes, incluant éventuellement des bogues corrigées;des informations sur la façon d'obtenir un support technique;explications des messages d'erreur;et des informations pour les utilisateurs avancés ou «puissance».Les jeux et autres applications logicielles peuvent inclure des feuilles de triche ou des conseils dans leur documentation.
La documentation logicielle imprimée n'est pas le seul type.Tout d'abord, la documentation imprimée peut également être disponible en ligne ou en tant que PDF.Des documents supplémentaires peuvent également être disponibles sous forme de conseils d'outils et d'aide aux écrans de l'application elle-même, FAQS mdash;listes de questions fréquemment posées ainsi que des réponses, des articles consultables, une formation Web, des vidéos et d'autres formats.
La documentation logicielle varie un peu en qualité, ce qui est particulièrement vrai pour les manuels logiciels.Les bons peuvent être excellents, tandis que ceux qui ne sont pas bien exécutés peuvent laisser les utilisateurs avec de nombreuses questions.Il y a aussi des utilisateurs qui ne prendront pas la peine de rechercher la documentation avant de poser des questions sur les forums du fabricant de logiciels.