Documentation prête pour les LLM

Fournir une version de votre site de documentation adaptée aux LLM

Nous développons des fonctionnalités qui facilitent l’ingestion et l’utilisation de votre contenu documentaire par les grands modèles de langage (LLM).

À mesure que les LLM deviennent de plus en plus importants pour la recherche d’informations et l’assistance à la connaissance, veiller à ce que votre documentation soit adaptée aux LLM peut considérablement améliorer la manière dont ces modèles comprennent et représentent vos produits ou services.

Une documentation optimisée pour les LLM garantit que des systèmes d’IA comme ChatGPT, Claude, Cursor et Copilot peuvent récupérer et fournir des réponses précises et contextuelles concernant votre produit ou votre API.

.md pages

Avec GitBook, toutes les pages de votre site de documentation sont automatiquement disponibles sous forme de fichiers Markdown. Si vous ajoutez l’ .md extension à n’importe quelle page, vous verrez le contenu de cette page affiché en Markdown, que vous pourrez transmettre à un LLM pour un traitement plus efficace que celui d’un fichier HTML.

Consultez le fichier .md de cette page

llms.txt

llms.txt est une norme proposée pour rendre le contenu web disponible dans des formats textuels plus faciles à traiter pour les LLM. Vous pouvez accéder à la llms.txt page en ajoutant /llms.txt à l’URL racine de votre site de documentation.

La llms.txt fichier sert d’index pour votre site de documentation, en fournissant une liste complète de toutes les pages disponibles au format Markdown. Grâce à ce fichier, vous facilitez la découverte et le traitement efficaces de votre contenu documentaire par les LLM.

Consultez le /llms.txt pour la documentation GitBook

llms-full.txt

Là où le llms.txt fichier contient un index de toutes les URL et titres des pages de votre site de documentation, le llms-full.txt contient l’intégralité du contenu de votre site de documentation dans un seul fichier qui peut être transmis aux LLM comme contexte.

Consultez le fichier /llms-full.txt pour la documentation GitBook

Les LLM peuvent utiliser cet index pour naviguer directement vers les versions Markdown de vos pages, ce qui leur permet d’intégrer votre documentation dans leur contexte sans avoir à analyser le HTML.

serveur MCP

GitBook expose automatiquement un serveur Model Context Protocol (MCP) pour chaque espace publié. MCP offre aux outils d’IA une manière structurée de découvrir et de récupérer votre documentation sous forme de ressources — aucun scraping requis.

Votre serveur MCP peut être atteint en ajoutant /~gitbook/mcp à l’URL racine de votre site de documentation. Par exemple, le serveur MCP de la documentation GitBook se trouve à https://gitbook.com/docs/~gitbook/mcp.

Visiter cette URL dans votre navigateur entraînera une erreur. À la place, vous pouvez la partager avec des outils capables d’effectuer des requêtes HTTP, comme des LLM ou des IDE.

En savoir plus en lisant Serveurs MCP pour la documentation publiée.

Conseils pour optimiser votre documentation pour les LLM

Maintenant que votre site GitBook génère automatiquement des .md pages, llms.txt, et llms-full.txt fichiers, ces bonnes pratiques aideront les LLM à comprendre et à utiliser efficacement votre contenu.

En utilisant ces optimisations, vous pouvez également améliorer les performances de votre documentation dans les moteurs de recherche alimentés par l’IA et dans l’optimisation des moteurs génératifs (GEO).

Le mieux dans tout ça ? Ces recommandations rendront généralement aussi votre documentation plus facile à lire pour les humains.

Utilisez une structure claire et hiérarchique

Découpez votre contenu avec de bons titres (H1, H2, H3) et n’écrivez pas simplement de gigantesques blocs de texte. Les puces, les listes numérotées et les paragraphes plus courts rendent la lecture plus facile.

Rédigez un contenu concis et sans jargon

Restez simple et évitez les termes techniques complexes, sauf si vous en avez vraiment besoin. Les LLM fonctionnent bien mieux lorsque vous exprimez clairement ce que vous voulez dire, sans ajouter de remplissage.

Incluez des exemples pratiques

Montrez, ne vous contentez pas de raconter. Des extraits de code, des exemples d’API et des scénarios réels aident les LLM — et vos utilisateurs — à comprendre comment les choses fonctionnent réellement dans la pratique.

Gardez un contenu à jour et exact

Personne n’aime une documentation obsolète. Des mises à jour régulières permettent aux LLM de ne pas fournir d’informations erronées sur vos dernières fonctionnalités et mises à jour.

Testez avec des outils d’IA

Essayez vraiment de poser à ChatGPT ou Claude des questions sur votre documentation pour voir dans quelle mesure ils comprennent votre contenu. Vous pourriez être surpris par ce qui fonctionne et ce qui ne fonctionne pas.