Gestion de la documentation des projets informatiques - DSI
Contents
1. DOcumentation Laboratoire d Evaluation Mise en Oeuvre QUalit 5 1 Documents de gestion de projet 1 Gestion de projet resp quipe r unions quipe projet action ou de chef de projet validation chef de projet l quipe Journal de bord chef de projet r unions de quipe projet information JBORD l quipe action Suivi des risques chef de projet identification d un direction DSI mformation RIS i L risque action RISQ P IRAE d cision Bilan de projet chef de projet fin du projet resp qualit v rification interne DSI BILAN quipe projet information Dossier instances chef de projet tout au long du pr sidents des validation GE de pilotage du projet comit s POSE ROME membres des information comptes rendus comit s convocations doc de travail liste quipe projet information des membres direction DSI information 2 Gestion des moyens financiers Suivi du budget chef de projet r union de suivi responsable information GE consomm et de projet gestion la DSI pr visionnel Factures chef de projet arriv e de secr tariat action saisie GE factures XLAB 3 Gestion de la documentation et configuration logicielle CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 11 21 Guide m thodologique Gestion de la documentation Journal de la quipe projet production de che2. rification unitaires et r alisation technique chef de projet validation quipe action tests r alisation Plan de tests de quipe tape d tude resp qualit v rification validation PTV r alisation technique CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 12 21 Plan de tests de non r gression PTNR quipe r alisation Protocole de r ception interne recette PRCI quipe r ception Dossier de r ception interne cahier de recette DRCI quipe r ception tape d tude technique tape d tude d taill e tape d tude d taill e pr paration de tests puis tape de r alisation phase de r ception 5 3 Documents relatifs la mise en oeuvre 1 Communication Pr sentation charg de la g n rale de projet communication 2 Documentation d utilisation Manuel d utilisation charg de la documentation Manuel d installation Manuel d exploitation Manuel de r f rence 3 Formation des utilisateurs Plan de formation charg de la formation Calendrier des formations charg de la formation tape de pr paration de la mise en oeuvre tape de pr paration mise en oeuvre tape de pr paration mise en oeuvre tape de pr paration mise en oeuvre CNRS DSI BQSD conduite projet developpement guide gestion doc Guide m thodologique G
3. est fig e la date de derni re mise jour 4 4 Gestion des versions r visions Chaque modification de version d un document doit tre soumise aux m mes dispositions d approbation que les documents initiaux voir chapitre 2 2 cycle de vie d un document L auteur de la modification est responsable e du respect du cycle de v rification et validation e dela modification de l indice de r vision e dela diffusion de la nouvelle version e de la sauvegarde des modifications Le num ro de version qui appara t sur un document correspond la version de l application logicielle concern e L indice de r vision est propre au document e il est remis 00 lors chaque nouvelle version de l application e il est incr ment chaque modification du contenu du document devant faire l objet d une diffusion il n est pas incr ment pour des corrections portant sur la forme du document fautes de frappe d orthographe Pour certains documents il est important de faire appara tre clairement les volutions d une r vision l autre du document A cet effet l option Outils Suivi des modifications de Word est utilis e Les corrections de fautes d orthographe de frappe ou de mise en page ne doivent pas appara tre avec des marques de r vision Pour cela effectuer ce type de modifications sur le document initial exemple dans ED_ASTTOZ doc avant de le dupliquer Attention Le document original choisi
4. pour effectuer la r vision est fonction du destinataire auquel s adresse cette r vision e soit le destinataire aura en main toutes les r visions successives du document e soit le document transmis fera la somme de toutes les relectures successives 4 5 Outils de production de la documentation Tout nouveau document est produit sur PC avec les logiciels WORD EXCEL ou Powerpoint 4 6 Classement Tous les documents mis dans le projet sont r f renc s dans un journal de la documentation qui comporte les l ments suivants e r f rence du document e date de cr ation e auteur s e titre e outil de production du document word excel PC CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 9 21 Guide m thodologique Gestion de la documentation NB Chaque auteur de document est responsable de la mise jour du journal de la documentation du projet Un exemplaire papier de chaque document du projet est disponible dans l armoire de la documentation du projet Une feuille d emprunt permet de conna tre la localisation des documents sortis de l armoire 4 7 Gestion physique des fichiers contenant les documents 4 7 1 R pertoires Les documents du projet sont accessibles en consultation tous les membres de l quipe projet sur serveur dans un r pertoire clairement identifi par le nom du projet Un sous r pertoire est cr par nature de document g rer Les noms de ces
5. r pertoires reprennent les codes de la nature du document GE EP ED ET RE RC MO QU 4 7 2 Noms des fichiers Le nom de chaque fichier rappelle la r f rence du document nature de document _ identification du document La nature du document est rappel e dans le nom de fichier afin qu il n y ait pas de confusion entre des documents ayant la m me identification mais pas la m me nature exemple identification STRUC mais nature ED ou ET D rogation la nature du document peut ne pas tre inclue dans le nom du fichier si aucune confusion n est possible entre 2 documents Remarque lorsqu il est n cessaire de sauvegarder plusieurs r visions de documents l indice de r vision est ajout en fin du nom de fichier 4 7 3 Proc dures de sauvegarde et archivage Le r pertoire du projet est sauvegard chaque soir par la proc dure automatique du serveur Lorsque le d veloppement d une version de l application est termin e la documentation est archiv e Les derni res r visions des documents applicables sont transf r es dans un nouveau r pertoire identifi par le num ro de la prochaine version Lorsque l acc s imm diat un document n est plus indispensable le document est archiv par s curit Si le document est p rim le responsable de la documentation veille informer tous les d tenteurs du document de sa cessation d applicabilit 5 ORGANISATION DE LA DOCUMENTATION Le tableau des principaux documen
6. sous une forme permettant l utilisateur final d acc der la d marche suivre dans une proc dure donn e en fonction de chaque v nement Il peut tre compos de plusieurs supports documentaires par exemple e aide m moire e guide de l utilisateur d crit de fa on exhaustive les proc dures pr vues dans l application e le langage de requ te e aide en ligne e Domaine d application Documentation de mise en oeuvre MARCHE COMMANDE CONVENTIONS D finition Engagement r ciproque explicite de deux types liant contractuellement les acteurs soit accord interne entre entit s d un m me organisme soit contrat entre entit s diff rentes ou march s publics Domaine d application Documentation de relation contractuelle PLAN D ASSURANCE ET CONTROLE QUALITE PLAN D ASSURANCE QUALITE D finition CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 18 21 Guide m thodologique Gestion de la documentation Document pr cisant les l ments qui permettent de s assurer de la mise en oeuvre et de l efficacit des activit s pr vues pour obtenir la qualit requise Ce document d taille notamment les t ches et relations mutuelles entre les cellules impliqu es dans la qualit telles que direction de projet quipe de production support logistique cellule assurance qualit etc Les lignes directrices du plan assurance qualit se retrouvent au niveau des documen
7. ANT LES DOCUMENTS ceccccccssececcccccasasasasass 10 4 TA R PEVLO UV CS enana a a de a aa des H a o a aa 10 47 2 N 0 115811 LAB 1181112 S R E n P a E a Th ec te iS 10 4 7 3 Proc dures de sauvegarde et archiVAQe ccccccccecccccccicccecccccecccccececercaeeeene 10 5 ORGANISATION DE LA DOCUMENTATION cccceccccccccccccccccococccccccocccocccccc000000ces 10 5 1 DOCUMENTS DE GESTION DE PROJET cecccceccccccccecccecccecccssccssecceesocesccesecssecssesesesanesonaens 11 5 2 DOCUMENTS D TUDE ET D VELOPPEMENT cccecececccccccccesesecceccssssesesecoesossssesaeoosossaaenas 12 5 3 DOCUMENTS RELATIFS LA MISE EN OEUVRE eee rer serre encre eeeeeeeeeeee eee 13 5 4 DOCUMENTS RELATIFS LA QUALIT ecececcccccccesecccccccccssesecceccsssssseseeoesesssseseeoesosesaenas 14 6 ANNEXE GLOSSAIRE DES DIFF RENTS TYPES DE DOCUMENTS cms 15 CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 3 21 Guide m thodologique Gestion de la documentation 1 OBJET ET DOMAINE D APPLICATION Rappel documentation ensemble de documents relatifs un projet notice mode d emploi action de s lectionner classer utiliser ou diffuser des documents Source Le Petit Larousse 1994 La documentation d un projet a une importance primordiale c est l outil de communication et de dialogue entre les membres de l quipe projet et les intervenants ext rieurs membre des in
8. Centre national de la recherche scientifique Direction des syst mes d information REFERENTIEL QUALITE Guide m thodologique Gestion de la documentation des projets informatiques R f rence CNRS DSI BQSD conduite projet developpement guide gestion doc Date de derni re mise jour 19 f vrier 2001 Version 01 Etat termin Auteurs F Villeneuve Diffusion DSI Objet Ce document est un guide pour g rer la documentation au sein d une quipe projet la DSI mettre en oeuvre des moyens pour r f rencer de mani re homog ne l ensemble de la documentation relative chaque projet en organiser la production le classement et l acc s Guide m thodologique Gestion de la documentation Table des mises jour du document Version du Objet de la mise jour document Cr ation du document Diverses mises jour noms de documents r f renc s Remplacement de la fiche de synth se par la fiche de relecture Ajout du classement de la documentation papier armoire et feuille d emprunt Ajout de la gestion des versions Compl ments sur la gestion physique des fichiers Ajout du plan et dossier de tests de validation mise jour des d finitions des niveaux de test Ol septembre 99 Changement de d nomination de la DSI D l gation aux syst mes d information devient Direction des syst mes d information 19 f vrier 2001 Mise en forme et ajustements CNRS DSI BQSD conduit
9. ER DE PROGRAMMES DOSSIER DE PROGRAMMES D finition Dossier visant donner une description technique de chaque programme partir des sp cifications techniques Ceci constituera une r f rence pour la maintenance ou pour l volution ult rieure du syst me Domaine d application Documentation d tude et de d veloppement CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 16 21 Guide m thodologique Gestion de la documentation DOSSIER DE RECEPTION DOCUMENTS DE QUALIFICATION D finition La r ception consiste s assurer de la conformit du logiciel aux sp cifications externes en fonction des modalit s des tests Selon les logiciels elle peut porter sur e le fonctionnement de modules particuliers e l int gration e la qualification fonctionnelle On retrouve dans ce document la trace des sessions effectu es par l quipe de r ception e Jes observations qui ont t faites e la trace des d faillances dont la description a t transmise pour correction l quipe de d veloppement e les retours d information sur les modifications apport es par l quipe de d veloppement e le travail de r ception fait et faire Domaine d application Documentation d tude et de d veloppement DOSSIER DE SUIVI DE PROJET DOCUMENTS DE SUIVI DE PROJET D finition Tout document permettant de ma triser pas pas le bon d roulement du projet et de prendre les d cisions
10. OCUMENTS Ce glossaire est issu de la norme AFNOR Z 67 100 3 et adapt au contexte des projets DSI le terme AFNOR correspondant est donn entre parenth ses AIDE MEMOIRE OU MEMO A DE MEMOIRE D finition Document pr sentant l application informatique sur un support r duit en g n ral cartonn et ou plastifi contenant les modes d acc s aux diff rentes fonctions et les commandes disponibles Domaine d application Documentation de mise en oeuvre manuel d utilisation AIDE EN LIGNE A DE EN LIGNE D finition Support documentaire fournissant l utilisateur les informations n cessaires l utilisation directe de l application par r ponse interactive toute question qu il peut se poser lors de la manipulation des proc dures mises sa disposition Cette information s obtient en frappant sur une touche aide ou et appara t dans une zone particuli re de l cran lignes sp cifiques ou fen tre Domaine d application Documentation de mise en oeuvre manuel d utilisation AVENANT DOCUMENT D ENGAGEMENT COMPLEMENTAIRE D finition Document contenant les l ments qui modifient les conditions initiales de la convention Domaine d application Documentation de relation contractuelle BILAN DE PROJET BILAN DE PROJET D finition Document analysant objectivement les succ s ou les difficult s rencontr es et faisant part de toute disposition susceptible d tre retenue dans le futur pour l a
11. de pr alable EP tape d tude d taill e ou fonctionnelle ED tape d tude technique ET CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 7 21 Guide m thodologique Gestion de la documentation tape de r alisation RE tape de r ception RC documents de mise en oeuvre MO et plus sp cifiquement documents li s la documentation utilisateur DO documents li s la formation des utilisateurs FO documents li s au laboratoire d valuation LE documents qualit QU c identification du document pour les documents techniques de tests ou li s la qualit nom du module ou de la proc dure exemples FACT document d tude d taill e Module Factures PTUTI document d tude technique Plan de Tests Unitaires et d Int gration PA CQ document qualit Plan d Assurance et Contr le Qualit pour les documents de type courrier utiliser l outil NUMELEC 4 3 2 Structure Il est convenu que tout document doit comporter les l ments suivants sur la page de garde e Je titre du document e la r f rence du document e la date de derni re mise jour e Je num ro de version de l application concern e par le document VX x e l indice de r vision du document num ro chronologique 00 01 par rapport la version de l application e l tat du document ex travail e le nom de l auteur ou des auteurs e l objet du documen
12. e les proc dures de restauration pour retraitements ventuels Domaine d application Documentation de mise en oeuvre MANUEL D INSTALLATION MANUEL D INSTALLATION CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 17 21 Guide m thodologique Gestion de la documentation D finition Document d crivant les tapes suivre lors de la mise en oeuvre d une application de taille moyenne ou importante sur un ou plusieurs gros syst mes unit centrale ou serveur Il peut tre compos d un ou plusieurs supports documentaires par exemple e le guide d installation e le guide d installation en r seau e param trage o L installation pour un petit logiciel sur micro ordinateur peut tre trait e dans le manuel utilisateur Domaine d application Documentation de mise en oeuvre MANUEL DE REFERENCE pas d quivalent AFNOR D finition Compilation des l ments contenus dans les documents d tude et de d veloppement du logiciel i e description technique de chaque cas d erreur possible chaque cran chaque commande de l application Il peut tre compos de plusieurs supports documentaires e guide de r f rence e glossaire e Domaine d application Documentation de mise en oeuvre MANUEL D UTILISATION MANUEL UTILISATEUR D finition Document d crivant de fa on exhaustive les proc dures pr vues dans l application description fonctionnelle Est pr sent
13. e projet developpement guide gestion doc 19 f vrier 2001 2 21 Guide m thodologique Gestion de la documentation Sommaire 1 OBJET ET DOMAINE D APPLICATION ccccccccceccccccccccccccoceccccccooooeocococc0000eococcves 4 2 DOCUMENTS DE R F RENCE sesserenemnemneeneenennnneereessee 4 3 ABR VIATIONS ET TERMINOLOGIE cccccccccceccccceccoccoccoccoccsccoscoccescsocoscsovescsocsses 4 4 GESTION DE LA DOCUMENTATION cccce ccecccccccccccccoccccccccooooceccc0e00000000000000000000000 4 4 1 LES ACTEURS ET LEURS RESPONSABILIT S ecccccceceseccccccoesesessecesesssssseseaoesssssseaeacenenans 4 4 2 CYCLE DE VIE D UN DOCUMENT 5er ne en din nue er 5 4 2 1 Production du document iii eee seceeeceseceecececeeecececeenceeeeeeneeeee 6 4 2 2 V rification validation du dOCUMENT a etienne dan a anne resorts eo 6 42 3 Archivage du doc UMent sacs ide an a ont title dans 7 4 3 IDENTIFICATION ET STRUCTURE DE LA DOCUMENTATION ccccccccsesececcccsesesesoccecesasasasesse 7 4 3d ldentifieati on ranir nn Da RNA HAN A O At cn A de en 7 4 3 2 Structure sin nn Meme LR te A ed ne ne A D ET ed ne Ut 8 4 4 GESTION DES VERSIONS R VISIONS eme rennerenneeennueennneennne conne eee eenee senc eeeee encre nnee 9 4 5 OUTILS DE PRODUCTION DE LA DOCUMENTATION ccccccesececccc cssssscsccecacassssosececeaasasasesse 9 4 6 CEASSEMEN To a miae e ee a O CT OU L t AAN Am E Mio 9 4 7 GESTION PHYSIQUE DES FICHIERS CONTEN
14. egarde du document Responsable de relecture pour commentaires et enrichissements ventuels v rification contr le de la conformit par rapport aux standards m thodologiques contenu attendu du document et aux r gles de pr sentation et structuration des documents Responsable de la validation valuation de la pertinence la correction et la compl tude du contenu par rapport aux objectifs du document 4 2 Cycle de vie d un document document en t te de liste des auteurs Un document passe par un certain nombre d tats Signification travail fi e document est en cours d laboration par l auteur le document satisfait l auteur il est pr t tre diffus le document est approuv par d autres membres de l quipe des intervenants ext rieurs et ou le contr le qualit r f rence au sein du projet p rim le document n est plus adapt et est donc retir tous ses d tenteurs retrait d usage archivage le document n est plus consult r guli rement mais une trace de son existence demeure pour une dur e d finie par le charg de gestion de la documentation du projet destruction le document n est pas archiv ou le d lai d archivage est coul CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 5 21 Guide m thodologique Gestion de la documentation Cycle de vie d un document production Auteur A CAN IA v rification V rificateur va
15. en oeuvre DENEYDE chef de projet information comit s information 4 Laboratoire d valuation Pr paration du ergonome DSI avant le passage quipe projet validation laboratoire en laboratoire d valuati participants au action valuation passage en t ches laboratoire sc narios Synth se des ergonome DSI apr s le passage chef de projet validation LE r sultats en laboratoire quipe projet action 5 R ception externe passage en site pilote Protocole de charg des sites avant la diffusion quipe r ception v rification MO r ception externe pilotes en sites pilote chef de projet RC validation sites pilotes action tion externe pilotes pilotes chef de projet validation Dossier de r cep charg des sites tape de sites sites pilotes action tests MO DRCE 5 4 Documents relatifs la qualit Plan d assurance resp qualit d but de projet chef de projet validation et contr le qualit quipe projet action PACQ application Dossier de suivi resp qualit tout au long du chef de projet information qualit projet quipe projet information bilans CR action revues mesures CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 14 21 Guide m thodologique Gestion de la documentation 6 ANNEXE GLOSSAIRE DES DIFFERENTS TYPES DE D
16. estion de la documentation v rification validation resp qualit chef de projet quipe r alisation action tests resp qualit v rification chef de projet quipe conception action tests v rification validation resp qualit chef de projet information action quipe conception chef de projet validation utilisateurs information comit s information v rification validation resp qualit chef de projet comit s information action utilisation retours Jaboratoire d valuation actiOn utilisation retours sites pilotes action utilisation utilisateurs validation validation chef de projet comit s interlocuteurs information DS DR chef de projet validation interlocuteurs information DS DR 19 f vrier 2001 13 21 Guide m thodologique Gestion de la documentation Support de charg de la tape de quipe r alisation v rification formation formation r paration mise nee prep resp mise en validation transparents en oeuvre oeuvre cahier d exercice n action utilisateurs Fiche d valuation utilisateurs fin d une session charg de la information FO de formation formateurs de formation formation Bilan de formation charg de la fin d un ensemble reponsable mise information formation de sessions de
17. f de projet information documentation doc JDOC responsable v rification qualit Etat de la configu resp r alisation modification chef de projet information ration logiciel livraison quipe r alisation information resp qualit v rification 4 Secr tariat Logistique Chrono courrier assistante arriv e d part de quipe projet information GE courrier 5 2 Documents d tude et d veloppement Dossier d tude quipe tape d tude resp qualit v rification pr alable sp cification pr alable _ chef de projet validation comit s validation Dossier d tude quipe tape d tude resp qualit v rification ED d taill e l sp cification d taill e chef de projet validation sp cifications fonctionnelles comit s validation quipe action r alisation resp mise en information OEUVI E Dossier d tude quipe tape d tude resp qualit v rification technique r alisation technique sp cifications techniques quipe action r alisation code chef de projet validation Dossier de quipe tape de resp qualit v rification RE programmes r alisation r alisation quipe _ action tests r alisation CEO chef de projet validation d int gration PTUTI quipe action tests r alisation Plan de tests quipe tape d tude resp qualit v
18. idation est accept e le document passe l tat v rifi valid sinon il revient en tat de travail L auteur du document est charg d indiquer en page de garde du document l tat dans lequel le document se trouve ainsi que les noms des v rificateurs validateurs et les dates de v rification validation NB Pour chaque document valider une date de retour des remarques est convenue Si aucun retour n est parvenu l auteur la date pr vue le document est consid r comme valid 4 2 3 Archivage du document Lorsqu un document est p rim le responsable charg de la gestion de la documentation l archive et veille informer tous les d tenteurs du document de sa cessation d applicabilit 4 3 Identification et structure de la documentation 4 3 1 Identification Afin d assurer l efficacit de la gestion de la documentation il faut pr voir un m canisme normalis d identification des documents homog n it Ainsi chaque document re oit une r f rence unique au sein du projet constitu e de plusieurs champs cette r f rence apparait en page de garde et sur chacune des pages du document nom_du_projet nature_de_document identification_du_ document a nom du projet CNRS DSL PROJET b nature de document sur 2 caract res documents de gestion GE documents de d veloppement en fonction de l tape dans laquelle est produit ou utilis le document technique tape d tu
19. ier dans le cas d volutions que les modifications apport es n ont pas entra n d effets de bord non pr vus qui pourraient d grader le comportement du logiciel ant rieurement valid Les v rifications peuvent porter sur les fonctionnalit s disponibles les performances l ergonomie Domaine d application Documentation d tude et de d veloppement PRESENTATION GENERALE DE PROJET DOCUMENTS DE PRESENTATION GENERALE D finition Document usage externe ou interne apportant aux diff rents partenaires les l ments minimum d information afin qu ils aient une vision d ensemble de l application et de son int gration dans l organisation L information peut tre sous support papier et ou audiovisuel en fonction de la politique de communication de l entreprise Domaine d application Documentation de mise en oeuvre PROCES VERBAL DE RECEPTION DOCUMENTS DE RECEPTION D finition Document constatant l ex cution du contrat et lib rant les parties de leurs obligations r ciproques sauf celles dont la dur e est sup rieure celle de l ex cution de la fourniture ex r glement des sommes dues clause de garantie de confidentialit etc Domaine d application Documentation de relation contractuelle PROPOSITION PROPOSITION D finition Document par lequel un fournisseur explicite sa m thodologie de r alisation de la fourniture d crite dans le cahier des charges soumis par son client Domaine d applica
20. iques Ils doivent s il y a lieu activer les interfaces avec les applications connexes progiciels et sp cifiques Domaine d application Documentation d tude et de d veloppement PLAN DE TESTS DE VALIDATION PLAN DE TEST DOCUMENTS DE QUALIFICATION D finition Document d finissant l organisation des tests de validation responsabilit tapes environnement de test encha nement planning Le document contient galement la description des tests de validation sc nario cas de test r sultat attendu puis la trace des sessions de test r sultat obtenu fiches d anomalie Les tests de validation ont pour objectif de v rifier que les exigences du cahier des charges sont respect es Ils s effectuent sans connaissance de la structure interne tests bo te noire Domaine d application Documentation d tude et de d veloppement PLAN DE TESTS DE NON REGRESSION PLAN DE TEST D finition Document d finissant l organisation des tests de non r gression responsabilit tapes environnement de test encha nement planning CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 19 21 Guide m thodologique Gestion de la documentation Le document contient galement la description des tests non r gression sc nario cas de test r sultat attendu puis la trace des sessions de test r sultat obtenu fiches d anomalie Les tests de non r gression ont pour objectif de v rif
21. lidation Validateur archivage La conclusion de la v rification validation doit tre crite dans un document de sorte que l auteur puisse garder une trace formelle de l application du cycle de vie pr vu pour le document 4 2 1 Production du document Un document en cours de production est dans l tat travail Lorsque l auteur obtient une r daction qui le satisfait et ne souhaite plus apporter de modifications il l indique en le faisant passer l tat termin Avant de faire passer un document en l tat termin l auteur peut le soumettre des lectures crois es au sein de son quipe 4 2 2 V rification validation du document L auteur diffuse alors le document aux v rificateurs puis aux validateurs ou directement aux validateurs la v rification est optionnelle selon le type de document La diffusion se fait sous format papier ou lectronique choisir le plus pratique Il joint son document une fiche de relecture o les remarques ventuelles des v rificateurs ou validateurs sont formalis es modifications souhait es Toutes les remarques de fond sur le contenu du document impr cision ambigu t s incoh rences doivent tre consign es dans cette fiche sauf les remarques relatives la forme du document fautes de frappe d orthographe probl mes de mise en page qui peuvent tre signal es directement sur la copie papier du document Si les modifications du texte sont imp
22. m lioration de la qualit des produits et du d roulement des projets Domaine d application Documentation de gestion de projet BILAN QUALITE INTERNE RAPPORTS D AUDIT INTERNE D finition Document visant v rifier la mise en oeuvre et l efficacit du syst me qualit pour le projet L audit est men ind pendamment de l avancement du projet Domaine d application Documentation qualit CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 15 21 Guide m thodologique Gestion de la documentation CAHIER DES CHARGES CAHIER DES CHARGES D finition Document fourni par le demandeur client au d veloppeur fournisseur d crivant le plus explicitement possible le contenu de la prestation et de la fourniture attendue et des ventuelles contraintes concernant les conditions techniques de d veloppement d exploitation et de qualit En cas de sous traitance avec engagement forfaitaire doit tre suffisamment pr cis explicite et non volutif pour que le fournisseur puisse s engager sur un budget et un d lai Domaine d application Documentation de relation contractuelle DOSSIER D ETUDE PREALABLE RAPPORTS DE L ETUDE PREALABLE D finition Dossier regroupant l expression des besoins et les exigences de l tablissement puis d crivant de mani re globale pour l ensemble du domaine d tude les fonctions l organisation l architecture technique les contraintes majeures de s curi
23. ortantes elles sont juste r f renc es dans la fiche de relecture puis d crites directement sur une copie papier du document La fiche de relecture comporte les l ments suivants e Une partie renseign e par l auteur avant transmission au v rificateur validateur e nom du demandeur e date de la demande e nom et r f rence du document CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 6 21 Guide m thodologique Gestion de la documentation e date de retour pour les remarques e aspects examiner contenu forme totalit partie Une partie renseign e par le v rificateur validateur e nom du v rificateur ou validateur e date de v rification ou validation e conclusion de la v rification ou validation e document valid e document valid apr s int gration des modifications par l auteur e document revalider n cessite un nouveau passage en v rification validation apr s int gration des modifications par l auteur e liste des points modifier dans le document num ro de page description de la modification ou r f rence une annotation dans la copie papier du document jointe Cette fiche ainsi qu ventuellement le document annot joint est transmise l auteur L auteur r pond aux remarques mises par les relecteurs dans la colonne justification r ponses de la fiche pr vue cet effet L auteur conserve une copie papier de la fiche Si la v rification val
24. ou les mesures correctives locales qui s imposent Les documents contenus dans ce dossier sont les suivants planning journal de bord documents relatifs aux instances de pilotage comit s suivi du budget comptes rendus de r union relev de d cisions Domaine d application Documentation de gestion de projet MANUEL D EXPLOITATION MANUEL D EXPLOITATION D finition Support permettant aux utilisateurs informaticiens exploitants op rateurs et pupitreurs d exploiter l application informatique sur les syst mes ordinateurs r seaux etc dont ils peuvent utiliser les ressources Ce document comprend cinq modules e un sous dossier g n ral qui sert pr senter l application e un sous dossier sp cifique de mise en exploitation compl ment du manuel d installation pour toutes les proc dures particuli res de migration et de transition e un sous dossier relatif aux traitements d exploitation courante un sous dossier par traitement qu il s agisse de batch de TP ransactionnnel ou mixte ex t l traitement consid r comme un traitement se d roulant entre deux sauvegardes e un sous dossier s curit d crivant l ensemble des proc dures mettre en oeuvre en cas d incident e un sous dossier archivage d crivant les proc dures d archivage en mati re d indicateur volum trique de date de validit ou de pr emption etc sur un support particulier tel que bande magn tique ou streamer ainsi qu
25. outils appropri s chaque module qui peuvent rev tir des formes diverses e documents crits visuels audiovisuels e postes de travail base de formation et cas traiter Enseignement Assist par Ordinateur EAO e didacticiels Domaine d application Documentation de mise en oeuvre SUPPORT DE FORMATION MODULES POUR LES UTILISATEURS D finition Ces documents g n ralement sur support papier ou dont le contenu est parfois accessible en ligne doivent permettre de r pondre un double objectif e former les utilisateurs la pratique de l application e leur permettre de traiter des cas complexes ou inhabituellement rencontr s Domaine d application Documentation de mise en oeuvre CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 21 21
26. stances de pilotage chef de projet utilisateurs etc Elle assure aussi la p rennit des informations au sein du projet Afin d organiser la gestion de la documentation produite par projet il convient au pr alable d identifier tous les types de documents relatifs aux diverses tapes d un projet de les r f rencer de mani re homog ne pour ensuite d finir un mode de gestion commun tous les projets 2 DOCUMENTS DE REFERENCE e AFNORZ67 100 1 Syst me d information documentaire en ing nierie informatique positionnement de la documentation dans le d roulement des projets et dans la relation Client Fournisseur AFNOR Z 67 100 2 Management de la documentation dans un contexte d assurance qualit e AFNOR Z 67 100 3 Contenus type de la documentation courante des projets informatiques Plan type Document de projet Plan type Fiche de relecture Plan type Journal de la documentation Plan type Fiche d emprunt 3 ABREVIATIONS ET TERMINOLOGIE cf Glossaire Conduite de projet Syst mes d information Les d finitions des diff rents types de documents sont donn es en annexe du pr sent guide 4 GESTION DE LA DOCUMENTATION Ce chapitre pr cise les r gles de gestion de la documentation mettre en oeuvre dans tout projet Pour mieux comprendre la n cessit d une gestion rigoureuse de la documentation il convient en premier lieu de d tailler les tats par lesquels passe un doc
27. t et de performance les interfaces avec d autres syst mes Une tude de l existant approfondie peut tre men e si n cessaire Diff rentes solutions d organisation ou techniques peuvent tre approfondies par les experts syst mes d information Domaine d application Documentation d tude et de d veloppement DOSSIER D ETUDE DETAILLEE SPECIFICATIONS DETAILLEES FONCTIONNELLES RAPPORTS DE L ETUDE DETAILLEE D finition e Si l tude d taill e fait suite une tude pr alable document consistant d crire et compl ter de mani re exhaustive l avant projet qui en est issu e Si l tude d taill e n est pas cons cutive une tude pr alable cas des fetits projets document consistant pr senter la solution au plan fonctionnel avant d en d tailler les parties sous forme de sp cifications de r alisation Document d crivant sous l angle utilisateur chacune des unit s d ouvrage cran tat t che identifi e et d nombr e par le projet d taill soumise en outre un d veloppement ult rieur Domaine d application Documentation d tude et de d veloppement DOSSIER D ETUDE TECHNIQUE SPECIFICATIONS TECHNIQUES DOSSIER D ANALYSE TECHNIQUE D finition Document prolongeant les dossiers de sp cifications d taill es fonctionnelles et constituant la traduction informatique des fonctionnalit s r aliser Domaine d application Documentation d tude et de d veloppement DOSSI
28. t pr sentation rapide du contenu e pour les documents faisant l objet d une v rification et ou d une validation le cartouche de visa noms des destinataires objet de la diffusion validation v rification information dates de visa D autre part sur chaque page du document pr ciser e Je titre du document e la r f rence e la date de derni re mise jour e le num ro de page nombre de pages total Une table des mises jour des documents apr s la page de garde permet de retracer les diff rentes tapes qu a suivies le document et se d compose de la fa on suivante e le num ro de version de l application concern e par le document VX x e l indice de r vision du document 00 01 e la date de derni re mise jour de cette r vision e l objet de la mise jour du document par rapport la r vision pr c dente Chaque document comprend un sommaire qui reprend les titres des chapitres et des diff rents paragraphes et pr cise les num ros de pages correspondants NB GESTION DE LA DATE CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 8 21 Guide m thodologique Gestion de la documentation Tant que le document est en cours de production et non diffus pour v rification ou validation la date utilis e peut tre la date syst me de l ordinateur celle du jour D s que le document fait l objet d une diffusion la date en page de garde et sur chaque page
29. tion Documentation de relation contractuelle PROTOCOLE DE RECEPTION PLAN DE TEST D finition Document d finissant les principes d organisation de la r ception des produits et travaux r alis s dans le cadre d un projet les acteurs et responsabilit s le d roulement des diff rentes phases et tapes de la r ception l environnement mis en oeuvre Domaine d application Documentation d tude et d veloppement r ception interne Documentation de mise en oeuvre r ception externe REVUE QUALITE PROCESSUS FOURNISSEUR pas d quivalent AFNOR D finition CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 20 21 Guide m thodologique Gestion de la documentation Document visant v rifier l organisation du processus de d veloppement ou de maintenance mis en uvre par un fournisseur dans le cadre d un march La revue est men e ind pendamment de l avancement du projet Domaine d application Documentation qualit SUPPORT POUR LES FORMATEURS SUPPORTS POUR LES FORMATEURS D finition Documents p dagogiques destin s aux formateurs supports de cours tudes de cas Ont pour objet de fixer les messages transmettre d viter une distorsion d information et d assurer la coh rence de l enseignement en cas de formateurs multiples Ils sont mat rialis s par e le manuel du formateur structurant le cours dans l espace et le temps et d crivant les outils utiliser e Jes
30. ts de suivi de projet En cas de projet complexe ou de grande dimension il peut tre pr vu que le chef de projet enrichisse ce plan d assurance qualit initial lors d une premi re tape d ex cution du contrat Domaine d application Documentation qualit PLANNING PLAN DE DEVELOPPEMENT D finition Document permettant de pr parer de mani re d taill e l ex cution du projet notamment en terme de d marche de r partition de t ches et de suivi d avancement Domaine d appplication Documentation de gestion du projet PLAN DE TESTS UNITAIRES ET D INTEGRATION PLAN DE TEST RAPPORT DE TESTS UNITAIRES D finition Document d finissant l organisation des tests unitaires et des tests d int gration responsabilit tapes environnement de test encha nement planning Le document contient galement la description des tests unitaires et d int gration sc nario cas de test r sultat attendu puis la trace des sessions de test r sultat obtenu fiches d anomalie Les tests unitaires ont pour objectif de v rifier le fonctionnement de chaque composant logiciel unitaire modifi ou nouveau dans des cas de fonctionnement normal aux limites ou d grad Ils s appuient sur la structure interne du composant tests bo te blanche Les tests d int gration ont pour objectif de v rifier progressivement que l ensemble constitu par les composants logiciels assembl s r pond aux sp cifications fonctionnelles et techn
31. ts produits par le projet est donn ci apr s e nom titre du document que l on retrouvera en page de garde du document et dans le journal de la documentation e auteur personne s charg e s dans le projet de produire le document de le transmettre aux destinataires donn s et de le mettre jour suite aux retours ventuels des destinataires e p riodicit fr quence de production du document et tape du projet concern e e destinataires liste des personnes auxquelles le document est destin pour action e missions exploitation du document faire par les destinataires CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 10 21 Guide m thodologique Gestion de la documentation e v rification action de contr le de la forme et du contenu pour commentaires ou enrichissements ventuels et pour s assurer de la conformit aux standards d finis sur le projet principalement dans le plan d assurance et contr le qualit e validation action de donner un avis par rapport au contenu fond du document permet d tablir le document comme une r f rence au sein du projet et de passer l tape suivante e information diffusion pour consultation sans retour attendu de la part du destinataire e action diffusion pour application des recommandations d cisions donn es dans le document N Nature de document GEstion Etude D taill e Etude Technique REalisation R Ception FOrmation
32. ument avant d tre diffus ainsi que le r le des diff rents acteurs 4 1 Les acteurs et leurs responsabilit s Les diff rents acteurs sont le charg de la gestion documentaire g n ralement le responsable qualit du projet le s auteur s du document les responsables de la v rification membres de l quipe projet ou intervenants ext rieurs les responsables de la validation une ou plusieurs personnes d sign es ACTEUR RESPONSABILITES CNRS DSI BQSD conduite projet developpement guide gestion doc 19 f vrier 2001 4 21 Guide m thodologique Gestion de la documentation Charg de la gestion de la diffusion homog ne des outils de production de documents documentation du projet supervision du fonctionnement courant d finition et respect des r gles d identification de structuration et de classement contr le de la coh rence et de l homog n it dans la gestion et les extensions de la documentation du projet d cisions d archivage ou de suppression de documents Auteur objectifs et contenu du document diffusion vers les destinataires identifi s cycle de vie pr vu pour un document peut tre produit par le document plusieurs auteurs un auteur princi pal gestion des mises jour et des versions r visions successives du doit tre d sign et r f renc sur le document mise jour du journal de la documentation liste de tous les documents produits par le projet sauv
Download Pdf Manuals
Related Search