Norme d'appellation, de numérotation et de métadonnées

6. Contenu des documents

6.1 État

L'état indique le statut d'un document tout au long de son cycle de vie.

• Il faut enregistrer l'état d'un document dans la liste des documents, et non à l'intérieur du document, de manière qu'une version du document puisse changer d'état sans modification de son contenu.
• L'état correspond à l'étape appropriée du cycle de vie du document.
• Il faut apposer le filigrane TEC (travail en cours) sur les versions de documents qui ne sont pas prêtes à être révisées.
• Le filigrane ÉBAUCHE doit être apposé sur les documents qui sont en cours de révision, mais qui ne sont pas définitifs.
• Les bases de référence approuvées pour une série d'articles correspondent à l'ensemble des versions approuvées.
• Le tableau ci-dessous présente les valeurs utilisées pour indiquer l'état d'un document.

Sommaire du tableau

Ce tableau décrit les valeurs utilisées pour indiquer l'état d'un document : L'état, Non contrôlé, À l'interne et Produit livrable.

État	Non contrôlé	À l'interne	Produit livrable
Aucun (ne rien indiquer)		Pas commencé	Pas commencé
ÉBAUCHE		Commencé Filigrane ÉBAUCHE	Commencé Filigrane ÉBAUCHE
TEC	S.O.	Commencé Filigrane TEC	Commencé Filigrane TEC
Examen	S.O.	Examen	Examen
Révision	S.O.	Révision	Révision
Vérification	S.O.	Des modifications ont été apportées au document	Des modifications ont été apportées au document
Approuvé	S.O.	Publié	Publié
Remplacé	S.O.	Remplacé	Remplacé
Désuet	S.O.	N'est plus utilisé N'a pas été remplacé	N'est plus utilisé N'a pas été remplacé

6.2 Numérotation des figures et des tableaux

• Les documents relatifs à des procédures ne doivent pas comporter de légende de schéma, de table des figures, de légende de table et de table des tableaux.
• La numérotation automatique de Word doit être utilisée. Le premier caractère désigne le niveau de titre où la figure ou le tableau a été placé. Le deuxième caractère est le numéro séquentiel de la figure ou du tableau dans cette section.

  Figure 6-1 - Légende
  Figure 6-2 - Légende
  Tableau 6-1 - Légende
  Tableau 6-2 - Légende

• Les modèles de légendes ci-dessus peuvent être copiés en vue de leur utilisation. Lorsque des modèles sont créés, un échantillon des légendes doit être inclus pour éviter aux auteurs de créer ou de chercher les légendes.

6.3 Annexes et appendices

• Les annexes sont des documents distincts qui sont joints à des documents plus importants.
• Les appendices sont des sous-sections internes ajoutées à la fin de documents ou d'annexes pour fournir des renseignements additionnels, notamment sous la forme de grands tableaux ou de rapports provenant de base de données. Les appendices ne comportent pas de titres numérotés.
• La hiérarchie est : document, annexe, appendice.
• Les annexes doivent être identifiées au moyen de lettres majuscules, c'est-à-dire A, B, C, etc.
• Les appendices doivent être identifiés au moyen de chiffres ou de nombres, c'est-à-dire 1, 2, 3, etc.
• Le nom d'une annexe doit être composé du nom du document, suivi de celui de l'annexe :
  • CMP Annexe B v.1.0.doc
  • CMP Annexe B v.1.2.doc
• Il faut restreindre le nombre d'annexes et d'appendices utilisés dans un document. Il est préférable de produire plus de documents distincts (dotés de leur propre titre), en établissant toutefois un ordre de préférence et des relations entre les documents.

6.4 Versions des documents

Norme d'appellation

• La norme à respecter est vE.V.
• E désigne l'édition, c'est-à-dire un article qui a été approuvé à la suite d'un processus d'examen des produits livrables ou d'un processus d'examen interne. Une édition peut contenir plus d'une version.
• V désigne la version, une copie provisoire d'une édition qui n'a pas encore été approuvée. La version est incrémentée à la discrétion de l'auteur ou au moins une fois pendant son utilisation. Les documents dotés du même identifiant de version doivent être identiques.
• Par « v1.2 », on entend « version un point deux ».

Exemple

CMP v1.2
CMP v1.3
CMP v2.0

Le système CVS fait le suivi des versions des éléments de configuration des logiciels personnalisés et les documente à l'interne, ce qui nous évite d'inscrire les identifiants de versions dans les noms des fichiers et des documents stockés dans CVS. Nous inscrivons le numéro de version à l'intérieur des fichiers et dans la section Historique des révisions des documents.

6.5 Versions de logiciels

La norme quant à la numérotation de versions de logiciels est la suivante :

EE.VV.CC [AAAA-MM-DD][hh:mm]

Versions de logiciels : description de la norme de numérotation de versions de logiciels.

Élément	Description
EE	Nombre naturel séquentiel à deux chiffres, sans zéro à gauche, indiquant l'édition
.	Séparateur fixe
VV	Nombre naturel séquentiel à deux chiffres, sans zéro à gauche, indiquant la version
CC	Nombre naturel séquentiel à deux chiffres, sans zéro à gauche, indiquant le correctif
« » (espace)	Séparateur fixe
AAAA-MM-JJ	Indicateur de date pour les composants individuels du logiciel
hh:mm	Indicateur de temps pour les composants individuels du logiciel

Le processus d'identification des versions de logiciels ne s'applique pas à tous les noms de fichiers. L'identifiant d'une version est enregistré dans le code source, les écrans de type Aide (le cas échéant), les métabalises, etc.

Le système de contrôle des codes sources des logiciels (CVS) utilise les versions numérotées de chaque fichier pour sélectionner des versions de code appropriées pour les correctifs.

Exemples :

1.0
2.0
2.0.1 Correctif 1 de la version 2.0

6.6 Référence de base des logiciels

Les lignes de base sont nommées en fonction de la matrice suivante :

<Product> + "_" + <Release> + "-" + <Type>

Exemple

<Product> will be AIMS. It can assume other values, as required
<Release> is a numeric separated with periods
<Type> will be one of {F, A, D, P} denoting {Functional, Allocated, Development, Product}

Par exemple, la ligne de base fonctionnelle de la deuxième version du projet de la DSGAI sera nommée :

AIMS_2.0-F

6.7 Nombres dans les feuilles de calcul

Microsoft Excel peut contrôler l'affichage des nombres à l'aide d'une fonction de formatage personnalisé. Le formatage personnalisé est effectué en quatre parties, selon le contenu de la cellule : nombre positif ou négatif, zéro ou texte. Pour utiliser la fonction de formatage personnalisé, il faut sélectionner au moins une cellule et choisir la catégorie Personnalisée dans le menu Format/Cellule/Nombre.

La catégorie Personnalisée doit être affichée dans le champ Type.

Le symbole du dollar est utilisé pour les totaux et le premier d'une série de nombres énumérés dans une colonne :

_($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)

Le symbole de dollar n'est pas utilisé pour les autres nombres de la colonne :

_(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)

Ces formats ne tiennent pas compte de la police, des bordures, de l'alignement, de la forme ou de tout autre formatage de cellule.

Navigation pour le document de la « Norme d'appellation, de numérotation et de métadonnées »