Les guides de l'entrepôt
Modèle de README
La qualité de la documentation des données permet d’en faciliter la compréhension et la réutilisation.
Un README (LISEZMOI) peut s’avérer nécessaire pour décrire plus en détails le contexte de production et/ou les données dans les fichiers. Il vient en complément des métadonnées saisies lors du dépôt du jeu de données, du dictionnaire de données (qu'il peut aussi contenir) et/ou autres supports de documentation accessibles. Un README est généralement diffusé dans un format ouvert, largement utilisé tel que le texte plein (txt) ou en markdown (md).
Ce modèle de README peut vous aider à structurer votre documentation. Vous êtes libre de l’adapter selon vos besoins :
- Télécharger le modèle de README au format txt (alternativement, une version en anglais est également disponible);
- Télécharger le modèle de README au format md (alternativement, une version en anglais est également disponible).
Un aperçu :
<Les textes d’aide sont écrits entre chevrons et sont destinés à être supprimés avant toute sauvegarde>
<Un README : Pourquoi ?
***La documentation d’un jeu de données doit être suffisante pour permettre à n’importe quel réutilisateur de comprendre et d’évaluer sa qualité. Le README fournit des informations complémentaires et accessibles lorsqu’elles ne sont pas déjà mises à disposition dans les métadonnées du jeu de données, dans les métadonnées des fichiers, et/ou dans des fichiers associés, ou des fichiers accessibles à long terme sur des services d’hébergement (entrepôt de fichiers ou publication). Dans ce dernier cas, nous vous prions d’inclure les URLs des documents en question ou leurs références***>
<Privilégier les formats text document (.txt), ou markdown (.md)>
Modèle de Fichier RDG README --- Général --- Version: 0.1 (2022-11-22)
Ce fichier README a été généré le [YYYY-MM-DD] par [NAME].
Dernière mise-à-jour le : [YYY-MM-DD].
# INFORMATIONS GENERALES
## Titre du jeu de données :
## DOI:
## Adresse de contact :
<Ci-après suit une liste d’éléments suggérés pour vous aider à enrichir, si nécessaire, votre documentation. La pertinence de certains dépend de la discipline du jeu de données ou du contexte de production>
<***Supprimer toute section non-applicable***>
# INFORMATIONS METHODOLOGIQUES
## Conditions environnementales / experimentales :
## Description des sources et méthodes utilisées pour collecter et générer les données :
<Si applicable, décrire les standards, les informations de calibration, les instruments utilisés, etc.>
## Méthodes de traitement des données :
<Si applicable, décrire le traitement des données et inclure tout détail pouvant être important pour réutiliser ou reproduire les données. Commenter chaque étape.
Par exemple, inclure les méthodes de nettoyage et d’analyse ; les codes et/ou algorithmes ; les procédés d’anonymisation ou de pseudonymisation pour les données sensibles concernant les humains ou des espèces menacées>
## Procédures d’assurance-qualité appliquées sur les données :
## Autres informations contextuelles :
<Toute information que vous considérez importante pour évaluer la qualité du jeu de données ou pour sa réutilisation : par exemple, des informations concernant les logiciels nécessaires pour interpréter les données.
Si applicable et non-inclus préalablement, ajouter les noms complets et les versions de tous les logiciels, de tous les paquets et de toutes les librairies nécessaires pour lire et interpréter les données *e.g.* pour compiler les scripts.>
# APERCU DES DONNEES ET FICHIERS
## Convention de nommage des fichiers :
## Arborescence/plan de classement des fichiers :
# INFORMATIONS SPECIFIQUES AUX DONNEES POUR : [NOM DU FICHIER]
<Le cas échéant, reproduire cette section pour chaque dossier ou fichier.
Les éléments se répétant peuvent être expliqués dans une section initiale commune.>
<Pour les données tabulaires, fournir un dictionnaire des données/manuel de codage contenant les informations suivantes :>
## Liste des variables/entêtes de colonne :
Pour chaque nom de variable ou entête de colonne, indiquer :
-- le nom complet de la variable sous forme “lisible par les humains” ;
-- la description de la variable ;
-- unité de mesure, si applicable ;
-- séparateur décimal *i.e.* virgule ou point, si applicable ;
-- valeurs autorisées : liste ou plage de valeurs, ou domaine ;
-- format, si applicable, e.g. date>
## Code des valeurs manquantes :
<Definir les codes ou symboles utilisés pour les valeurs manquantes.>
## Informations additionnelles :
<Toute information que vous jugez utile pour mieux comprendre le fichier>