So validieren Sie eine llms.txt-Datei vor der Veröffentlichung
Ein kaputtes llms.txt ist schlimmer als kein llms.txt. Wenn die Datei fehlerhaft ist, erhalten die Tools und Modelle, die sie lesen, ein verwirrendes oder unvollständiges Bild Ihrer Website, das Gegenteil von dem, was Sie wollten. Die gute Nachricht: Das llms.txt-Format ist einfach, sodass die Validierung schnell erfolgt, sobald Sie wissen, was überprüft werden muss.
Dies ist eine praktische, unkomplizierte Checkliste, die Sie vor jeder Veröffentlichung durchführen können.
Was das Format tatsächlich erfordert
Das llms.txt-Format (von llmstxt.org) ist absichtlich minimaler Markdown:
- Ein einzelner H1-Titel, der das Projekt benennt, die erste Zeile der Datei.
- Ein optionales, aber empfohlenes zusammenfassendes Blockzitat (
> …) direkt nach dem Titel. - Keine oder mehr H2-Abschnitte (
## Docs,## API, …), die jeweils eine Liste von Links enthalten. - Jeder Link ist ein Listenelement:
- [Name](https://example.com/page): short description.
Das ist die ganze Struktur. Die meisten Validierungsprobleme sind Abweichungen von dieser Form.
Die Checkliste vor der Veröffentlichung
1. Genau ein H1, und es ist das erste
Die Datei sollte mit einer # Title-Zeile geöffnet werden. Häufige Fehler:
- Überhaupt kein H1 (die Datei beginnt mit Prosa oder einer Liste).
- Mehrere H1s (verwenden Sie stattdessen
##für Abschnitte). - Das H1 ist unter anderen Inhalten vergraben.
2. Ein zusammenfassendes Blockzitat
Fügen Sie direkt nach dem Titel ein einzeiliges >-Blockzitat ein, das beschreibt, um welche Site oder welches Projekt es sich handelt. Es bietet jedem Leser, ob Modell oder Mensch, sofortigen Kontext. In der Spezifikation ist dies optional, in der Praxis wird es jedoch empfohlen.
3. Abschnitte, die Ihre Links gruppieren
Verwenden Sie ##-Überschriften, um verwandte Links zu gruppieren: ## Documentation, ## API Reference, ## Guides. Ein flacher Dump von Links ohne Abschnitte ist schwer zu navigieren. Wenn Sie mehr als eine Handvoll Links haben, gruppieren Sie diese.
4. Wohlgeformte Links
Überprüfen Sie jeden Link auf:
- Leere URLs,
[Docs]()mit nichts in den Klammern. - Fehlender Linktext,
[](https://…)ohne Beschriftung. - Falsch formatierte URLs, Tippfehler, fehlendes
https://, verirrte Zeichen. - Doppelte Links, Wenn dieselbe URL mehr als einmal erscheint, verschwendet sie Speicherplatz und weist auf einen Fehler beim Kopieren und Einfügen hin.
5. Beschreibungen zu jedem Link
Ein bloßes - [Quickstart](https://…) ist weitaus weniger nützlich als - [Quickstart](https://…): Get set up in five minutes. Die Beschreibung sagt einem Modell, warum der Link wichtig ist und wann ihm folgen soll. Fügen Sie zu jedem Listenelement-Link einen hinzu.
6. Halten Sie es prägnant
llms.txt ist ein Index, kein Archiv. Wenn Ihre Datei sehr groß ist (mehrere zehn Kilobyte oder mehr), ist das ein Zeichen dafür, dass Sie den gesamten Inhalt dort unterbringen, wo eine kuratierte Linkliste hingehört.
7. Betrachten Sie eine begleitende llms-full.txt
Wenn Sie wirklich viele lange Inhaltsmodelle vollständig benötigen, veröffentlichen Sie ein separates llms-full.txt mit dem vollständigen Text und behalten Sie llms.txt als kompakte Karte bei, die darauf verweist.
Ein kurzes Beispiel einer sauberen Datei
# Acme Docs
> Acme is an API for sending transactional email. This file indexes the docs and reference.
## Getting Started
- [Quickstart](https://acme.dev/quickstart): Send your first email in five minutes
- [Authentication](https://acme.dev/auth): API keys and scopes
## API Reference
- [Messages API](https://acme.dev/api/messages): Create and send messages
- [Webhooks](https://acme.dev/api/webhooks): Delivery and bounce events
## Optional
- [Changelog](https://acme.dev/changelog): Release notes
Ein H1, eine Zusammenfassung, gruppierte Abschnitte, beschriebene Links, keine Duplikate. Das ist das Ziel.## Automatisch validieren
Das manuelle Ausführen der Checkliste funktioniert, aber es ist leicht, eine doppelte URL oder eine fehlende Beschreibung in einer langen Datei zu übersehen. Unser kostenloser llms.txt-Validator prüft alle oben genannten Punkte in einem Durchgang und gibt Ihnen einen Strukturwert sowie spezifische, zeilenbezogene Vorschläge.
Sie können die Validierung auf zwei Arten durchführen:
- Fügen Sie Ihren Inhalt direkt in den Validator ein, oder
- Geben Sie eine URL ein, verweisen Sie sie auf Ihre Website (wir rufen
/llms.txtautomatisch ab) oder verlinken Sie direkt auf die Datei. Dies ist praktisch, um eine Datei zu überprüfen, die bereits aktiv ist.
So oder so sehen Sie genau, was Sie vor oder nach der Veröffentlichung beheben müssen.
Nachdem Sie die Probleme behoben haben
Sobald der Prüfer zufrieden ist:
- Speichern Sie die Datei als
llms.txtund laden Sie sie in Ihr Domain-Stammverzeichnis (https://example.com/llms.txt) hoch. - Führen Sie den Validator erneut für die Live-URL aus, um zu bestätigen, dass sie als Klartext bereitgestellt wird und erreichbar ist.
- Überprüfen Sie es erneut, wenn Sie Ihre Website umstrukturieren oder größere Abschnitte hinzufügen.
Das Endergebnis
Die Validierung dauert ein paar Minuten und erspart Ihnen den Versand einer Datei, die die Tools, die sie lesen, stillschweigend in die Irre führt. Führen Sie die Checkliste aus, korrigieren Sie die Struktur und bestätigen Sie mit dem Validator, bevor Sie veröffentlichen.
Sie haben noch keine Datei? Generieren Sie mit dem llms.txt-Generator einen sauberen Entwurf Ihrer Website und validieren Sie ihn anschließend. Und wenn Sie sich immer noch nicht sicher sind, ob Sie überhaupt eines benötigen, lesen Sie When llms.txt Makes Sense.