Quatrième partie IV La documentation
Contents
1. D finition Le plan de test est un document d crivant l ensemble des proc dures de test permettant la v rification d une application et de chacun de ses sous ensembles R le du plan de test Le plan de test regroupe les tests unitaires au niveau de la fonction et les tests d int gration au niveau de l application Il peut aussi contenir des scenarii Ce document est r dig avant la phase de programmation En Les rubriques du plan de test 1 Cours de G nie Logiciel Introduction Objectifs et m thode Pr senter les principales pr occupations du plan de test Documents de r f rence Scenarii Pr senter un ensemble de tests ainsi que leur ordonnancement Description des tests d int gration Pour chaque test ER Description du test D crire le test de fa on externe But du test D crire ce que prouve le test En Les rubriques du plan de test 2 Cours de Ela ee Principe de r alisation de D crire la proc dure de test ainsi que les param tres et les ensembles de donn es utiliser Pour chaque jeu d essai Donn es en entr es R sultats attendus Crit res de validation Q Description des tests unitaires Pour chaque module classe Pour chaque fonction m thode Mise en oeuvre Pour chaque jeu d essai Donn es en entr es R sultats attendus Crit res de validation Le plan de test D finition Le cahier de recette est un document de r cept2. 1 Cours de G nie Logiciel Identification du document e Toutes les informations permettant d identifier le document Table des mati res Liste des illustrations figures tableaux Q introduction ou pr ambule Pr cise l objectif de la document et en r sume le contenu Guide de lecture e Pr cise pour chaque type de lecteur comment utiliser efficacement le document E Cours de G nie Logiciel Les rubriques de base d un document Les rubriques de base d un document 2 Concepts de base e Pr cise les concepts de base n cessaires la compr hension du document Q Glossaire D finit l ensemble des termes sp cialis s du document Q R f rences e Indique les r f rences bibliographiques vers d autres documents apportant des informations compl mentaires Index e Liste les mots cl s du document et o les trouver dans celui ci Pour les documents lectroniques e Fonctions de navigation e D crit les fonctions permettant de naviguer dans le document e Fonctions de recherche D crit les proc dures de recherche d information dans le document En Identification d un document n Les informations d identification Titre du document Nom du projet R f rence du document Type de document Version du document ous Date du document Auteur s du document e Les informations de qualit El ment de v rification du document El ment d
3. dossier d tude d taill e permet aussi de quantifier le travail de programmation r aliser En Les rubriques du dossier d tude d taill e 1 Cours de G nie Logiciel Introduction Objectifs et m thodes Pr senter la m thodologie utilis e pour la phase de conception d taill e Documents de r f rence Interfaces entre les t ches du logiciel Pour chaque t che Enchainements et flots de donn es ne D crire pr cis ment les flots de donn es E S de la He t che consid r e synchronisation protocole format et type des donn es En Les rubriques du dossier d tude d taill e 2 Cours de G nie Logiciel Description des modules ou des classes D crire les interfaces des modules ou des classes Pour chaque module Rappel des objectifs du module Relations d utilisation avec d autres modules Lister les modules utilis s par ce module et ceux utilisant ce module D finitions de types Lister les d finitions de type ou les attributs de l objet associ au module Proc dures externes Le dossier d tude Lister les proc dures visibles par les modules utilisant D ce module Variables externes Lister les variables visibles par les modules utilisant ce module En Les rubriques du dossier d tude d taill e 3 Cours de G nie Logiciel Pour chaque classe Description compl te de la classe Super classe et sous classe Associations Attributs M thodes
4. E Cours de G nie Logiciel Quatri me partie IV La documentation o Il ny a pas de logiciel de qualit sans une documentation de qualit e La documentation est un outil de communication Les paroles s envolent les crits restent Exemple la forme de la documentation La norme IEEE intitul e Standard for Software User Documentation 2001 pr conise une structure de documents pour le manuel d utilisation ainsi que la mani re de le concevoir En Les diff rents types de documents 1 Cours de G nie Logiciel Documentation d utilisation et de soutien Documents de pr sentation g n rale Manuel de r f rence Documents p dagogiques Manuel d utilisation Manuel d installation Manuel d exploitation Documents de relation contractuelle Cahier des charges Propositions Conventions Documents d engagements compl mentaires Documents de r ception Les diff rents types de documents En Les diff rents types de documents 2 Cours de ME Documents de gestion de projet e Plan de d veloppement e Documents de suivi de projet e Bilan de projet a Q Documents d assurance qualit Plan d assurance qualit Plan d audit interne Rapports d valuation en fin de phase Plan de test Documentation de coordination Q Documents d tude et de d veloppement Dossier d tude pr alable Dossier d tude d taill e e Dossier de d veloppement En Les rubriques de base d un document
5. Param trage du syst me Lister les op rations n cessaires pour param trer convenablement le syst me 1 ranio Installation du logiciel Lister les op rations n cessaires pour installer le logiciel copie de fichiers Q Param trage du logiciel Lister les op rations n cessaires pour param trer convenablement le logiciel Em Les rubriques du manuel d installation 2 Cours de G nie Logiciel Installation des donn es Lister les op rations n cessaires la mise en place des donn es de l application copie de fichiers cr ation de base de donn es Q Autres informations Dena Lister d autres op rations utiles informer les utilisateurs mettre hors service une application le temps de l installation proc dure de mise jour D fi in Uon Le cahier des charges est un document rassemblant les obligations et les l ments n cessaires pour d finir un besoin et les principales contraintes respecter pour le satisfaire AFITEP R le du cahier des charges Le cahier des charges est un l ment objectif qui permet un client de choisir son fournisseur gr Le cahier des charges la norme AFNOR X50 151 1 Cours de G nie Logiciel Pr sentation g n rale du probl me Projet Finalit s Esp rance de retour sur investissement Contexte Le cahier des charges Situation du projet par rapport aux autres projets de l entreprise Etudes d j
6. e validation du document El ment de soumission du document Type de diffusion du document Niveau de confidentialit Mots cl s D finition Le manuel d utilisation est un document d crivant l ensemble des fonctionnalit s de la nouvelle application ainsi que les actions r aliser afin de les mettre en oeuvre R le du manuel d utilisation Le manuel d utilisation permet l utilisateur final d exploiter les fonctionnalit s de l application En Les rubriques du manuel d utilisation 1 Cours de G nie Logiciel Mise en oeuvre Indique la mani re d utiliser l application pour r aliser les t ches de base Liste des commandes d ulaion D crit l ensemble des commandes de l application Q Messages d erreur e D crit les erreurs pouvant survenir et les proc dures permettant leur r solution D finition Le manuel d installation est un document rassemblant l ensemble des proc dures n cessaires la mise en place de la nouvelle application dans son environnement de production conditions r elles d utilisation R le du manuel d installation Le manuel d installation permet un administrateur syst me d installer et de configurer l application sur des syst mes informatiques Em Les rubriques du manuel d installation 1 Cours de G nie Logiciel Installation du mat riel Pr ciser le mat riel installer et les op rations n cessaires sa mise en fonction
7. effectu es Etudes men es sur des sujets voisins Suites pr vues Nature des prestations demand es Parties concern es par le d roulement du projet et ses r sultats demandeurs utilisateurs Caract re confidentiel si il y a lieu gr Le cahier des charges la norme AFNOR X50 151 2 Cours de G nie Logiciel Enonc du besoin finalit s du produit pour le futur utilisateur tel que pr vu par le demandeur Environnement du produit recherch e Listes exhaustives des l ments personnes quipements mati res et contraintes environnement Caract ristiques pour chaque l ment du l environnement Expression fonctionnelle du besoin Fonctions de service et de contrainte Le cahier des charges Fonctions de service principales qui sont la raison d tre du produit e Fonctions de service compl mentaires qui am liorent facilitent ou compl tent le service rendu Contraintes limitations la libert du concepteur r alisateur gr Le cahier des charges la norme AFNOR X50 151 3 Cours de G nie Logiciel ic Crit res d appr ciation en soulignant ceux qui sont d terminants pour valuation des r ponses Niveaux des crit res d appr cpiation et ce qui les caract rise Niveaux dont l obtention est impos e e Niveaux souhait s mais r visables Cadre de r ponse e cahier des Pour chaque fonction e Solution propos e Niveau atteint po
8. ffice Writer Microsoft Word LaTeX e Logiciel de diagrammes Microsoft Visio Dia kivio xfig e Gestion de version RCS CVS Subversion e Documentation partir du code source e Doxygen e Javadoc La r daction documents gr Recommandations pour la r daction des documents 1 Cours de G nie Logiciel Fa tes des phrases la forme active Evitez la forme passive Fa tes des phrases courtes Evitez les phrases tiroir Une phrase une id e e Pour d finir un objectif utilisez un verbe l infinitif et un objet Fa tes des phrases pr cises On ne l est jamais trop e Evitez les formules alambiqu es Int grez les termes techniques dans un glossaire Q Fa tes des paragraphes courts e La qualit vaut mieux que la quantit 7 phrases environ La r daction documents gr Recommandations pour la r daction des documents 2 Cours de G nie Logiciel Dans le doute utilisez le correcteur orthographique et grammatical Relisez vous Fa tes vous relire Q Utilisez une pr sentation pertinente La r daction Une liste vaut mieux qu une num ration dans une phrase Un bon dessin vaut mieux qu un long discours e Un texte en gras ou en italique permet de faire ressortir un mot ou une expression e Les titres et les sous titres permettent de faire ressortir la structure du document documents Proposez plusieurs explications lor
9. iel dans son ensemble Documents de r f rence Lister tous les documents du projet servant l laboration du pr sent document Organisation Lepande D crire l ensemble des activit s introduites dans se l organigramme des t ches de la gestion de projet D composition en t ches Structure des quipes En Canevas de plan de d veloppement 2 Cours de G nie Logiciel Planification D crire l enchainement des t ches au cours du d veloppement du projet calendrier pr visionnel des diff rentes phases de conception Cycle de vie Pr senter les g n ralit s de la m thode de d veloppement utilis e avec la d composition du d veloppement en phases successives d raonpemon M thodes et outils D crire les outils de d veloppement point de vue technique Canevas de plan de d veloppement 3 Cours de G nie Logiciel Le plan de d veloppement Q Documentation Pr sentation Pr senter les documents fournis phase par phase avec leur plan type Standard et outils Pr senter les outils et standard qui supporteront la documentation Q Qualit D finir les crit res d terminant la qualit du logiciel D finition Le dossier d tude d taill e est un document d crivant de mani re exhaustive le r sultat de la phase de conception d taill e Il contient une description compl te de chaque sous ensemble de l application module classe R le du dossier d tude d taill e Le
10. ion contractualisant les diff rents aspects de la livraison du logiciel Soumission Q V rification Q Validation R le du cahier de recette Le cahier de recette est un document contractuel permettant de v rifier que le logiciel livr correspond bien aux sp cifications des besoins du client Il peut tre utilis en cas de litige En Les rubriques du cahier de recette 1 Cours de G nie Logiciel Introduction Objectifs et m thodes Documents de r f rence Description de la fourniture D crire sous quelle forme le logiciel sera livr Moyens d essai et outils D crire les moyens et les outils permettant la v rification de la conformit Conformit aux sp cifications g n rales Conformit aux sp cifications fonctionnelles ou objet D crire les scenarii permettant la v rification d un point de vue fonctionnel En Les rubriques du cahier de recette 2 Cours de G nie Logiciel Pour chaque scenario Description D crire le but et le principe de r alisation du test Proc dure de test D crire les donn es en entr e les r sultats attendus et les crit res de validation Conformit aux sp cifications d interfaces D crire les tests permettant la v rification des interfaces Conformit de la documentation Lister les douments n cessaires et les crit res de validation Le cahier de recette En Quelques outils Cours de G nie Logiciel Traitement de texte e OpenO
11. ndre une norme Contraintes Contraintes de co ts Sp cifier le budget allou au projet Contraintes de d lais Sp cifier la date de livraison du produit et les a ventuelles ch ances interm diaires See Contraintes mat rielles Sp cifier le mat riel n cessaire au bon fonctionnement du produit Autres contraintes Sp cifier les ventuelles contraintes prendre en compte dans le cadre du projet normes techniques clauses juridiques etc gr Le cahier des charges suggestion de canevas 3 Cours de MN D roulement du projet Planification Repr senter les grandes phases du projet et les tapes principales Ressources Lister les ressources humaines et mat rielles que le client peut mettre la disposition du prestataire Q Authentification lo eene Date et signature du chef de projet et du ma tre d ouvrage Q Annexes e Lister et joindre au cahier des charges les ventuels documents que le client peut mettre disposition D finition Le plan de d veloppement est un document qui pr sente la strat gie de d veloppement du logiciel selon les axes Planification e Organisation e M thodologie R le du plan de d veloppement Le plan de d veloppement peut faire foi en cas de litige entre un client et un fournisseur Canevas de plan de d veloppement 1 Cours de G nie Logiciel introduction Objectifs et m thodes Pr senter le d veloppement du logic
12. sque vous abordez un point complexe Q Explicitez les r f rences que vous utilisez Accompagnez vos r f rences d une petite phrase pour am liorer son impact Recommandations Les canevas propos s doivent tre compris comme des exemples g n riques n utilisez que les rubriques pertinentes dans votre contexte Em En r sum Cours de G nie Logiciel e La documentation est un outil de communication e La documentation fait gagner du temps e Une documentation de qualit sera utilis e En r sum
13. ur chaque crit re d appr ciation de cette fonction et modalit s de contr le e Part du prix attribu chaque fonction gr Le cahier des charges la norme AFNOR X50 151 4 Cours de G nie Logiciel Pour l ensemble du produit Prix de la r alisation de la version de base Options et variantes propos es non retenues au cahier des charges e Mesures prises pour respecter les contraintes et leurs cons quences conomiques Outils d installation de maintenance pr voir D composition en modules sous ensembles Pr visions de fiabilit Perspectives d volution technologique Le cahier des charges gr Le cahier des charges suggestion de canevas 1 Cours de G nie Logiciel Introduction Contexte D crire bri vement l environnement dans lequel s inscrit le projet strat gie enjeux domaine etc Historique Donner un bref historique du contexte dans lequel s inscrit le projet Description de la demande lee Les objectifs D finir les r sultats que le projet doit atteindre Produit du projet Proposer une description g n rale de ce produit Les fonctions du produit Lister et justifier les principales fonctionnalit s du produit gr Le cahier des charges suggestion de canevas 2 aa Crit res d acceptabilit et de r ception Formuler des indicateurs pr cis qui permettent de mesurer si les objectifs de qualit du produit sont atteints Ex Le produit doit r po
Download Pdf Manuals
Related Search