Aller au contenu principal

Gestion des données de recherche (GDR) - 3. Documenter

En deux mots : pourquoi documenter?
  • Aide-mémoire essentiel en cours de projet
  • Facilite l'interprétation et la réutilisation de vos données une fois le projet terminé

Documenter ses données

Les données de recherche sont rarement explicites en elles-mêmes. En consultant des données sans documentation, on pourrait par exemple se demander...

  • « Quel est le sens de cette abréviation? »
  • « Quelle unité de mesure est utilisée ici? »
  • « Quand et comment ces données ont-elles été collectées/traitées? »

Vos données doivent donc être accompagnées de documentation, afin d'être interprétables et réutilisables pour vous-même, votre équipe et vos pairs. 

Votre documentation peut prendre différentes formes : notes de laboratoire ou de terrain, plan de gestion de données, fichier de métadonnées lisible par machine, dictionnaire de données, fichier « Lisez-moi », vocabulaire contrôlé, etc. Vos pratiques de documentation devraient être définies dans votre plan de gestion de données.

Métadonnées

  • Informations structurées qui décrivent et contextualisent un ensemble de données
  • Répondent aux questions : Qui? Quoi? Où? Quand? Comment? Combien? Pourquoi?
  • Facilitent le repérage et la réutilisation des ensembles de données après leur partage

Des métadonnées accompagneront vos données lorsque viendra le moment de les partager dans un dépôt.

  • Titre de l'ensemble de données
  • Noms des créatrices et des créateurs
  • Identifiants uniques des autrices et auteurs (ORCiD)
  • Dates de création des données
  • Période de couverture des données
  • Description brève des données
  • Format des données
  • Mots-clés permettant leur repérage
  • Identification unique de l'ensemble de données (ex. : DOI)
  • Couverture géographique des données
  • Organismes ayant subventionné la recherche
  • Droits et licences applicables
  • Restrictions d’accès

Il existe plusieurs normes permettant de décrire ou de structurer vos données de manière standardisée.

Exemples de normes selon la discipline :

Exemples de normes générales pouvant convenir à différents types de données :

Vous trouverez une liste plus complète de normes de métadonnées dans le RDA Metadata Standards Catalog.

Comment saisir les métadonnées?

Il existe des outils qui facilitent la création de fichiers de métadonnées en format lisible par machine :

Les dépôts de données (Borealis, Figshare, Dryad, etc.) proposent un formulaire de saisie de métadonnées. Une fois les métadonnées saisies, elles peuvent exportées dans différents formats de fichiers et selon différentes normes.

Dictionnaire de données

Le dictionnaire de données contient de l'information essentielle à l'exploitation des données :

  • Description détaillée des variables
  • Signification des abréviations utilisées dans les fichiers de données
  • Unités de mesure
  • Valeurs attribuées aux données manquantes
  • Etc.

Le dictionnaire de données peut constituer un fichier à part ou être intégré à un fichier « Lisez-moi » (voir ci-dessous).

Le Center for Open Science décrit les bonnes pratiques associées à la création d'un dictionnaire de données

Fichier « Lisez-moi »

Le fichier « Lisez-moi » constitue une manière simple et efficace de rassembler de l'information sur un ensemble de données. Il se présente généralement sous la forme d'un simple fichier texte (TXT) ou en format Markdown (MD). 

Il doit accompagner en tout temps l'ensemble de données, non seulement en cours de projet, mais aussi lors de son partage dans un dépôt de données

Un fichier « Lisez-moi » comprend notamment les renseignements suivants :

  • Contexte de production des données (dates de collecte, méthodes, chercheurs et chercheuses impliqués, etc.)
  • Processus de traitement des données
  • Liste des fichiers présents dans l'ensemble de données
  • Description du contenu des fichiers (variables, unités de mesure, etc.)
  • Conditions de réutilisation des données (si ces dernières sont publiées) 

Pour en savoir plus :

Vous pouvez également utiliser le générateur de fichier LISEZ-MOI de l'Alliance de recherche numérique du Canada (en anglais seulement).

chat loading...