Documentation et métadonnées

La documentation un outil essentiel à l’interprétation de vos données, leur découverte et leur réutilisation. Elle délivre à la fois des informations documentaires (grâce aux métadonnées) sur votre jeu de données, mais aussi détaille son origine, les traitements appliqués et outils nécessaires pour le consulter, ses conditions de réutilisation, etc.

Bien documenter vos données présente plusieurs avantages :

• Pour vous : 
  • Anticiper la possibilité de les consulter à nouveau dans 6 mois, 1 an, 5 ans…
  • Préparer le partage de vos données
  • Encourager de nouvelles collaborations
  • Adopter de bonnes pratiques pour une science intègre (le Code de conduite européen pour l’intégrité en recherche rappelle que la documentation des activités de recherche fait partie des responsabilités du scientifique)
     
• Pour vos pairs :
  • Faciliter la réutilisation de vos données
     
• Pour la science :
  • Améliorer la qualité de la science à travers la réplicabilité et la transparence
  • Favoriser la science ouverte
     

La documentation recouvre l’ensemble des informations qui vont permettre de comprendre, interpréter et utiliser vos données. Elle peut prendre différentes formes, par exemple un protocole, un notebook, un cahier de laboratoire, une note méthodologique, une arborescence de fichiers, etc. 
Ces informations peuvent faire l’objet de documents complémentaires à associer au jeu de données ou être rassemblées dans un fichier README. 

Vous envisagez de rédiger un fichier README ? Voici deux modèles pour vous guider :

• Modèle de fichier README (Recherche Data Gouv) : https://recherche.data.gouv.fr/fr/categorie/33/guide/modele-de-readme 
• README file for datasets – Best practices and template (EPFL) : https://infoscience.epfl.ch/handle/20.500.14299/192546
   

Les métadonnées vont apporter une couche d’information complémentaire et structurée, lisible à la fois par les humains et les machines, à votre jeu de données. Si certaines sont générées automatiquement lors de la production des données (par exemple la date de création, les paramètres de l’instrument de mesure, etc.), d’autres sont à renseigner manuellement. Pour faciliter la saisie des métadonnées et les rendre interopérable, nous vous recommandons d’utiliser un schéma de métadonnées existant. Ces derniers s’appuient généralement sur des standards internationaux génériques ou spécifiques à une discipline, un type de donnée ou un usage. 

Vous recherchez un schéma pour documenter vos données ? Renseignez-vous auprès de votre communauté de recherche, de l’entrepôt dans lequel vous envisagez de publier vos données ou explorez un catalogue répertoriant des standards de métadonnées : 

• FAIRsharing : https://fairsharing.org/search?fairsharingRegistry=Standard
• RDA Metadata Standards Catalog : https://rdamsc.bath.ac.uk/
   

• Collectez le maximum d’informations sur vos données, et ce dès le début de votre projet, afin de simplifier la rédaction de la documentation. Cela inclut des informations sur leur collecte, les contributeurs, les traitements, instruments et logiciels utilisés, la licence de réutilisation choisie.
   
• Rédigez un fichier README précisant, entre autres, le contexte de production, les informations pour interpréter les fichiers (variables, instruments et unités de mesures utilisées, etc.), l’arborescence ou le plan de classement des fichiers, des informations de contact, de citation et de réutilisation (licence).
   
• Stockez toute la documentation (notebook, protocoles, dossier méthodologique, etc.) dans le dossier où se trouve votre jeu de données.
   
• Définissez et appliquez une convention de nommage : une bonne convention de nommage permet d’identifier rapidement les fichiers dans une arborescence logique et signifiante.
   
• Utilisez des standards de métadonnées, des ontologies et des vocabulaires contrôlés reconnus dans votre discipline
   
• Complétez le maximum de métadonnées demandées par l’entrepôt choisi. Plus elles sont complètes, plus de votre jeu de données sera visible.
   

Explorer le Guide de bonnes pratiques sur la gestion des données de la recherche du CNRS