Squelette de la documentation

139bercy / decp-docs

Documentation de la collecte et de la publication des données essentielles de la commande publique (DECP)

https://139bercy.github.io/decp-docs/

MIT License

1 stars 1 forks source link

Squelette de la documentation #3

Open ColinMaudry opened 4 years ago

ColinMaudry commented 4 years ago

Créer la structure de la documentation.

ColinMaudry commented 4 years ago

Je pense à cette structure pour la doc. Des commentaires @strainel ?

Contexte
- évolutions à venir
- Arrêté avis de publicité en vigueur en 2022
- Convergence recensement-DECP en 2023
Données publiées
- Où ?
- data.economie.gouv.fr
- data.gouv.fr
- Quoi ?
- sources (et sources manquantes identifiées)
- contenu
- stats
- Schémas
- versions
Traitements des données
- dépôt(s) de code
- collecte
- corrections
- consolidation
- publication

strainel commented 4 years ago

oui c'est l'idée. j'organiserai plutôt ainsi. @ColinMaudry @arnaud-famin

Contexte et présentation générale
- Objectifs
- Textes législatifs et réglementaires
- Acteurs / partenaires
DECP
- Données publiées
- Où les trouver ? (données consolidées et données "augmentées")
- Monitoring & tableau de bord orienté métiers
- Les schémas
- Processus de consolidation
- Collecte / Corrections / Consolidation / Publication
- Enrichissement des données
Contribution ouverte
- Ateliers
- Dépôts GitHub
- Prochaines évolutions
- Signalement d'anomalies

ColinMaudry commented 4 years ago

Un des enjeux est de répartir l'information entre cette documentation centralisée et la documentation présente dans les datasets et les dépôts de code.

Je vais trouver un équilibre entre :

dupliquer une partie de l'information pour faire la jonction et ne pas forcer la visite de chaque dataset et chaque dépôt (= decp-docs doit être un minimum "standalone")
ne dupliquer que de l'information intemporelle, de façon à ne pas devoir la mettre à jour à X endroits différents (decp-docs + dataset/repo de code)

strainel commented 4 years ago

Je ne suis pas sûr ; il n'y a pas d'enjeu à laisser éparpiller la documentation. Il faut éviter le labyrinthe documentaire et renvoyer systématiquement vers un lieu unique de document en utilisant par exemple des liens fins vers les parties documentaires concernés.

ColinMaudry commented 4 years ago

Donc on réduit le README des dépôts de code au minimum (dépendances, installation, exécution) ?

On pourrait aussi les importer automatiquement dans la doc centrale, le lien est prévisible (https://raw.githubusercontent.com/139bercy/repo/master/README.md). Mais plus tard, ça tient pas dans le temps prévu (de mon côté du moins).

ColinMaudry commented 4 years ago

Par exemple, les données contenues dans les DECP sont détaillées sur le dataset Référentiel de données marchés publics.

Si je te suis, je supprime cette information du dataset et je l'inclus dans la doc ?

strainel commented 4 years ago

Sur cet exemple précis : il s'agit du format du fichier. Il me parait utile qu'il soit correctement documenté et rassemblé sur le nouvel espace documentaire DECP. À terme, la page du dataset doit renvoyer vers les bons éléments de la documentation.

ColinMaudry commented 4 years ago

Actuellement pas d'enrichissement des données, mais on garde l'idée sous le coude (à partir du SIRENE par exemple).