llms.txt für Dokumentationsseiten
Veröffentlicht:
Dokumentationsseiten sind der ideale Anwendungsfall für llms.txt: Menschen fragen KI-Tools ständig „Wie mache ich X in Ihrem Produkt“, und eine kuratierte Datei verweist diese Modelle direkt auf die richtigen Seiten.
Warum Dokumentationen am meisten profitieren
Ihre Dokumentation ist bereits die Antwort. llms.txt ermöglicht es Ihnen, einem Modell einen sauberen Index davon zu übergeben — Erste Schritte, Anleitungen, API-Referenz — anstatt es Navigation, Suchoberflächen und Marketingseiten durchforsten zu lassen.
Aus Ihrer Struktur generieren
Die meisten Dokumentationsseiten verfügen bereits über eine sitemap.xml. Gruppieren Sie diese URLs in einige sinnvolle Abschnitte, anstatt sie unstrukturiert aufzulisten:
# Acme Docs > Documentation for the Acme API: setup, guides, and the full endpoint reference. ## Getting started - [Quickstart](https://acme.com/docs/quickstart): First request in 5 minutes - [Authentication](https://acme.com/docs/auth): API keys and scopes ## Reference - [Endpoints](https://acme.com/docs/api): Every endpoint and parameter ## Optional - [Changelog](https://acme.com/docs/changelog): Release history
Verlinken Sie die Markdown-Versionen
Viele Dokumentations-Frameworks (Docusaurus, MkDocs, Mintlify, GitBook und andere) können eine Markdown- oder Klartext-Version jeder Seite ausliefern. Verlinken Sie diese — page.md — damit Modelle sauberen Inhalt parsen statt gerendertes HTML mit Navigation und Seitenleisten.
Ergänzen Sie llms-full.txt für vollständigen Kontext
Für größere Dokumentationsbestände sollten Sie eine begleitende llms-full.txt mit dem vollständig eingebetteten Text veröffentlichen, damit ein Agent in einem einzigen Abruf alles aufnehmen kann. Behalten Sie llms.txt als kompakten Index bei.
Kuratieren, dann validieren
Ob Sie die Datei von Hand schreiben oder mit einem Plugin generieren — prüfen Sie das Ergebnis, denn automatische Generatoren neigen dazu, zu viel aufzunehmen. Sehen Sie sich llms.txt-Beispiele für Muster an und validieren Sie anschließend, um die Struktur zu bestätigen und sicherzustellen, dass jeder Link auflösbar ist.