Bien documenter un jeu de données
Dernière mise à jour
Cet article vous a-t-il été utile ?
Guides de data.gouv.fr
Dernière mise à jour
Cet article vous a-t-il été utile ?
La bonne documentation d'un jeu de données recouvre, entre autres :
une description générale du jeu de données
une description du mode de production des données
une description du modèle de données
une description du schéma de données
une description des métadonnées
une description des changements majeurs
Il est conseillé de commencer la documentation par une description synthétique du jeu de données qui donne un aperçu rapide des informations mises à disposition.
La description générale peut couvrir les points suivants :
Exemple : Description générale du
La structure d'un jeu de données et son contenu sont liés au contexte de production des données. La description de l'environnement métier est donc indispensable.
La description du mode de production du jeu de données permet au réutilisateur de comprendre la structure du jeu, la nature des données et les possibles manques ou incohérences du fichier.
Il est donc conseillé de préciser :
les champs "id_station_itinerance" et "nom_station" correspondent à des attributs d'une même entité "station",
les champs "id_pdc_itinerance" et "puissance nominale" correspondent à des attributs d'une même entité "point de charge".
Une "station" contient un ou plusieurs "point de charge" (relation entre les deux entités).
Il est conseillé de :
Une fois le modèle établi, il convient de définir le découpage en fichiers. Il est possible de :
regrouper des entités dans un même fichier
créer un fichier par entité
Si vous publiez des données tabulaires, il est conseillé de produire un tableau récapitulatif indiquant, pour chaque colonne :
Les termes employés dans un jeu de données sont propres à un environnement métier.
S’il existe des termes complexes ou des énumérations, il est conseillé de :
Fournir un lexique de ces valeurs
Cet effort de définition fait gagner un temps considérable au réutilisateur et permet de prévenir des contre-sens dans l’exploitation des données.
Des formats standards de métadonnées existent afin de faciliter leur collecte, leur recherche et leur traitement automatique.
Sur data.gouv.fr, il est possible de renseigner directement les métadonnées d’un jeu de données. Les métadonnées retenues sont les suivantes :
Titre
Sigle
Description
Licence
Fréquence de mise à jour
Mots clés
Couverture temporelle
Couverture spatiale
Granularité spatiale
Mode privé
La description des métadonnées apportera à un jeu de données une meilleure visibilité sur les catalogues.
En pratique, il est souhaitable que le modèle de données et la nature de vos données n’évoluent pas au fil du temps.
Toutefois, des changements dans la structure des données, dans le mode de collecte ou dans les dispositions réglementaires peuvent affecter le jeu de données.
Dans cette situation, il est conseillé de tenir une liste de ces changements
Cette liste peut faire figurer :
la date
la version des données (si vous versionnez vos données)
la nature du changement
Si nécessaire, il est possible d’indiquer des liens, comme par exemple lorsque des changements sont introduits par une modification du code de transformation des données.
La date du changement
La nature du changement
Les liens associés au changement
Les réutilisateurs des données peuvent avoir des questions à propos des fichiers mis à disposition.
Il est conseillé de proposer un espace d’échange entre les producteurs et réutilisateurs des données : il est préférable que cet espace d’échange soit public afin qu’il puisse bénéficier aux personnes qui auraient des questions similaires.
La collecte des retours d’usage permettra d’améliorer votre documentation de manière incrémentale.
Par exemple, précise que la réutilisation du jeu de données « » ne peut avoir ni pour objet ni pour effet de permettre la ré-identifications des personnes liés à des transactions immobilières.
Exemple : Dans le (infrastructures de recharge des véhicules électriques), on peut identifier que:
Exemple : du décrit le modèle de données utilisé. Ce modèle de données permet de comprendre rapidement les relations qui unissent les différentes entités du jeu de données. Dans cet exemple, il a été choisi d'associer un fichier par entité.
Cela constituera une base solide en vue de la création d'un schéma de données, dont le processus est détaillé .
Exemple : La documentation du présente un tableau récapitulatif des différentes colonnes. La description des champs permet de faire le lien avec le fichier de données, ce qui facilite la lecture des données.
Exemple : La base de données de recense l’ensemble des transactions immobilières intervenues au cours des cinq dernières années. Le vocabulaire utilisé dans ce jeu de données est issu d’un environnement administratif, parfois difficile à appréhender. La Direction générale des Finances publiques met à disposition une qui comprend notamment un lexique de définition des termes rencontrés. Ce lexique facilite l’appropriation et la réutilisation des données par des acteurs tiers.
Exemple : du comporte une section “Changement sur le jeu de données”. Cette section référence les changements du jeu de données en renseignant les informations suivantes :
