> For the complete documentation index, see [llms.txt](https://guides.data.gouv.fr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guides.data.gouv.fr/guides/guide-qualite/documenter-des-donnees/diffuser-la-documentation-dun-jeu-de-donnees.md).
# 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](https://www.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)](https://www.data.gouv.fr/fr/datasets/operations-coordonnees-par-les-cross/), un [site statique](https://mtes-mct.github.io/secmar-documentation/) a été créé afin de présenter la documentation du jeu de données.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://guides.data.gouv.fr/guides/guide-qualite/documenter-des-donnees/diffuser-la-documentation-dun-jeu-de-donnees.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
