Etape 3 : Phase de construction
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 ?
Il existe plusieurs standards techniques pour les schémas de données.
Le standard est à choisir en fonction :
de la nature des données concernées ;
des habitudes de l’écosystème produisant ou réutilisant les données liées au schéma.
Les principaux standards techniques sont les suivants :
: adapté pour la description de données tabulaires (sous forme de tableurs ou de CSV). Ce standard technique utilise le format JSON. NB : il est possible de contraindre les colonnes avec ;
: adapté pour la description de données avec une notion de hiérarchie. Ce standard utilise le format JSON ,
: adapté pour la description de données avec une notion de hiérarchie. Ce standard utilise le format XML.
Tous ces standards techniques sont supportés par .
Conseil : Aller au-delà de la documentation texte
Un schéma de données décrit uniquement par du texte ou par un tableau se prive de nombreux avantages, notamment celui de l'interopérabilité entre différents systèmes informatiques.
Les schémas de données décrits par des standards techniques permettent, en plus d’une documentation textuelle ou sous forme d’un tableau, de valider que des données correspondent à un modèle de données, d’agréger des données similaires, de générer automatiquement des données respectant un schéma.
Une fois un standard technique choisi, il faudra créer les fichiers requis pour modéliser les données.
La documentation de chaque standard technique décrit le contenu des fichiers à renseigner. Reportez-vous aux documentations respectives pour tirer parti des fonctionnalités avancées offertes : types de données et contraintes sur les valeurs en particulier.
Il est possible de vérifier qu’un fichier correspond à un standard à l’aide d’outils en ligne ou en ligne de commande. Utilisez ces outils pour vérifier que vos productions correspondent au standard.
En complément du fichier du schéma de données, il est recommandé de rédiger a minima deux documents complémentaires :
Une documentation générale qui indique le contexte, les modalités de production des données, le cadre juridique, la finalité, les cas d’usage etc. Ce fichier est traditionnellement rédigé en Markdown et nommé README.md ;
Un fichier répertoriant les changements permettant de suivre les modifications, d’une version à une autre. Ce fichier est traditionnellement rédigé en Markdown et nommé CHANGELOG.md.
Une fois votre schéma de données créé, il est nécessaire de le publier et de le diffuser pour que d’autres personnes puissent en bénéficier.
Vous bénéficierez alors des avantages habituels des dépôts de code Git en ligne :
Historique des modifications
Fonctionnalités de tickets
Demandes de modifications.
etc.
Il est conseillé d'utiliser un compte d’organisation (dédié à votre entreprise, direction, service, ministère) et non un compte personnel afin d’assurer une URL stable dans le temps.
À l’issue de cette phase, vous devriez :
Pour un schéma au format Table Schema, est mis à disposition pour créer un dépôt Git contenant un schéma au format Table Schema.
Pour les autres formats de schémas, il est conseillé de consulter les schémas et dépôts Git listés sur .
La présence de ces fichiers représente un package complet (documentation, liste des changements et schéma de données décrit dans un standard technique), apprécié des réutilisateurs. se repose sur ces éléments pour intégrer votre documentation et votre liste de changements sur une page web.
Exemple : et du schéma des lieux de stationnement.
Il est recommandé de publier vos schémas de données en tant que logiciels libres, sur votre forge de développement ou par le biais de ou .
Exemples à votre disposition : Plusieurs dépôts Git de schémas sont disponibles sur (exemple : à l’aide d’un schéma TableSchema sur GitHub).
Pour faciliter la découverte de votre schéma de données et des données sous-jacentes, il est recommandé de le faire référencer sur . La marche à suivre est détaillée .
Avoir pris contact avec les équipes de dans le but de référencer votre schéma de données si nécessaire.