Docs prêtes pour LLM

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

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

Alors que les LLM deviennent de plus en plus importants pour la recherche d’informations et l’assistance par la connaissance, rendre votre documentation compatible avec les LLM peut améliorer significativement 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 au sujet de votre produit ou de 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 le .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.

Consultez le fichier .md pour 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. Avec ce fichier, vous facilitez la découverte et le traitement efficaces de votre contenu de documentation par les LLM.

Consultez le /llms.txt pour la documentation GitBook

llms-full.txt

Lorsque 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 le contenu complet 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 accéder directement aux versions markdown de vos pages, leur permettant d’incorporer votre documentation dans leur contexte sans avoir besoin d’analyser le HTML.

Serveur MCP

GitBook expose automatiquement un serveur Model Context Protocol (MCP) pour chaque espace publié. MCP offre aux outils d’IA un moyen structuré de découvrir et de récupérer vos docs en tant que ressources — sans besoin de scraping.

Votre serveur MCP est joignable 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 les LLM ou les IDE.

En savoir plus en lisant Serveurs MCP pour docs publiés.

Conseils pour optimiser vos docs pour les LLM

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

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

Le meilleur dans tout ça ? Ces recommandations rendront généralement vos docs plus faciles à lire pour les personnes également.

Utilisez une structure claire et hiérarchique

Divisez votre contenu avec de bonnes rubriques (H1, H2, H3) et n’écrivez pas de grands murs de texte. Les puces, les listes numérotées et des paragraphes plus courts rendent tout plus facile à lire.

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 s’en sortent bien mieux quand vous dites ce que vous voulez dire sans ajouter de fioritures.

Incluez des exemples pratiques

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

Maintenez le contenu à jour et précis

Personne n’aime des docs obsolètes. Des mises à jour régulières empêchent les LLM de fournir des informations erronées sur vos dernières fonctionnalités et mises à jour.

Testez avec des outils d’IA

Essayez réellement de poser des questions à ChatGPT ou Claude sur vos docs pour voir à quel point ils comprennent votre contenu. Vous pourriez être surpris de ce qui fonctionne et de ce qui ne fonctionne pas.