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).

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

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

Pages .md

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

Check out the .md file for this 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 page llms.txt en ajoutant /llms.txt à l’URL racine de votre site de documentation.

Le fichier llms.txt 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.

Check out the /llms.txt for the GitBook docs

llms-full.txt

Alors que le fichier llms.txt contient un index de toutes les URL de pages et titres 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.

Check out the /llms-full.txt file for the GitBook docs

Les LLM peuvent utiliser cet index pour accéder directement aux versions markdown de vos pages, leur permettant d’intégrer votre documentation dans leur contexte sans avoir à analyser le HTML.

Conseils pour optimiser votre documentation pour les LLM

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

En utilisant ces optimisations, vous pouvez également améliorer la performance 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 ? Ces recommandations rendront généralement votre documentation plus facile à lire pour les humains aussi.

Utilisez une structure claire et hiérarchique

Divisez votre contenu avec de bons titres (H1, H2, H3) et ne vous contentez pas d’écrire de longs blocs de texte. Les listes à puces, les listes numérotées et les paragraphes courts rendent tout plus facile à lire.

Rédigez un contenu concis et sans jargon

Restez simple et évitez les termes techniques complexes sauf si c’est vraiment nécessaire. Les LLM s’en sortent bien mieux lorsque vous exprimez clairement vos idées 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.

Gardez le contenu à jour et exact

Personne n’aime une documentation obsolète. Des mises à jour régulières garantissent que les LLM ne donneront pas de mauvaises informations 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 votre documentation pour voir à quel point ils comprennent votre contenu. Vous pourriez être surpris par ce qui fonctionne et ce qui ne fonctionne pas.