La Documentation

1. La Documentation

2. Un rôle essentiel • Matérialisation de l’état d’avancement des travaux • Moyen de communication entre intervenants • Partie intégrante de la fourniture du produit • Support des étapes suivantes • Composant (en partie) de la mémoire de l’organisation

3. La maîtrise des documents[ISO 9000-3 § 6.2] Capacité à concevoir rédiger diffuser retirer de la circulation si nécessaire les documents (adaptés à l’usage pour lequel ils sont prévus)

4. La maîtrise des documentsconcerne tout le cycle de vie Couvrir toutes les étapes du cycle de vie du logiciel • conception, paramétrage, développement, recette, installation, exploitation, maintenance • y compris les documents relatifs au système qualité Ajouter • tous les documents d’organisation liés au projet (contrat, planning, organisation du projet, plan de développement, plan de validation, procédure d’acceptation, etc.) • tous les documents de type exploitation (manuel d’installation, manuel d’utilisation, guide de maintenance, etc.)

5. 3 règles pour la maîtrise des documents • Attribuer une référence (i.e. un numéro) à un (seul) document afin de pouvoir l’identifier sans équivoque • Gérer la documentation par sous-ensembles, les références d’un même sous-ensemble étant répertoriées dans une nomenclature de gestion ; la description des liens se fait par un schéma d’arborescence • Identifier les documents en fonction de leur nature ou de leur utilisation (dossier de spécification, dossier de conception, dossier d’exploitation, etc.)

6. Circulation des documents Identification Attribuer un nom et un code à chaque document Exemple de codification : type de document (note d’information, compte-rendu de réunion, procédure, fiche ou formulaire, dossier de définition des besoins, dossier de conception générale, dossier de conception détaillée, manuel d’utilisation, etc.), émetteur(s), destinataire(s), numéro en séquence Création Rédiger le document Durant son élaboration, le document est dans l’état « provisoire » avec un n° de version compris entre 0.1 et 0.p-1 ; à la fin, le document est dans l’état « à valider » avec le n° de version 0.p

7. Circulation des documents (suite) Validation Amender le document, par une autre instance que le rédacteur A la fin, le document est dans l’état « validé » avec le n° de version 1.0 (ou n+1.0 suite à une modification) Diffusion Transmettre le document (validé) aux destinataires Modification Corriger le document (par le rédacteur) Archivage de la version n.0 et validation de la nouvelle version Suppression Retrouver, archiver et détruire tous les exemplaires diffusés

8. Normes de présentation En-tête de page : à quel document a-t-on affaire ? logo, émetteur, titre, rappel du sujet, n° d’identification, date d’édition, n° version/révision Corps du document : partie utilisable par le rédacteur utiliser un style unique de présentation des chapitres et paragraphes, une police et une taille de caractères unique et agréable (ex. : Times New Roman, 12 points) Pied de page : informations complémentaires nom du fichier, état de validation du document, etc.

9. Différentes catégories de pages • Couverture • Sommaire avec table des matières • Liste des destinataires • Circuit des valideurs • Identifiant des mises à jour

10. Documents à fournir à chaque étape du cycle de vie Démarrage du projet Plan qualitéPlan de développement Analyse du besoin Cahier des charges fonctionnelSpécification technique de besoin Spécifications du système Document de définition préliminaire du systèmeManuel sommaire d’utilisationPlan de validationPlan de qualificationPlan du Cahier de recette

11. Documents à fournir à chaque étape du cycle de vie (suite 1/4) Spécifications d’un sous-système Document de définition préliminaire du sous-systèmeManuel sommaire d’utilisationPlan du Cahier de recette Conception générale sous-système Document de conception générale du sous-systèmeDossier d’interfaceDossier de Tests de validation du sous-système Plan d’intégration du sous-système Enrichir le Manuel d’utilisationDossier justificatif de choix

12. Documents à fournir à chaque étape du cycle de vie (suite 2/4) Conception détaillée sous-système Document de conception détaillée du sous-systèmePlan de détail du matérielSpécifications d’achat de matérielDossier d’interfaceDossier justificatif de choixManuel d’utilisationDossiers plan de tests unitaires du sous-systèmeDossier plan de tests de validation du sous-systèmePlan d’intégration du sous-système Réalisation d’un sous-système Dossier de codage des composants logicielDossier de tests unitaires des composants du sous-système

13. Documents à fournir à chaque étape du cycle de vie (suite 3/4) Tests unitaires d’un sous-système Dossier de tests du sous-système Tests d’intégration d’un sous-système dans le système Dossier de tests d’intégration du sous-système Tests de validation d’un sous-système Dossier de tests de validation du sous-système Tests d’intégration du système dans son environnement (autres systèmes) Dossier de tests d’intégration du système

14. Documents à fournir à chaque étape du cycle de vie (suite 4/4) Tests de validation du système Dossier de tests de validation du systèmeCahier de recetteProcès-verbal de recette interne Qualification opérationnelle Dossier de qualification opérationnelleCahier de recetteProcès-verbal de recette client Exploitation - Maintenance Fiches d’intervention après vente (sous/hors garantie)

15. La structure de la documentation[ISO 9001 § 4.4] Niveau 1 (description d’ensemble) : maîtrise de base • description des concepts, des objectifs et des politiques d’entreprise • définition de la responsabilité de la direction, les délégations des responsabilités et autorités Niveau 2 (procédures d’ordre général) : coopération • description générale et détaillée des responsabilités et autorités pour chaque fonction ou département Niveau 3 (instructions/outils) : bases de travail pour les tâches de chacun • enregistrement des documents opérationnels produits par les personnes chargées de l’exécution des procédés

16. Répartition des documents d’un projet logiciel du niveau 1 Manuel Qualité Énonce la politique qualité Décrit le système qualité pour toute l’organisation Manuel Assurance Qualité (MAQ) Répond aux exigences externes de la qualité pour tous les clients Manuel Assurance Qualité Logiciel (MAQL) Répond aux exigences externes de la qualité pour les besoins spécifiques du logiciel

17. Répartition des documents d’un projet logiciel du niveau 2 Plan Qualité Dispositions spécifiques se rapportant à un produit, un client, un projet, un service Plan Assurance Qualité Dispositions particulières pour un couple client/produit Plan Assurance Qualité Logiciel type (PAQL) Dispositions spécifiques se rapportant à un projet logiciel Procédures générales Manière spécifiée d’accomplir une activité (quoi, qui, comment, quand, où, combien)

18. Répartition des documents d’un projet logiciel du niveau 2 (suite) Instructions de travail Description détaillée de la façon de réaliser une activité Modèles types de documents Définition des structures normalisées des dossiers et documents Formulaires Cadre normalisé pour les documents préétablis à remplir pour la saisie d’informations Fiches Cadre normalisé pour les imprimés préétablis à compléter

19. Répartition des documents d’un projet logiciel du niveau 3 Notes d’information Preuve tangible des échanges d’informations internes Compte-rendu de réunion Preuve tangible des décisions prises en réunion Dossiers d’études(définition de besoins, conception) Matérialisation des résultats obtenus lors des travaux d’études Guides d’utilisation Formalisation des consignes sous forme de mode d’emploi des procédures et outils

20. Répartition des documents d’un projet logiciel du niveau 3 (suite) Revues Enregistrement des contrôles effectués Plan d’Assurance Qualité Logiciel pour le projet « P » Déclinaison du PAQL type appliqué au projet « P » Graphes de modélisation Formalisation des travaux de conception