ARCHIVÉ - Procédure d'identification des versions

Cette page a été archivée.

Objectif

Définir le système de numérotation de la version, des éléments et des documents des versions et des variantes des éléments de la configuration.

Portée

Tous les éléments de base (y compris les fichiers sources, les fichiers du programme de construction, les modules d'objets, les versions et les spécifications techniques) sont conformes à la présente procédure.

Les éléments non approuvés (c'est-à-dire à l'état brouillon) qui ne sont pas encore soumis au contrôle de la configuration (par exemple des prototypes) ne sont pas tenus de se conformer à la présente procédure qui, en pareil cas, devrait servir de ligne directrice.

Renvois

CM030 Procédure de contrôle du changement

CM012 Formulaire de passation de la gestion du changement

Points en suspens

Aucun.

Approbations

Gestionnaire de l'élaboration.

Responsabilités

Il incombe au gestionnaire de projet d'appliquer la présente procédure au projet pertinent.

Il incombe au gestionnaire de projet de prendre la décision finale concernant l'attribution d'un identificateur à tous les éléments de la configuration, s'ils soient conformes à la présente procédure.

Il incombe à l'équipe de projet de mettre en œuvre la présente procédure.

Il incombe au bibliothécaire de la configuration de veiller à ce que tous les éléments de la configuration qui se trouvent dans la bibliothèque soient conformes à la présente procédure.

Intrants

Éléments non identifiés.

Extrants

Éléments portant un identificateur unique.

Mécanismes de contrôle

Effectuer des vérifications indépendantes pour assurer la conformité à la présente procédure et proposer des améliorations au processus.

Le bibliothécaire vérifie les Formulaires de passation de la gestion de la configuration utilisés pour présenter des éléments à verser à la bibliothèque de la gestion de la configuration.

Utiliser l'identification de la version pour récupérer des éléments de la bibliothèque de la gestion de la configuration et pour y avoir accès.

Utiliser les produits à livrer dans le cadre du projet lors du cycle de vie de l'élaboration, ce qui veille à l'identification des éléments de la configuration.

Procédure

Généralités

L'équipe de projet attribue des identificateurs uniques aux éléments assujettis à la gestion de la configuration, comme il est indiqué au paragraphe sur l'Identification des éléments ci-après.

Le gestionnaire de projet attribue des identificateurs uniques aux versions de base (et aux mises à niveau provisoires), comme il est indiqué au paragraphe sur l'Identification de la version.

Le gestionnaire de projet peut choisir d'apposer sur les éléments et les versions un timbre horodateur en plus de l'identification de la version indiquée dans les présentes.

Identification des éléments

Chaque élément a son nom de fichier, propre au projet, qui est établi conformément au paragraphe sur la Nomenclature des fichiers ci-après.

Chaque élément comprend l'historique des changements, conformément à la Procédure de contrôle du changement.

Chaque élément est associé à un identificateur de version, qui prend l'une des deux formes suivantes :

i. un nombre entier; la version de base initiale commence par « 1 » et les versions suivantes augmentent de un;

ii. un identificateur décimal du formulaire décrit au paragraphe sur l'Identification de la version qui est utilisé, par exemple, lorsque de la documentation est associée à la version d'un produit.

Les éléments ne peuvent prendre plus d'une forme.

Il n'est pas nécessaire d'établir de corrélation entre un identificateur d'élément et un identificateur de version.

Chaque élément peut, au choix, être associé à ce qui suit :

i. une description d'élément

ii. une date de création ou d'achat (ou un renvoi)

iii. un motif de création ou d'achat (ou un renvoi)

Par la suite, les variantes sont identifiées de la manière indiquée au paragraphe sur l'Identification de la variante ci-après.

Les documents non approuvés (et les ébauches) et les systèmes prototypes portent des mentions précises à cet effet.

Chaque document d'utilisateur porte un titre, un nom de fichier et un identificateur, comme il est indiqué dans le paragraphe sur la Nomenclature des documents ci-après.

Identification des variantes

Dans la mesure du possible, les variantes ne sont pas entreposées à part; pour ce faire, on utilise la compilation conditionnelle, les scripts de construction, etc.

S'il est impossible d'entreposer les variantes dans un seul fichier, le bibliothécaire de la configuration tient un système manuel de renvois entre les variantes, qui est consigné dans une instruction de travail.

Lorsqu'une variante est transmise à la bibliothèque de la configuration, le Formulaire de passation de la gestion de la configuration renferme tous les renseignements pertinents qui permettent d'identifier les variantes connexes.

Identification de la version

Dans le présent document, le terme version désigne une combinaison de fichiers qui, une fois regroupés, deviennent un élément de configuration.

Toutes les versions sont identifiées selon la méthode M.F.I, où :

M désigne une mise à jour principale, commençant par « 1 »

F désigne une caractéristique mineure ou la correction d'erreurs, commençant par « 0 »

I désigne une mise à niveau interne, commençant par « 0 »

p. exemple Version 2.1.0.

Ces champs numériques augmentent de façon monotone.

Il n'est pas nécessaire d'indiquer le champ interne dans les communications avec des gens de l'extérieur du Service X.

Des pièces peuvent être utilisées, par exemple dans le cadre de versions partielles; on les reconnaît par la lettre ajoutée au champ F ou I. Par exemple Pièce 2.1A.0.

Les versions sont construites à partir d'une combinaison d'éléments de configuration qui, eux aussi, portent des identificateurs de version (voir ci-dessus). Le bibliothécaire de la configuration tient un registre des éléments de configuration (et de leurs versions) qui composent une version.

Nomenclature des documents

Titre du document, nom du fichier et identificateur

L'auteur propose un titre pour le document en suivant le modèle indiqué ci-après.

L'auteur assigne un nom de fichier et attribue un identificateur de document unique en respectant les conventions indiquées ci-après.

Le gestionnaire de la configuration approuve l'utilisation du nom de fichier et de l'identificateur.

Le bibliothécaire de la configuration tient une liste des noms de fichiers et des identificateurs attribués, ainsi que des titres correspondants.

Nom de fichier

La documentation des utilisateurs porte des noms de fichiers correspondant à pppttnnn.yyy, où

ppp désigne le numéro de projet unique attribué par le bibliothécaire de la configuration

ttnnn désigne l'identificateur unique (q.v.)

yyy désigne l'extension de fichier qui convient au document à l'appui.

Identificateur

Chaque document porte un identificateur unique suivant la présentation ttnnn, où

tt désigne les deux lettres du titre du document, selon ce qui suit.

Titre

Voici des exemples de titres :

Élément	Mnémonique	Titre	Explication
1	UG	Guide de l'utilisateur pour....	Instructions de base sur le fonctionnement d'un système
2	IN	Introduction à.....	Trousse simple du débutant pour l'utilisation d'un système
3	RM	Ouvrage de référence pour....	Description des caractéristiques et des commandes en ordre alphabétique ou autre
4	TU	Didacticiel pour....	Instructions pour l'apprentissage d'un système
5	RN	Remarque sur la version concernant....	Renseignements sur le contenu d'une version donnée

D'autres titres peuvent être utilisés, si le gestionnaire de projet le permet.

Le nom du système ou du projet doit figurer dans le titre.

Nomenclature des fichiers

Le programmeur ou l'auteur responsable de l'élément de configuration attribue un nom unique et pertinent à chaque fichier dans le cadre d'un projet. Le bibliothécaire de la configuration s'assure du caractère unique de l'identificateur.

Les fichiers susceptibles d'être révisés renferment un historique des changements, selon la Procédure de contrôle du changement. Les autres conventions de nomenclature qui suivent peuvent s'appliquer, au choix.

Les fichiers ne pouvant être modifiés sont visés par d'autres conventions de nomenclature :

i. Les deux derniers caractères du nom du fichier, sans compter l'extension, indiquent le numéro de la version, par exemple x.y.

ii. Le nom du fichier ne comprend pas de point décimal (s'il y a lieu).

iii. Les chiffres supérieurs à 9 sont représentés par des lettres.

iv. Par exemple, driver32.doc représente la version 3.2 du fichier driver.

Les fichiers sources qui ne peuvent être révisés (par exemple certains fichiers 4GL) sont associés à un fichier de l'historique des changements (voir la Procédure de contrôle du changement). Dans le cas de ces fichiers, l'extension « .chg » remplace l'extension conventionnelle.

Formulaires connexes

Formulaire de passation de la gestion de la configuration, CM012.