Différents types de documentation du système

Documentation du projet

• Le but de la documentation du projet décrit le projet dans son ensemble. La documentation du projet donne les cadres, les gestionnaires et les employés une vue d'ensemble des méthodes proposées, les ressources et les objectifs du projet. Les documents de la proposition de projet montrent cadres les objectifs et le budget du projet. Les spécifications techniques définissent les exigences matérielles et logicielles pour les projets. Le plan de projet détaille les étapes les programmeurs, techniciens et concepteurs prendront pour atteindre les objectifs du projet.

Documentation de test

• 
  
  
  
  

  documents de test illustrent les plans pour tester le produit avant sa sortie. Le département d'assurance de la qualité élabore des plans de test pour les utilisateurs internes «alpha» et «bêta» testeurs externes. La documentation de test comprend des instructions de test - comme un ensemble spécifique d'étapes testeurs doivent suivre - pour déterminer si le produit fonctionne comme prévu. Membres du personnel AQ recueillent également des journaux d'émission, listes de bogues et des rapports de testeurs.

Documentation de l'équipe

• 
  
  
  
  
  

  L'échange d'idées entre les membres de l'équipe est essentielle à la réussite d'un projet. la documentation de l'équipe enregistre ces échanges pour une utilisation sur le projet en cours et les projets futurs. les plans de l'équipe, les horaires et les mises à jour d'état sont des composantes majeures de la documentation de l'équipe. Les listes de contrôle aident les gestionnaires de projet Voir les tâches qui l'équipe a terminé. Les comptes rendus des réunions de l'équipe permettent aux gestionnaires de suivre diverses questions, des suggestions et des missions entre les membres de l'équipe.

Documentation utilisateur

• L'élément le plus critique de la documentation du système est le contenu reçu par le client. La documentation utilisateur doit être libre de tout jargon trop technique et contiennent langage clair et concis. Le manuel d'utilisation est généralement la principale composante de la documentation de l'utilisateur, mais les utilisateurs aussi compter sur d'autres sources. Ressources de formation - y compris les manuels et vidéos - peuvent aider les utilisateurs à rapidement et facilement comprendre comment le système fonctionne. 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.