Régles éditoriales

Règles de nommage des ressources

Selon les recommandations en matière de nommage des fichiers électroniques et de plan de classement, nous vous proposons de respecter les règles suivantes relatives aux intitulés des ressources (fichiers) associées à vos jeux de données :

  • Le nom d’un fichier doit être succinct : éviter de dépasser 30 caractères (sans compter l’extension).
  • Le nom d’un fichier doit être précis : il contiendra idéalement : le nom du producteur, le sujet, le type de document, la date de création, éventuellement la version.
  • Date: pour le 20 décembre 2018 => 20181220 (norme ISO 8601).
  • Ne pas utiliser des articles ou mots vides : le, la, les, de, etc…
  • Préférer le caractère _(underscore, tiret du 8) à un espace
  • Eviter les lettres accentuées
  • Le nom d’un fichier ne doit pas contenir : espace, ponctuation (sauf le point avant l’extension), caractères accentués ou spéciaux (ùé+’@à°[] :</* »& !$, etc.).
  • La gestion des versions permet de suivre l’évolution et les étapes de l’élaboration d’un fichier. Il faut les distinguer soigneusement en les numérotant pour obtenir une suite logique exemple V01, V02, etc.

Amélioration des champs descriptifs avec le langage Markdown

Pour les champs descriptifs des jeux de données, des ressources et des organisations vous pouvez utiliser le langage Markdown dans le but est d’offrir une syntaxe facile à lire et à écrire.

Voici quelques exemples de syntaxe Markdown.

Cette liste n’est pas exhaustive.

=== Formatage ===

Mettre du texte en italique

*quelques mots*

quelques mots

Mettre du texte en gras

**plus important**

plus important

Pour mettre du code dans le texte:

``Mon code``

Mon code

=== Listes ===

Sauter une ligne avant le début de la liste.

Pour créer une liste non ordonnée

* Pommes
* Poires
  • Pommes
  • Poires

=== Image ====

Vous pouvez afficher une image dans vos descriptifs :

_images/CaptureDataSudConnect.PNG

Voici la syntaxe à écrire ![40% center](Image.jpg)

! indique une image à insérer

Entre crochets on trouve les options réduction ou agrandissement en pourcentage et centrage (center). Par défaut l’image est alignée à gauche en taille 100%

Attention L’image doit être disponible en ligne quelque part.

=== Liens ===

Pour créer des liens

[texte du lien](url_du_lien "texte pour le titre, facultatif")
https://trouver.datasud.fr (automatique si mon url commence par http ou https).

[Trouver des données sur Datasud.fr](https://trouver.datasud.fr)

=== Aller plus loin ===

https://fr.wikipedia.org/wiki/Markdown

https://guides.github.com/features/mastering-markdown/

https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf

Le guide du Markdown, par YannHY https://github.com/YannHY/cours/blob/master/Markdown/Le%20guide%20du%20Markdown.md

Les guides et outils de production des données

Si vous débutez en matière de réutilisation de données publiques, ouvertes, personnelles, sensibles, géographiques, etc.. nous vous invitons à commencer par découvrir la documentation produite par l’association OpenDataFrance :

Ressources Opendatalocale

D-lyne Outil de production des données respectant les standards existants, développé par OpendataFrance :

  • Saisie assistée
  • Contrôle de la qualité
  • Standardisation
  • Export et publication open data
  • Base de production permanente

Les Guides d’Etalab ont pour objectif de vous accompagner à améliorer la qualité de vos productions, collectes ou utilisation des données, codes sources de logiciel ou algorithmes :

#L’ouverture et la circulation des données :

  • Comment préparer des données à l’ouverture / la circulation ?
  • Quels jeux de données doivent être publiés en open data ?
  • Comment publier des jeux de données sur data.gouv.fr ?
  • Pourquoi et comment créer un schéma de données ?
  • Comment utiliser l’IA pour pseudonymiser des documents ?

#La transparence des algorithmes publics

  • Les algorithmes publics : pourquoi et comment les expliquer ?

#L’ouverture des codes sources de logiciels

  • Codes sources du secteur public : lesquels ouvrir, pourquoi et comment ?

Module de eLearning proposé par le portail européen de l’OpenData