La documentation du système comprend des éléments écrits utilisés pour décrire les applications d'un système informatique ou logiciel. La documentation peut être affichée sous forme de manuels imprimés, de cartes flash, de pages Web ou de texte d'aide à l'écran. La documentation du système est un élément essentiel du succès de tout système informatique. Cependant, de nombreux développeurs ont du mal à créer une documentation suffisante pour leurs produits. Différents types de documentation ont des objectifs différents, le contenu de toute documentation dépend donc du public auquel il est destiné.
Documentation du projet
Le but de la documentation de projet décrit le projet dans son ensemble. La documentation du projet donne aux cadres, aux gestionnaires et aux employés une vue d'ensemble des méthodes, des ressources et des objectifs proposés. Les documents de proposition de projet indiquent aux responsables les objectifs et le budget du projet. Les spécifications techniques décrivent la configuration matérielle et logicielle requise pour les projets. Le plan de projet détaille les étapes que les programmeurs, techniciens et concepteurs suivront pour atteindre les objectifs du projet.
Documentation de test
Les documents de test illustrent les plans de test du produit avant sa sortie. Le service d’assurance qualité élabore des plans de test pour les utilisateurs "alpha" internes et les testeurs "bêta" externes.La documentation de test comprend des instructions de test, telles qu'un ensemble spécifique d'étapes à suivre par les testeurs, pour déterminer si le produit fonctionne comme prévu. Les membres du personnel d’AQ collectent également des journaux de problèmes, des listes de bogues et des rapports des testeurs.
Documentation de l'équipe
L'échange d'idées entre les membres de l'équipe est essentiel à la réussite d'un projet. La documentation de l’équipe enregistre ces échanges pour les utiliser dans le projet en cours et dans les projets futurs. Les plans d'équipe, les calendriers et les mises à jour de statut sont des composants majeurs de la documentation de l'équipe. Les listes de contrôle aident les responsables de projet à identifier les tâches que l'équipe a effectuées. Les procès-verbaux des réunions d'équipe permettent aux responsables de suivre divers problèmes, suggestions et tâches entre les membres de l'équipe.
Documentation utilisateur
L'élément le plus important de la documentation système est le contenu qui parvient au client. La documentation utilisateur doit être exempte de jargon excessivement technique et contenir un langage clair et concis. Le manuel d'utilisation est généralement le composant principal de la documentation utilisateur, mais les utilisateurs ont également recours à d'autres sources. Les ressources de formation - y compris les manuels et les vidéos - peuvent aider les utilisateurs à comprendre rapidement et facilement le fonctionnement du système. Lorsque le système ne fonctionne pas comme prévu, un guide de dépannage peut aider l'utilisateur à trouver et à résoudre le problème.
