Wiki-SIDES

Espace des référentiels de spécialités pour SIDES

Outils pour utilisateurs

Outils du site


sides:doc:notice:nommage

Notice : Convention de nommage

Définition et objectifs d’une convention de nommage

Définition

D’une manière générale, une convention de nommage est l'ensemble de règles qui définissent la syntaxe utilisée pour nommer les éléments d'un projet. Ces règles peuvent être appliqués à n’importe quels éléments d’un projet, il peut s’agir de fichier, de dossier, de variables, etc.

Dans notre cas, cette convention de nommage sera appliquée principalement au contenu docimologique (questions, dossiers, LCA, TCS) ainsi qu’aux épreuves et entrainements.

Cette convention de nommage sera partagée par l'ensemble des différents intervenants participants aux examens et à la création de contenu docimologique.

Les trois objectifs de la convention de nommage

Faciliter le travail en collaboration : Partager l'information, être rapidement lisible et compréhensif par les autres intervenants. Optimiser la production : Eviter les doublons et gagner du temps. Eviter les erreurs : Être sûr de sélectionner ou de modifier la bonne version du bon élément.


Règles et recommandation

Règles obligatoires

Ne pas utiliser les signes diacritiques: pas d'accents ni de tréma (é, è, ê, ä) pas de cédille (ç) Les caractères spéciaux : _ et – sont les seuls autorisés. : , ; . : ! ? / \ “ # [ ] > < % * @ = & ^ ( ) etc. sont interdits. Ne pas utiliser de mots vides : « le, la, les, un, une, des, et, ou » etc.

Règles de bonne pratique

Les règles de bonnes pratiques qui vont suivre n'ont pas pour but d'être appliquées de manière absolue pour chaque situation. Cependant, cette notice peut être utilisée comme un guide ou une base pour encourager à la discussion autour d’une convention de nommage commune dans chacune des institutions participantes au projet.

N’oubliez pas qu’il faut toujours ordonner les éléments d'un nom d’un élément de la manière la plus cohérente et la plus simple possible.

1- Donner un nom d’élément simple mais significatif et compréhensible. Nous vous conseillons un nom entre 25 à 64 caractère maximum pour décrire correctement l’élément.

2- Si un nombre est inclus dans le nom de l’élément : Utiliser un codage à 2 chiffres 01, 02, 03 etc.

Pour en savoir plus : D’une manière générale, Il faut utiliser un nombre constant de caractères pour les chiffres en insérant un ou plusieurs “0” placés au début afin de faciliter le classement et donner un ordre logique à l'affichage.

3- Si une date est incluse dans le nom de l’élément, utiliser l’un des formats suivants : AAAAMMJJ (20140316) AAAA-MM-JJ (2014-03-16).

Pour en savoir plus : D’une manière générale, l’année doit toujours être située en premier pour facilité la lecture et le tri par ordre alphabétique. La forme anglo-saxonne de la date est également utilisée dans les ressources françaises. En fait, il existe une norme ISO (ISO 8601) qui préconise d'inscrire la date de la manière suivante : soit YYYY-MM-DD, soit YYYYMMDD.

4- Mentionner, si besoin, le statut de l’élément dans le nom du fichier : P : provisoire V : validé Le statut doit être la dernière information visible.

Pour en savoir plus : Dans l’interface, la plupart des éléments ont déjà des statuts établis de façon plus ou moins programmatique. Pour le moment les statuts « Brouillon », « Validé » et « Validé par la commission » sont modifiables directement via l’interface. Cependant, si pour une raison ou une autre vous aviez besoin de statuts plus fins ou différents, nous vous conseillons de rajouter le statut à la fin du nom de l’élément.

5- Si le nom d'une personne figure dans le nom de document, écrire d'abord le nom de famille puis la (les) initiale(s) du (des) prénom(s).

Pour en savoir plus : En France, la tendance est plutôt à écrire le(s) prénom(s) suivi(s) du nom de famille. Par souci de concision, la première forme est la plus souvent privilégiée.

sides/doc/notice/nommage.txt · Dernière modification: 30/04/2018 13:55 (modification externe)