Fichier « Lisez-moi » (readme)
Le fichier Lisez-moi permet à un membre de l'équipe ou à un utilisateur externe de comprendre et de réutiliser les données de recherche au besoin; par exemple, s'il se joint au projet en cours de route, s'il souhaite reproduire une expérience, ou encore ré-analyser les données.
Lorsque l'on dépose nos données dans un dépôt, le-s fichier-s lisez-moi fait ou font partie intégrante du processus de dépôt. Cependant, à chaque phase du projet et pour chacun des ensembles de données, on peut rédiger un fichier Lisez-moi qui synthétise les lignes directives à suivre.
On y retrouve les instructions d'interprétation et de réutilisation des données, mais également des métadonnées riches et standardisées, qui améliorent la visibilité de l'équipe de recherche et des données elles-mêmes en plus de faciliter leur partage.
Contenu du fichier « Lisez-moi »
Le fichier Lisez-moi doit être rédigé en format texte (voir exemple ici) et, dans la structure des répertoires de données publiées, se trouver en tête du répertoire des données qu'il décrit.
Information générale
- Titre du jeu de données
- Renseignements concernant l'auteur (Nom, Institution, Adresse, Courriel)
- Chercheur principal
- Co-chercheur ou chercheur associé
- Autre(s) contact (s)
- Description sommaire (objectif, nature et portée des données)
- Date de la collecte de données
- Date de production des données (moment où elles ont été finalisées)
- Date de publication des données
- Localisation géographique de la collecte de donnée
- Renseignements concernant les organismes subventionnaires ou commanditaires de cette collecte de données
Information d'accès/partage des données
- Licences/restrictions en lien avec les données, ou limitations d'utilisation
- Référence bibliographique de ce jeu de données
- Références bibliographiques et hyperliens aux publications liées à ce jeu de données
- Autres liens permettant le libre accès à ce jeu de données
- Hyperliens (et relations) aux jeux de données complémentaires ou reliés à ce jeu de données
Aperçu des données et fichiers
- Liste des fichiers (noms des fichiers et description, hiérarchie des répertoires)
- Relations entre les fichiers (si important pour la compréhension de ces derniers)
- Données supplémentaires colligées, en lien avec ce jeu de données, qui ne sont pas incluses ici
- Si les données sont dérivées d'une autre source, l'identifier
- Si plusieurs versions de ce jeu de données existent, inclure l'historique des mises à jour
Exemple :
Documentation:Documentation nécessaire pour utiliser les données
LISEZ_MOI.txt
Dictionnaire_de_donnees.pdf
Questionnaire.pdf
Fichiers_Decoupage_Geographique : Fichiers de découpage géographique (polygones)
Limites_division_recensement : Couche des limites des divisions de recensement du Canada
Limites_division_recensement.dbf
Limites_division_recensement.prj
Limites_division_recensement.sbn
Limites_division_recensement.sbx
Limites_division_recensement.shp
Limites_division_recensement.shx
Donnees : Données tabulaires
Population
population_div_recensement_QC.csv
population_div_recensement_ONT.csv
Revenu
revenu_div_recensement_QC.csv
revenu_div_recensement_ONT.csv
Information méthodologique
- Description de la méthodologie de collecte/production des données
- Description des opérations de traitement
- Logiciel (ou instrument) spécifique utilisé pour interpréter les données
- Décrire les procédures d'assurance qualité utilisées
- Identifier les personnes impliquées dans la collecte, le traitement, l'analyse et/ou la diffusion des données
Contenu des fichiers de données
(Une section pour chaque jeu de données, ou chaque fichier, au besoin)
- Nombre de variables
- Nombre d'enregistrements/lignes
- Liste des variables, définitions et abréviations, unités de mesure, codes ou symboles utilisés
- Codes de valeur manquante
- Format des données <texte, nombre, date, monnaie>, longueur de champ <nombre de caractère>, formats specialisés, autres abréviations utilisées
