Centre national de la recherche scientifique Direction des systmes d'information

REFERENTIEL QUALITE

Guide mthodologique

Gestion de la documentation des projets informatiques

Rfrence : CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

Date de dernire mise jour : 19 fvrier 2001 Version : 01 Etat : termin

Auteurs : F.Villeneuve

Diffusion : DSI

Objet : Ce document est un guide pour grer la documentation au sein d'une quipe projet la DSI : mettre en oeuvre des moyens pour rfrencer de manire homogne lensemble de la documentation relative chaque projet, en organiser la production, le classement et laccs.

Guide mthodologique - Gestion de la documentation

Table des mises jour du document

Version du document

Date

Objet de la mise jour

V1.0

17 fvrier 1995

Cration du document

v1.1

07 mars 1996

Diverses mises jour (noms de documents rfrencs...) Remplacement de la fiche de synthse par la fiche de relecture Ajout du classement de la documentation papier (armoire et feuille d'emprunt) Ajout de la gestion des versions Complments sur la gestion physique des fichiers Ajout du plan et dossier de tests de validation, mise jour des dfinitions des niveaux de test

v1.2

01 septembre 99

Changement de dnomination de la DSI : Dlgation aux systmes d'information devient "Direction des systmes d'information".

v1.3

19 fvrier 2001

Mise en forme et ajustements

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

2 / 21

Guide mthodologique - Gestion de la documentation

Sommaire

1- OBJET ET DOMAINE DAPPLICATION ........................................................................ 4 2 - DOCUMENTS DE RFRENCE ..................................................................................... 4 3 - ABRVIATIONS ET TERMINOLOGIE ......................................................................... 4 4- GESTION DE LA DOCUMENTATION............................................................................ 4 4.1- LES ACTEURS ET LEURS RESPONSABILITS ............................................................................. 4 4.2 CYCLE DE VIE DUN DOCUMENT .............................................................................................. 5 4.2.1 Production du document................................................................................................ 6 4.2.2 Vrification/validation du document ............................................................................. 6 4.2.3 Archivage du document ................................................................................................. 7 4.3 IDENTIFICATION ET STRUCTURE DE LA DOCUMENTATION ....................................................... 7 4.3.1 Identification.................................................................................................................. 7 4.3.2 Structure ........................................................................................................................ 8 4.4 GESTION DES VERSIONS - RVISIONS....................................................................................... 9 4.5 OUTILS DE PRODUCTION DE LA DOCUMENTATION .................................................................. 9 4.6 CLASSEMENT ........................................................................................................................ 9 4.7 GESTION PHYSIQUE DES FICHIERS CONTENANT LES DOCUMENTS ........................................... 10 4.7.1 Rpertoires ................................................................................................................... 10 4.7.2 Noms des fichiers ......................................................................................................... 10 4.7.3 Procdures de sauvegarde et archivage...................................................................... 10 5. ORGANISATION DE LA DOCUMENTATION ............................................................ 10 5.1 DOCUMENTS DE GESTION DE PROJET ..................................................................................... 11 5.2 DOCUMENTS DTUDE ET DVELOPPEMENT .......................................................................... 12 5.3 DOCUMENTS RELATIFS LA MISE EN OEUVRE ...................................................................... 13 5.4 DOCUMENTS RELATIFS LA QUALIT.................................................................................. 14 6. ANNEXE : GLOSSAIRE DES DIFFRENTS TYPES DE DOCUMENTS ................... 15

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

3 / 21

Guide mthodologique - Gestion de la documentation

1- OBJET ET DOMAINE DAPPLICATION Rappel : documentation : ensemble de documents relatifs un projet - notice - mode demploi action de slectionner, classer, utiliser ou diffuser des documents. (Source : Le Petit Larousse 1994) La documentation dun projet a une importance primordiale : cest loutil de communication et de dialogue entre les membres de lquipe projet et les intervenants extrieurs (membre des instances de pilotage, chef de projet, utilisateurs, etc...). Elle assure aussi la prennit des informations au sein du projet. Afin dorganiser la gestion de la documentation produite par projet, il convient au pralable didentifier tous les types de documents relatifs aux diverses tapes dun projet, de les rfrencer de manire homogne pour ensuite dfinir un mode de gestion commun tous les projets. 2 - DOCUMENTS DE REFERENCE AFNOR Z 67 - 100-1 "Systme dinformation documentaire en ingnierie informatique" : positionnement de la documentation dans le droulement des projets et dans la relation ClientFournisseur. AFNOR Z 67 - 100-2 "Management de la documentation dans un contexte dassurance qualit" 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 Systmes dinformation Les dfinitions des diffrents types de documents sont donnes en annexe du prsent guide. 4- GESTION DE LA DOCUMENTATION Ce chapitre prcise les rgles de gestion de la documentation mettre en oeuvre dans tout projet. Pour mieux comprendre la ncessit dune gestion rigoureuse de la documentation, il convient en premier lieu de dtailler les tats par lesquels passe un document avant dtre diffus ainsi que le rle des diffrents acteurs. 4.1- Les acteurs et leurs responsabilits Les diffrents acteurs sont : le charg de la gestion documentaire (gnralement le responsable qualit du projet), le(s) auteur(s) du document, les responsables de la vrification (membres de lquipe projet ou intervenants extrieurs), les responsables de la validation (une ou plusieurs personnes dsignes). ACTEUR
CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

RESPONSABILITES
19 fvrier 2001 4 / 21

Guide mthodologique - Gestion de la documentation

Charg de la gestion de la . diffusion homogne des outils de production de documents, documentation du projet . supervision du fonctionnement courant, . dfinition et respect des rgles didentification, de structuration et de classement, . contrle de la cohrence et de lhomognit dans la gestion et les extensions de la documentation du projet, . dcisions darchivage ou de suppression de documents. Auteur . objectifs et contenu du document . diffusion vers les destinataires identifis (cycle de vie prvu pour (un document peut tre produit par le document) plusieurs auteurs : un auteur princi- pal . gestion des mises jour et des versions-rvisions successives du doit tre dsign et rfrenc sur le document document en tte de liste des auteurs) . mise jour du journal de la documentation (liste de tous les documents produits par le projet) . sauvegarde du document. Responsable de la . relecture pour commentaires et enrichissements ventuels vrification . contrle de la conformit par rapport aux standards mthodologiques (contenu attendu du document) et aux rgles de prsentation et structuration des documents. Responsable de la validation . valuation de la pertinence, la correction et la compltude du contenu, par rapport aux objectifs du document.

4.2 Cycle de vie dun document Un document passe par un certain nombre d'tats : Etat travail termin vrifi (optionnel) valid prim archivage Signification le document est en cours d'laboration par l'auteur le document satisfait l'auteur; il est prt tre diffus le document est approuv par d'autres membres de l'quipe, des intervenants extrieurs et/ou le contrle qualit le document est approuv par les personnes habilites et prend valeur de rfrence au sein du projet le document nest plus adapt et est donc retir tous ses dtenteurs (retrait d'usage) le document n'est plus consult rgulirement, mais une trace de son existence demeure (pour une dure dfinie par le charg de gestion de la documentation du projet) - le document n'est pas archiv ou - le dlai d'archivage est coul

destruction

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

5 / 21

Guide mthodologique - Gestion de la documentation

Cycle de vie d'un document

travail production termin vrification Vrificateur vrifi Auteur

validation Validateur valid archivage

La conclusion de la vrification/validation doit tre crite dans un document, de sorte que l'auteur puisse garder une trace formelle de l'application du cycle de vie prvu 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 rdaction 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 croises au sein de son quipe. 4.2.2 Vrification/validation du document L'auteur diffuse alors le document aux vrificateurs puis aux validateurs, ou directement aux validateurs (la vrification 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 vrificateurs ou validateurs sont formalises (modifications souhaites). Toutes les remarques de fond sur le contenu du document (imprcision, ambiguts, incohrences...) doivent tre consignes dans cette fiche sauf les remarques relatives la forme du document (fautes de frappe, d'orthographe, problmes de mise en page...) qui peuvent tre signales directement sur la copie papier du document. Si les modifications du texte sont importantes, elles sont juste rfrences dans la fiche de relecture puis dcrites directement sur une copie papier du document. La fiche de relecture comporte les lments suivants : Une partie renseigne par l'auteur (avant transmission au vrificateur/validateur) nom du demandeur date de la demande nom et rfrence du document
CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc 19 fvrier 2001 6 / 21

Guide mthodologique - Gestion de la documentation

date de retour pour les remarques aspects examiner (contenu, forme, totalit, partie...) Une partie renseigne par le vrificateur/validateur nom du vrificateur ou validateur date de vrification ou validation conclusion de la vrification ou validation : document valid, document valid aprs intgration des modifications par l'auteur, document revalider (ncessite un nouveau passage en vrification/validation aprs intgration des modifications par l'auteur), liste des points modifier dans le document (numro de , page, description de la modification ou rfrence une annotation dans la copie papier du document jointe).

Cette fiche (ainsi qu'ventuellement le document annot joint) est transmise l'auteur. L'auteur rpond aux remarques mises par les relecteurs dans la colonne "justification rponses" de la fiche prvue cet effet. L'auteur conserve une copie papier de la fiche. Si la vrification/validation est accepte, le document passe l'tat " vrifi"/"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 vrificateurs/validateurs et les dates de vrification/validation. NB : Pour chaque document valider, une date de retour des remarques est convenue. Si aucun retour n'est parvenu l'auteur la date prvue, le document est considr comme valid. 4.2.3 Archivage du document Lorsqu'un document est prim, le responsable charg de la gestion de la documentation l'archive et veille informer tous les dtenteurs du document de sa cessation d'applicabilit. 4.3 Identification et structure de la documentation 4.3.1 Identification Afin dassurer lefficacit de la gestion de la documentation, il faut prvoir un mcanisme normalis didentification des documents (homognit). Ainsi, chaque document reoit une rfrence unique au sein du projet, constitue de plusieurs champs (cette rfrence apparat 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/DSI/#PROJET# b) nature de document (sur 2 caractres) : . documents de gestion : GE . documents de dveloppement : en fonction de l'tape dans laquelle est produit ou utilis le document technique : * tape d'tude pralable : EP * tape d'tude dtaille (ou fonctionnelle) : ED * tape d'tude technique : ET
CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc 19 fvrier 2001 7 / 21

Guide mthodologique - Gestion de la documentation

* tape de ralisation : RE * tape de rception : RC . documents de mise en oeuvre : MO, et plus spcifiquement : * documents lis la documentation utilisateur : DO * documents lis la formation des utilisateurs : FO * documents lis au laboratoire d'valuation : LE . documents qualit : QU c) identification du document . pour les documents techniques, de tests, ou lis la qualit : nom du module ou de la procdure * exemples : FACT (document d'tude dtaille/Module Factures) PTUTI (document d'tude technique/Plan de Tests Unitaires et d'Intgration) PACQ (document qualit/Plan d'Assurance et Contrle Qualit) . pour les documents de type courrier, utiliser l'outil NUMELEC. 4.3.2 Structure Il est convenu que tout document doit comporter les lments suivants sur la page de garde : le titre du document, la rfrence du document, la date de dernire mise jour, le numro de version de l'application concerne par le document (VX.x), l'indice de rvision du document (numro chronologique : 00, 01...) par rapport la version de l'application, ltat du document (ex : travail), le nom de lauteur (ou des auteurs), lobjet du document (prsentation rapide du contenu) pour les documents faisant l'objet d'une vrification et/ou d'une validation, le cartouche de visa (noms des destinataires, objet de la diffusion - validation, vrification, information- , dates de visa). Dautre part, sur chaque page du document prciser : le titre du document, la rfrence, la date de dernire mise jour, le numro de page / nombre de pages total. Une table des mises jour des documents (aprs la page de garde) permet de retracer les diffrentes tapes qua suivies le document et se dcompose de la faon suivante : le numro de version de l'application concerne par le document (VX.x), l'indice de rvision du document (00, 01...), la date de dernire mise jour de cette rvision, lobjet de la mise jour du document par rapport la rvision prcdente. Chaque document comprend un sommaire, qui reprend les titres des chapitres et des diffrents paragraphes et prcise les numros de pages correspondants. NB : GESTION DE LA DATE

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

8 / 21

Guide mthodologique - Gestion de la documentation

Tant que le document est en cours de production, et non diffus pour vrification ou validation, la date utilise peut tre la date systme de lordinateur (celle du jour). Ds que le document fait lobjet dune diffusion, la date (en page de garde et sur chaque page est fige la date de dernire mise jour. 4.4 Gestion des versions - rvisions Chaque modification de version dun document doit tre soumise aux mmes dispositions dapprobation que les documents initiaux (voir chapitre 2.2 : "cycle de vie dun document"). Lauteur de la modification est responsable : du respect du cycle de vrification et validation, de la modification de l'indice de rvision, de la diffusion de la nouvelle version, de la sauvegarde des modifications. Le numro de version qui apparat sur un document correspond la version de l'application logicielle concerne. L'indice de rvision est propre au document : il est remis 00 lors chaque nouvelle version de l'application il est incrment chaque modification du contenu du document devant faire l'objet d'une diffusion (il n'est pas incrment pour des corrections portant sur la forme du document - fautes de frappe, d'orthographe, ...). Pour certains documents, il est important de faire apparatre clairement les volutions d'une rvision l'autre du document. A cet effet, l'option Outils/Suivi des modifications de Word est utilise. Les corrections de fautes d'orthographe, de frappe ou de mise en page ne doivent pas apparatre avec des marques de rvision. Pour cela, effectuer ce type de modifications sur le document initial (exemple : dans ED_ASTTO2.doc) avant de le dupliquer. Attention : Le document original choisi pour effectuer la rvision, est fonction du destinataire auquel s'adresse cette rvision : soit le destinataire aura en main toutes les rvisions successives du document ; 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 rfrencs dans un journal de la documentation qui comporte les lments suivants : rfrence du document, date de cration, auteur(s), titre, outil de production du document (word, excel... - PC)

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

9 / 21

Guide mthodologique - 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 connatre la localisation des documents sortis de l'armoire. 4.7 Gestion physique des fichiers contenant les documents 4.7.1 Rpertoires Les documents du projet sont accessibles en consultation tous les membres de l'quipe projet sur serveur, dans un rpertoire clairement identifi par le nom du projet. Un sous-rpertoire est cr par nature de document grer. Les noms de ces rpertoires 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 rfrence du document : nature-de-document "_" identification-du-document La nature du document est rappele dans le nom de fichier afin qu'il n'y ait pas de confusion entre des documents ayant la mme identification mais pas la mme nature (exemple : identification STRUC mais nature ED ou ET). Drogation : 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 ncessaire de sauvegarder plusieurs rvisions de documents, l'indice de rvision est ajout en fin du nom de fichier. 4.7.3 Procdures de sauvegarde et archivage Le rpertoire du projet est sauvegard chaque soir par la procdure automatique du serveur. Lorsque le dveloppement d'une version de l'application est termine, la documentation est archive. Les dernires rvisions des documents applicables sont transfres dans un nouveau rpertoire identifi par le numro de la prochaine version. Lorsque l'accs immdiat un document n'est plus indispensable, le document est archiv par scurit. Si le document est prim, le responsable de la documentation veille informer tous les dtenteurs du document de sa cessation d'applicabilit. 5. ORGANISATION DE LA DOCUMENTATION Le tableau des principaux documents produits par le projet est donn ci-aprs. nom : titre du document (que l'on retrouvera en page de garde du document et dans le journal de la documentation) auteur : personne(s) charge(s) dans le projet de produire le document, de le transmettre aux destinataires donns et de le mettre jour suite aux retours ventuels des destinataires priodicit : frquence de production du document et tape du projet concerne destinataires : liste des personnes auxquelles le document est destin pour action missions : exploitation du document faire par les destinataires :

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

10 / 21

Guide mthodologique - Gestion de la documentation

vrification : action de contrle de la forme et du contenu pour commentaires ou enrichissements ventuels, et pour s'assurer de la conformit aux standards dfinis sur le projet (principalement dans le plan d'assurance et contrle qualit) validation : action de donner un avis par rapport au contenu (fond) du document, permet d'tablir le document comme une rfrence au sein du projet et de passer l'tape suivante information : diffusion pour consultation, sans retour attendu de la part du destinataire action : diffusion pour application des recommandations/dcisions donnes dans le document N = Nature de document (GEstion - Etude Dtaille - Etude Technique - REalisation - RCeption FOrmation - DOcumentation - Laboratoire d'Evaluation - Mise en Oeuvre - QUalit) 5.1 Documents de gestion de projet Nom 1. Gestion de projet Planning - resp. quipe ou - chef de projet Journal de bord (JBORD) Suivi des risques (RISQ) - chef de projet - resp. qualit - chef de projet runions de l'quipe runions de l'quipe - quipe projet -information, action -information, action (dcision) - validation - information - information - vrification - information - information GE GE - quipe projet - chef de projet - action - validation GE Auteur Priodicit Destinataires Missions N

identification d'un - direction DSI risque tout au long du projet - prsidents des comits - membres des comits - quipe projet fin du projet - resp. qualit - quipe projet - direction DSI

GE

Dossier instances - chef de projet de pilotage du projet - comits (comptes-rendus, convocations, doc de travail, liste des membres) Bilan de projet (interne DSI) (BILAN) 2. Gestion des moyens financiers Suivi du budget (consomm et prvisionnel) Factures - chef de projet - chef de projet

GE

runion de suivi de projet arrive de factures

- responsable gestion la DSI - secrtariat

- information

GE

- chef de projet

- action (saisie GE XLAB)

3. Gestion de la documentation et configuration logicielle

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

11 / 21

Guide mthodologique - Gestion de la documentation

Journal de la documentation (JDOC)

- quipe projet

production de doc

- chef de projet - responsable qualit - chef de projet - resp. qualit

- information - vrification - information - vrification

GE

Etat de la configu- - resp. ralisation ration logiciel

modification, livraison

GE

- quipe ralisation - information

4. Secrtariat / Logistique Chrono courrier - assistante arrive/dpart de - quipe projet courrier - information GE

5.2 Documents dtude et dveloppement Nom Dossier d'tude pralable Auteur - quipe spcification Priodicit tape d'tude pralable Destinataires - resp. qualit - chef de projet - comits Dossier d'tude dtaille (spcifications fonctionnelles) - quipe spcification tape d'tude dtaille - resp. qualit - chef de projet - comits - quipe ralisation - resp. mise en oeuvre Dossier d'tude technique (spcifications techniques) Dossier de programmes - quipe ralisation tape d'tude technique - resp. qualit - chef de projet - quipe ralisation - quipe ralisation tape de ralisation - resp. qualit - quipe ralisation - resp. qualit - chef de projet - quipe ralisation - quipe ralisation tape d'tude technique - resp. qualit - chef de projet - quipe ralisation
CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

Missions - vrification - validation - validation - vrification - validation - validation - action - information - vrification - validation - action (code) - vrification - action (tests) - vrification - validation - action (tests) - vrification - validation - action (tests)

N EP

ED

ET

RE

Plan de tests unitaires et d'intgration (PTUTI) Plan de tests de validation (PTV)

- quipe ralisation

tape d'tude technique

RE

RE

19 fvrier 2001

12 / 21

Guide mthodologique - Gestion de la documentation

Plan de tests de non rgression (PTNR)

- quipe ralisation

tape d'tude technique

- resp. qualit - chef de projet - quipe ralisation

- vrification - validation - action (tests) - vrification - validation - action (tests) - vrification - validation - information, action

RE

Protocole de rception interne (recette) (PRCI)

- quipe rception

tape d'tude dtaille

- resp. qualit - chef de projet - quipe conception

RC

Dossier de - quipe rception rception interne (cahier de recette) (DRCI)

tape d'tude dtaille

(prparation de tests)

- resp. qualit - chef de projet

RC

puis tape de - quipe ralisation (phase de conception

rception)

5.3 Documents relatifs la mise en oeuvre Nom 1. Communication Prsentation - charg de la gnrale de projet communication tape de - chef de projet prparation de la - utilisateurs mise en oeuvre - comits - validation - information - information MO Auteur Priodicit Destinataires Missions N

2. Documentation d'utilisation Manuel d'utilisation Manuel d'installation Manuel d'exploitation Manuel de rfrence - charg de la documentation tape de - resp. qualit prparation mise - chef de projet en oeuvre - comits - laboratoire d'valuation - sites pilotes - utilisateurs - vrification - validation - information - action :
utilisation/retours

DO

- action :
utilisation/retours

- action : utilisation

3. Formation des utilisateurs Plan de formation - charg de la formation tape de - chef de projet prparation mise - comits en oeuvre - interlocuteurs DS, DR tape de - chef de projet prparation mise - interlocuteurs en oeuvre DS, DR - validation - validation - information - validation - information FO FO

Calendrier des formations

- charg de la formation

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

13 / 21

Guide mthodologique - Gestion de la documentation

Support de - charg de la formation formation (transparents + cahier d'exercice) Fiche d'valuation - utilisateurs de formation - formateurs Bilan de formation - charg de la formation

tape de - quipe ralisation prparation mise - resp. mise en en oeuvre oeuvre - utilisateurs fin d'une session de formation - charg de la formation

- vrification - validation - action - information

FO

FO FO

fin d'un ensemble - reponsable mise - information de sessions de en oeuvre mme type - chef de projet - information - comits - information

4. Laboratoire d'valuation Prparation du laboratoire d'valuation - ergonome DSI avant le passage en laboratoire - quipe projet - participants au passage en laboratoire - chef de projet - quipe projet - validation - action (tches, scnarios) - validation - action LE LE

Synthse des - ergonome DSI aprs le passage rsultats en laboratoire 5. Rception externe (passage en site pilote) Protocole de - charg des sites avant la diffusion rception externe pilotes en sites pilote (PRCE)

- quipe rception - vrification - chef de projet - sites pilotes - validation - action

MO

Dossier de rcep tion externe (DRCE)

- charg des sites pilotes

tape de sites pilotes

- sites pilotes - chef de projet

- action(tests) MO - validation

5.4 Documents relatifs la qualit Nom Auteur Priodicit dbut de projet Destinataires - chef de projet - quipe projet tout au long du projet - chef de projet - quipe projet Missions - validation - action (application) - information - information, action QU N QU

Plan d'assurance - resp. qualit et contrle qualit (PACQ) Dossier de suivi qualit (bilans,CR revues, mesures) - resp. qualit

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

14 / 21

Guide mthodologique - Gestion de la documentation

6. ANNEXE : GLOSSAIRE DES DIFFERENTS TYPES DE DOCUMENTS 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 parenthses).

A -------------------------------------------------------------------------------------------------AIDE-MEMOIRE OU "MEMO" (AIDE-MEMOIRE)

Dfinition : Document prsentant l'application informatique sur un support rduit (en gnral cartonn et/ou plastifi) contenant les modes d'accs aux diffrentes fonctions et les commandes disponibles. Domaine d'application : Documentation de mise en oeuvre - manuel d'utilisation
AIDE EN LIGNE (AIDE EN LIGNE)

Dfinition : Support documentaire fournissant l'utilisateur les informations ncessaires l'utilisation directe de l'application, par rponse interactive toute question qu'il peut se poser lors de la manipulation des procdures mises sa disposition. Cette information s'obtient en frappant sur une touche "aide" (ou "?") et apparat dans une zone particulire de l'cran (lignes spcifiques ou fentre). Domaine d'application : Documentation de mise en oeuvre - manuel d'utilisation
AVENANT (DOCUMENT D'ENGAGEMENT COMPLEMENTAIRE)

Dfinition : Document contenant les lments qui modifient les conditions initiales de la convention. Domaine d'application : Documentation de relation contractuelle

B -------------------------------------------------------------------------------------------------BILAN DE PROJET (BILAN DE PROJET)

Dfinition : Document analysant objectivement les succs ou les difficults rencontres et faisant part de toute disposition susceptible d'tre retenue dans le futur pour l'amlioration de la qualit des produits et du droulement des projets. Domaine d'application : Documentation de gestion de projet.
BILAN QUALITE INTERNE (RAPPORTS D'AUDIT INTERNE)

Dfinition : Document visant vrifier la mise en oeuvre et l'efficacit du systme qualit pour le projet. L'audit est men indpendamment de l'avancement du projet. Domaine d'application : Documentation qualit

C -------------------------------------------------------------------------------------------------CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc 19 fvrier 2001 15 / 21

Guide mthodologique - Gestion de la documentation

CAHIER DES CHARGES (CAHIER DES CHARGES)

Dfinition : Document fourni par le demandeur (client) au dveloppeur (fournisseur), dcrivant le plus explicitement possible le contenu de la prestation et de la fourniture attendue et des ventuelles contraintes concernant les conditions techniques de dveloppement, d'exploitation et de qualit. En cas de sous-traitance avec engagement forfaitaire, doit tre suffisamment prcis, explicite et non volutif pour que le fournisseur puisse s'engager sur un budget et un dlai. Domaine d'application : Documentation de relation contractuelle

D -------------------------------------------------------------------------------------------------DOSSIER D'ETUDE PREALABLE (RAPPORTS DE L'ETUDE PREALABLE)

Dfinition : Dossier regroupant lexpression des besoins et les exigences de ltablissement puis dcrivant de manire globale pour lensemble du domaine dtude, les fonctions, lorganisation, larchitecture technique, les contraintes majeures de scurit et de performance, les interfaces avec dautres systmes... Une tude de lexistant approfondie peut tre mene si ncessaire. Diffrentes solutions dorganisation ou techniques peuvent tre approfondies par les experts systmes dinformation. Domaine d'application : Documentation d'tude et de dveloppement
DOSSIER D'ETUDE DETAILLEE / SPECIFICATIONS DETAILLEES (FONCTIONNELLES) ( APPORTS DE R L'ETUDE DETAILLEE)

Dfinition : Si l'tude dtaille fait suite une tude pralable, document consistant dcrire et complter de manire exhaustive l'avant-projet qui en est issu. Si l'tude dtaille n'est pas conscutive une tude pralable (cas des p etits-projets), document consistant prsenter la solution au plan fonctionnel avant d'en dtailler les parties sous forme de spcifications de ralisation. Document dcrivant, sous l'angle utilisateur, chacune des units d'ouvrage (cran, tat, tche...) identifie et dnombre par le projet dtaill, soumise en outre un dveloppement ultrieur. Domaine d'application : Documentation d'tude et de dveloppement
DOSSIER D'ETUDE TECHNIQUE / SPECIFICATIONS TECHNIQUES (DOSSIER D'ANALYSE TECHNIQUE)

Dfinition : Document prolongeant les dossiers de spcifications dtailles (fonctionnelles) et constituant la traduction informatique des fonctionnalits raliser. Domaine d'application : Documentation d'tude et de dveloppement
DOSSIER DE PROGRAMMES (DOSSIER DE PROGRAMMES)

Dfinition : Dossier visant donner une description technique de chaque programme partir des spcifications techniques. Ceci constituera une rfrence pour la maintenance ou pour l'volution ultrieure du systme. Domaine d'application : Documentation d'tude et de dveloppement
CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc 19 fvrier 2001 16 / 21

Guide mthodologique - Gestion de la documentation

DOSSIER DE RECEPTION (DOCUMENTS DE QUALIFICATION)

Dfinition : La rception consiste s'assurer de la conformit du logiciel aux spcifications externes, en fonction des modalits des tests. Selon les logiciels, elle peut porter sur : le fonctionnement de modules particuliers l'intgration la qualification fonctionnelle. On retrouve dans ce document la trace des sessions effectues par l'quipe de rception : les observations qui ont t faites la trace des dfaillances dont la description a t transmise pour correction l'quipe de dveloppement les retours d'information sur les modifications apportes par l'quipe de dveloppement le travail de rception fait et faire. Domaine d'application : Documentation d'tude et de dveloppement
DOSSIER DE SUIVI DE PROJET (DOCUMENTS DE SUIVI DE PROJET)

Dfinition : Tout document permettant de matriser pas pas le bon droulement du projet et de prendre les dcisions 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 - comits ; suivi du budget ; comptes-rendus de runion ; relev de dcisions ... Domaine d'application : Documentation de gestion de projet

M ------------------------------------------------------------------------------------------------MANUEL D'EXPLOITATION (MANUEL D'EXPLOITATION)

Dfinition : Support permettant aux utilisateurs informaticiens (exploitants, oprateurs et pupitreurs) d'exploiter l'application informatique sur les systmes (ordinateurs, rseaux, etc.) dont ils peuvent utiliser les ressources. Ce document comprend cinq modules : un sous-dossier gnral qui sert prsenter l'application un sous-dossier spcifique de mise en exploitation : complment du manuel d'installation pour toutes les procdures particulires de migration et de transition un sous-dossier relatif aux traitements d'exploitation courante : un sous-dossier par traitement, qu'il s'agisse de batch, de TP ( transactionnnel) ou mixte (ex. tltraitement, considr comme un traitement se droulant entre deux sauvegardes) un sous-dossier scurit, dcrivant l'ensemble des procdures mettre en oeuvre en cas d'incident un sous-dossier archivage, dcrivant les procdures d'archivage (en matire d'indicateur volumtrique, de date de validit ou de premption, etc.) sur un support particulier tel que bande magntique (ou "streamer") ainsi que les procdures 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 fvrier 2001 17 / 21

Guide mthodologique - Gestion de la documentation

Dfinition Document dcrivant les tapes suivre lors de la mise en oeuvre d'une application de taille moyenne ou importante sur un ou plusieurs gros systmes (unit centrale ou serveur). Il peut tre compos d'un ou plusieurs supports documentaires, par exemple : le guide d'installation, le guide d'installation en rseau, paramtrage, ... L'installation pour un petit logiciel sur micro-ordinateur peut tre traite dans le "manuel utilisateur". Domaine d'application : Documentation de mise en oeuvre
MANUEL DE REFERENCE (pas d'quivalent AFNOR)

Dfinition : Compilation des lments contenus dans les documents d'tude et de dveloppement 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 : guide de rfrence glossaire ... Domaine d'application : Documentation de mise en oeuvre
MANUEL D'UTILISATION (MANUEL UTILISATEUR)

Dfinition : Document dcrivant de faon exhaustive les procdures prvues dans l'application (description fonctionnelle). Est prsent sous une forme permettant l'utilisateur final d'accder la dmarche suivre dans une procdure donne, en fonction de chaque vnement. Il peut tre compos de plusieurs supports documentaires, par exemple : aide mmoire guide de l'utilisateur : dcrit de faon exhaustive les procdures prvues dans l'application, le langage de requte, ... aide en ligne ... Domaine d'application : Documentation de mise en oeuvre
MARCHE / COMMANDE (CONVENTIONS)

Dfinition : Engagement rciproque explicite de deux types liant contractuellement les acteurs : soit accord interne entre entits d'un mme organisme, soit contrat entre entits diffrentes ou marchs publics. Domaine d'application : Documentation de relation contractuelle.

P -------------------------------------------------------------------------------------------------PLAN D'ASSURANCE ET CONTROLE QUALITE (PLAN D'ASSURANCE QUALITE)

Dfinition :
CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc 19 fvrier 2001 18 / 21

Guide mthodologique - Gestion de la documentation

Document prcisant les lments qui permettent de s'assurer de la mise en oeuvre et de l'efficacit des activits prvues pour obtenir la qualit requise. Ce document dtaille notamment les tches et relations mutuelles entre les cellules impliques 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 documents de suivi de projet. En cas de projet complexe ou de grande dimension, il peut tre prvu que le chef de projet enrichisse ce plan d'assurance qualit initial lors d'une premire tape d'excution du contrat. Domaine d'application : Documentation qualit.
PLANNING (PLAN DE DEVELOPPEMENT)

Dfinition : Document permettant de prparer de manire dtaille l'excution du projet, notamment en terme de dmarche, de rpartition de tches 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)

Dfinition : Document dfinissant l'organisation des tests unitaires et des tests d'intgration : responsabilit, tapes, environnement de test, enchanement, planning... Le document contient galement la description des tests unitaires et d'intgration (scnario, cas de test, rsultat attendu) puis la trace des sessions de test (rsultat obtenu, fiches d'anomalie...) Les tests unitaires ont pour objectif de vrifier le fonctionnement de chaque composant logiciel unitaire modifi ou nouveau dans des cas de fonctionnement normal, aux limites ou dgrad. Ils s'appuient sur la structure interne du composant (tests "bote blanche"). Les tests d'intgration ont pour objectif de vrifier progressivement que l'ensemble constitu par les composants logiciels assembls rpond aux spcifications fonctionnelles et techniques. Ils doivent, s'il y a lieu, activer les interfaces avec les applications connexes (progiciels et spcifiques). Domaine d'application : Documentation d'tude et de dveloppement
PLAN DE TESTS DE VALIDATION (PLAN DE TEST, DOCUMENTS DE QUALIFICATION)

Dfinition : Document dfinissant l'organisation des tests de validation : responsabilit, tapes, environnement de test, enchanement, planning... Le document contient galement la description des tests de validation (scnario, cas de test, rsultat attendu) puis la trace des sessions de test (rsultat obtenu, fiches d'anomalie...) Les tests de validation ont pour objectif de vrifier que les exigences du cahier des charges sont respectes. Ils s'effectuent sans connaissance de la structure interne (tests "bote noire"). Domaine d'application : Documentation d'tude et de dveloppement
PLAN DE TESTS DE NON REGRESSION (PLAN DE TEST)

Dfinition : Document dfinissant l'organisation des tests de non rgression : responsabilit, tapes, environnement de test, enchanement, planning...
CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc 19 fvrier 2001 19 / 21

Guide mthodologique - Gestion de la documentation

Le document contient galement la description des tests non rgression (scnario, cas de test, rsultat attendu) puis la trace des sessions de test (rsultat obtenu, fiches d'anomalie...) Les tests de non rgression ont pour objectif de vrifier dans le cas d'volutions, que les modifications apportes n'ont pas entran d'effets de bord non prvus qui pourraient dgrader le comportement du logiciel antrieurement valid. Les vrifications peuvent porter sur les fonctionnalits disponibles, les performances, l'ergonomie... Domaine d'application : Documentation d'tude et de dveloppement
PRESENTATION GENERALE DE PROJET (DOCUMENTS DE PRESENTATION GENERALE)

Dfinition : Document usage externe ou interne apportant aux diffrents partenaires les lments minimum d'information afin qu'ils aient une vision d'ensemble de l'application et de son intgration 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)

Dfinition : Document constatant l'excution du contrat et librant les parties de leurs obligations rciproques, sauf celles dont la dure est suprieure celle de l'excution de la fourniture (ex. : rglement des sommes dues, clause de garantie, de confidentialit, etc.). Domaine d'application : Documentation de relation contractuelle
PROPOSITION (PROPOSITION)

Dfinition : Document par lequel un fournisseur explicite sa mthodologie de ralisation de la fourniture dcrite dans le cahier des charges soumis par son client. Domaine d'application : Documentation de relation contractuelle
PROTOCOLE DE RECEPTION (PLAN DE TEST)

Dfinition : Document dfinissant les principes d'organisation de la rception des produits et travaux raliss dans le cadre d'un projet : les acteurs et responsabilits, le droulement des diffrentes phases et tapes de la rception, l'environnement mis en oeuvre, ... Domaine d'application : Documentation d'tude et dveloppement - rception interne Documentation de mise en oeuvre - rception externe

R -------------------------------------------------------------------------------------------------REVUE QUALITE PROCESSUS FOURNISSEUR (pas d'quivalent AFNOR)

Dfinition :

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

20 / 21

Guide mthodologique - Gestion de la documentation

Document visant vrifier l'organisation du processus de dveloppement ou de maintenance mis en uvre par un fournisseur dans le cadre d'un march. La revue est mene indpendamment de l'avancement du projet. Domaine d'application : Documentation qualit

S -------------------------------------------------------------------------------------------------SUPPORT POUR LES FORMATEURS (SUPPORTS POUR LES FORMATEURS)

Dfinition Documents pdagogiques destins 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 cohrence de l'enseignement en cas de formateurs multiples. Ils sont matrialiss par : le manuel du formateur structurant le cours dans l'espace et le temps et dcrivant les outils utiliser les outils appropris chaque module qui peuvent revtir des formes diverses : documents crits, visuels, audiovisuels postes de travail, base de formation et cas traiter Enseignement Assist par Ordinateur (EAO) didacticiels. Domaine d'application : Documentation de mise en oeuvre
SUPPORT DE FORMATION (MODULES POUR LES UTILISATEURS)

Dfinition : Ces documents, gnralement sur support papier ou dont le contenu est parfois accessible en ligne, doivent permettre de rpondre un double objectif : former les utilisateurs la pratique de l'application leur permettre de traiter des cas complexes ou inhabituellement rencontrs. Domaine d'application : Documentation de mise en oeuvre

CNRS/DSI/BQSD/conduite-projet/developpement/guide-gestion-doc

19 fvrier 2001

21 / 21