Fichier README.txt

Les README.txt sont des fichiers au format texte (.txt) contenant les principales informations de contexte sur un projet ou 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 faire apparaître le mot README, en lettres capitales, dans le nom du fichier.

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 ?

Les fichiers README sont tout simples et peuvent être créés manuellement, sans devoir utiliser de norme spécifique ou de vocabulaire contrôlé, car ils doivent être facilement compréhensibles par des humains.

L'Université de McMaster au Canada propose un outil, sous forme d'un formulaire en ligne, pour créer votre propre README à partir du modèle 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.