Fichier README

Les README sont des fichiers au format texte (.txt) ou Markdown (.md) contenant les principales informations de contexte d'un projet ou d'un jeu de données. Ces informations visent à garantir que les données puissent être correctement interprétées lors de leur (ré)utilisation.

Il est d'usage de nommer le fichier en lettres capitales, suivies de l'extension en minuscules. Ex. README.txt, ou README.md.

Caractéristiques

En principe, toute arborescence de fichiers de données devrait être pourvue d’au moins un README principal placé à la racine du répertoire. Des README secondaires peuvent également être ajoutés pour accompagner des dossiers ou des fichiers nécessitant des informations spécifiques.

Le fichier README principal devrait au moins contenir les informations suivantes  :

  • Les noms de l'investigateur/trice principal-e et des co-investigateurs/trices de l’étude
  • Une description de la méthodologie et des outils utilisés pour la collecte des données
  • Les dates de collecte des données
  • Une description de la hiérarchie du répertoire, du type de données qu'il contient et de la convention de dénomination des fichiers
  • Une liste complète de tous les titres/codes/abréviations et conventions utilisées dans les fichiers
  • Les conditions de partage et d'accès (licence) pendant et après la fin du projet

Ces informations coïncident avec les principaux types de métadonnées. Pour en savoir plus à ce sujet consulter la page  : "Créer des métadonnées".

Comment créer un fichier README ?

La création d'un fichier README peut très facilement se faire dans un simple éditeur de texte (par exemple Notepad++ pour Windows), en ajoutant une structure basique (titres, sous-titres...) mais en évitant les symboles et structures complexes. Le style doit rester simple et accessible à un public humain (par opposition à un usage par des machines).

L'Université de McMaster au Canada propose un générateur en ligne pour créer un README à partir du modèle très populaire de l'Université de Cornell.

mcmaster-readme-generator.png

 

Comme pour toutes les actions de documentation des données de recherche, il est préférable de créer des README, ou du moins de consigner les informations que vous souhaiterez y faire figurer dès le début de la collecte des données, voire pendant la phase de planification.

Exemple de README

4TU.ResearchData a publié un exemple de README soumis dans leur data repository.

23 juillet 2026