Diffuser la documentation d'un jeu de données

Il est conseillé de proposer votre documentation en ligne et non sous format PDF : une documentation en ligne permet de s’assurer que les réutilisateurs des données disposent toujours de la version la plus à jour.

Des portails de données, tels que data.gouv.fr, proposent des espaces dédiés à la documentation du jeu de données.

Vous pouvez également héberger votre documentation sur des sites web statiques.

Si le jeu de données a pour vocation de circuler en interne de votre organisation, nous vous conseillons a minima de proposer une documentation dans un fichier séparé des données :

• Le fichier contenant les données doit être réservé à la manipulation de ces dernières ;

• Le fichier contenant la documentation a lui pour vocation d’informer sur la nature des données et sur la structure des fichiers.

Exemple : Dans le cadre de la publication des données de sauvetage en mer (opérations coordonnées par les CROSS), un site statique a été créé afin de présenter la documentation du jeu de données.