Come creare un file llms.txt
Pubblicato:
Scrivere un file llms.txt richiede circa dieci minuti. Questa guida illustra ogni parte, in ordine, e si conclude con un file che puoi copiare e adattare.
1. Inizia con il titolo H1
La prima riga deve essere un singolo H1: il nome del tuo progetto o sito. È l'unico elemento strettamente obbligatorio del formato.
# Acme Docs
2. Aggiungi un riepilogo come blockquote
Subito sotto il titolo, aggiungi un blockquote di una o due frasi. È il contesto che un modello linguistico legge per primo, quindi rendilo specifico: cos'è il sito e a chi è rivolto.
> Acme is a payments API. This file links to the docs an LLM needs to integrate and debug Acme.
3. (Facoltativo) Aggiungi qualche riga di testo
Prima di qualsiasi intestazione di sezione puoi aggiungere semplici paragrafi con un orientamento aggiuntivo. Non usare intestazioni qui: limitati a una o due frasi.
4. Raggruppa i link sotto sezioni H2
Ogni sezione è un'intestazione H2 seguita da un elenco markdown. Ogni voce è un link con una descrizione facoltativa dopo i due punti.
## Docs - [Quickstart](https://acme.com/docs/quickstart): Integrate in five minutes - [API reference](https://acme.com/docs/api): Every endpoint and parameter ## Examples - [Sample app](https://acme.com/examples/app): A working end-to-end example
Usa URL https assoluti e mantieni le descrizioni focalizzate su ciò di cui uno sviluppatore o un modello ha bisogno, non su testo promozionale.
5. Usa la sezione "Optional" per gli elementi non essenziali
Una sezione chiamata letteralmente ## Optional ha un significato speciale: i suoi link possono essere ignorati quando è necessario un contesto più breve. Inserisci qui changelog, articoli del blog e riferimenti secondari.
6. Ospitalo nella root
Pubblica il file all'indirizzo https://yourdomain.com/llms.txt con Content-Type: text/plain. I siti di grandi dimensioni spesso pubblicano anche un file llms-full.txt con tutto il contenuto espanso.
7. Validalo prima di pubblicarlo
Incolla il tuo dominio nel validatore. Controlla la struttura, conferma che ogni link si risolva effettivamente ed elenca esattamente cosa correggere. Punta a 100/100.