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’exploitation 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 améliorer considérablement la façon 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 sur 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 rendu en Markdown, que vous pouvez transmettre à un LLM pour un traitement plus efficace qu’un fichier HTML.

Découvrez 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.

Le llms.txt fichier sert d’index pour votre site de documentation, 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.

Découvrez le /llms.txt pour la documentation GitBook

llms-full.txt

Là où le llms.txt fichier contient un index de toutes les URL et de tous les 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.

Les pages masquées sont incluses dans llms-full.txt. Masquer une page la supprime uniquement de la table des matières publiée.

Découvrez 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 fournit aux outils d’IA un moyen structuré de découvrir et de récupérer votre documentation en tant que ressources — aucun scraping requis.

Les pages masquées restent accessibles via le serveur MCP du site. Masquer une page la supprime uniquement de la table des matières publiée.

Votre serveur MCP peut être atteint en ajoutant /~gitbook/mcp à l’URL de la 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. Vous pouvez plutôt 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.txtet llms-full.txt fichiers, ces bonnes pratiques aideront les LLM à comprendre et à exploiter 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 meilleur dans tout ça ? En général, ces recommandations rendront aussi votre documentation plus facile à lire pour les personnes.

Utilisez une structure claire et hiérarchique

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

Rédigez un contenu concis, sans jargon

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

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 en pratique.

Gardez un contenu à jour et exact

Personne n’aime une documentation obsolète. Des mises à jour régulières garantissent que les LLM ne donneront pas aux gens de fausses informations sur vos dernières fonctionnalités et mises à jour.

Testez avec des outils d’IA

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