Aller au contenu principal
Retour au site principal de la Bibliothèque de l'ÉTS
 

La gestion des données de recherche (GDR): 3 principes pour nommer correctement ses fichiers

Ce guide diffuse de l'information et des ressources pour appuyer la communauté de recherche de l'ÉTS dans la gestion des données de recherche.

Pourquoi est-ce important de bien nommer ses fichiers?

Avoir des règles de nommage claires permet :

  • de rester organiser,
  • de faciliter l’identification de vos fichiers,
  • de faciliter la navigation dans vos fichiers par vos collègues.

C'est d'autant plus important si :

  • vous travaillez avec de gros ensembles de données
  • vous avez des fichiers de sortie (Output files) complexes
  • vous devez coordonner l'accès aux fichiers à plusieurs personnes appartenant à plusieurs institutions.

Il existe plusieurs façons de structurer ses dossiers et différentes méthodes pour nommer ses fichiers.

La clé est la consistance.

Un nom de fichier doit :

  • être descriptif,
  • fournir de l'information sur la date,
  • préciser la version du document.

La meilleure pratique est de consulter votre laboratoire ou vos collègues AVANT LE DÉBUT DU PROJET afin de développer des règles de nommage que tout le monde est prêt à utiliser en continu.

"Documents". par xkcd sous la licence CC-BY-NC.


Quelques exemples de noms sans convention de nommage :

10_donnee 2.txt

figure 1.png

revision finale.docx

Félix horaire&plan 2022Jul9.xlsx


Ce à quoi pourraient ressembler vos fichiers avec quelques règles de nommage :

Bibliotheque-QuiFaitQuoi.txt

003_donnees-brutes_2022-07-09.txt

fig01_conversation-longueur-vs-interet.png

20220709_entrevue-transcription_v01.docx

Principe de base #1

Lisible par les machines

Illustration par Mohamed Hassan de Pixabay

Objectifs:

  • Que les caractères utilisés soient interprétés correctement par tous les systèmes informatiques
  • Que les noms soient courts et facilement recherchables

Pour nommer vos fichiers, vous utiliserez :

  • des caractères alphabétiques et chiffres arabes
  • Un délimiteur d'élément: _ (underscore)
  • Un délimiteur de mots: - (tiret) et/ou une lettre majuscule au début de chaque mot.

Et  vous éviterez :

  • les espaces et les caractères spéciaux tels que ~ ! @ # $ % ^ & * ( ) ` ; : < > ? . , [ ] { } ‘ “ |
  • les abréviations non définies dans un fichier LISEZmoi

Gardez en tête le niveau de confidentialité de vos fichiers. Assurez-vous qu'une recherche par moteur de recherche ne vous permet pas de tomber sur des fichiers sensibles (par exemple : si vous avez des données acquises sur des sujets humains, le nom du participant ne doit pas être dans le nom du fichier).

Quelques exemples:

[Element1]_[Element2]_[Ceci-Est-Un-Test].txt

 

[Element1]_[Element2]_[CeciEstUnTest].txt

Exercice #1

Essayons d'améliorer le nom de ces fichiers! Choisissez votre préféré et essayez de le rendre facilement lisible pour une machine.

Principe de base #2

Lisible par les humains

Kindle Ebook Adult Ereader E-book E-reader Tablet de Max Pixel sous licence CC0 Public Domain

Objectifs :

  • Que les noms de fichiers offrent de l'information concise sur le contenu des documents
  • Que les noms de fichiers soient facilement compréhensibles à toutes personnes ayant accès aux documents dans le futur

Vous utiliserez :

  • Minimum 3 éléments d'information, maximum 5
  • Une structure de fichiers simple

Considérez mettre le nom de l'auteur du document dans le nom du fichier. Favorisez le nom de famille suivi du prénom OU des initiales.

Prenez en note votre convention de nommage et documentez-la dans un fichier LISEZmoi.

  • Par exemple : Ma convention de nommage est [VoiciUnExemple]_[AAAA-MM-JJ]_[###]_[version].[txt] 
  • Définissez les acronymes, les abréviations et les codes utilisés

Principe de base #3

Fonctionne bien avec le classement par défaut

Objectifs :

  • Que les noms commencent par l'élément qui est utilisé pour trier les fichiers
  • Que l'information sur la version du fichier soit à la fin

En fonction de la manière dont vous voulez trier et chercher vos fichiers, choisissez de quelle façon vous voulez structurer le nom du fichier.

  • Si vous utilisez une méthode de numérotation séquentielle, ajoutez des zéros au début du chiffre (leading zeros) pour vous assurer que l'ordre séquentiel soit respecté.
    • Par exemple : 001, 002, 010, 011,...100, 101...
  • Les éléments du nom devraient être placés du plus générique au plus spécifique pour faciliter le repérage
  • Utilisez la norme ISO 8601 pour vos dates
    • AAAAMMJJ ou AAAA-MM-JJ
  • L'information sur la version devrait être à la fin du nom
    • Si vous utilisez des numéros de version, n'oubliez pas d'ajouter un zéro au début pour les plus petits nombres (leading zero). (par exemple : v01, v10 ...)
    • Si vous utilisez des mots pour déterminer la version, assurez-vous d'utiliser toujours les mêmes (par exemple : _raw, _processed, _composite)

Exercice #2

Votre laboratoire a un spectromètre qui mesurera les émissions thermale une fois par jour pendant un an. Il y a trois personnes qui prend les mesures dans le laboratoire.

Créez une convention de nommage pour ces fichiers en appliquant ce que vous avez appris aujourd'hui.

Psst! Pistes de solution au bas de la page

Exercice #3

En tant que professeur(e) du cours COM110, vous demandez à vos étudiants de remettre un essai écrit et de faire une présentation orale de ce dernier devant la classe à la fin de la session.

Quelle convention de nommage voulez-vous que vos étudiants utilisent pour leurs fichiers afin de faciliter le repérage dans vos dossiers une fois tous les travaux reçus?

Psst! Pistes de solution au bas de la page

Vous avez réussi!

Photographie par Paul Stachowiak de Pixabay

Maintenant vous savez comment organiser des fichiers avec votre propre convention de nommage. Tant que vos noms de fichiers resteront consistent et clairs, vous êtes prêts pour l'étape suivante!

Pistes de solutions aux exercices #2 et #3

Exercice #2

NomDuLabo_SPEC_AAAAMMJJ_NOMPrenom.txt

Exemple: LIVIA_SPECT_20230526_TREMBLAYLaurie.txt

 

Comme on ne sait pas si le laboratoire de l'exemple travaille dans le même serveur qu'un autre, on pourrait décider d'avoir comme premier élément d'information le nom du laboratoire.

Le deuxième élément dans cet exemple, « SPEC » est une abréviation pour spectromètre. Il faudrait bien sûr la définir dans un fichier LISEZmoi.

Le troisième élément est la date en format AAAAMMJJ, suivi du quatrième élément qui le nom et prénom de la personne ayant pris la mesure du spectromètre.

En mettant la date avant le nom de la personne qui a pris la mesure, on s'assure que les fichiers soient classés par date plutôt que par personne.


Exercice #3

SigleDuCours_GroupeClasse_NOMPrenom_DateDeRemise_TypeDeTravail.[txt]

Exemples:

COM110_01_LEVEILLEGAUVINLily_20230606_EssaiFinal.docx

COM110_01_LEVEILLEGAUVINLily_20230606_PresentationFinale.pptx

 

Premier élément : Sigle du cours comme il est possible que le ou la professeur enseigne plusieurs cours.

Deuxième élément : Nom et prénom de l'étudiant(e). De cette façon regroupe tous les travaux d'une même personne ensemble.

Troisième élément : Date de remise dans le format AAAAMMJJ

Quatrième élément : Titre ou type de travail

Selon le classement désiré, on pourrait décider d'inverser le 3e et le 4e élément. Comme le titre ou le type de travail pourrait être laissé à interprétation à la classe, il est probablement plus utile d'avoir les travaux classés par date plutôt qu'en ordre alphabétique de titre de travail