llms.txt per i siti di documentazione
Pubblicato:
I siti di documentazione sono il caso d'uso ideale per llms.txt: gli utenti chiedono di continuo agli strumenti di IA "come faccio a fare X con il vostro prodotto", e un file curato indirizza quei modelli direttamente alle pagine giuste.
Perché la documentazione ne trae il massimo beneficio
La tua documentazione è già la risposta. llms.txt ti permette di consegnare a un modello un indice pulito di tutto questo — guida introduttiva, guide, riferimento delle API — invece di lasciare che esplori la navigazione, le interfacce di ricerca e le pagine di marketing.
Generalo a partire dalla tua struttura
La maggior parte dei siti di documentazione dispone già di un sitemap.xml. Raggruppa quegli URL in alcune sezioni sensate invece di elencarli tutti senza criterio:
# 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
Collega le versioni Markdown
Molti framework per la documentazione (Docusaurus, MkDocs, Mintlify, GitBook e altri) sono in grado di servire una versione in Markdown o in testo semplice di ogni pagina. Collega quelle — page.md — così i modelli analizzano contenuti puliti invece dell'HTML renderizzato con navigazione e barre laterali.
Aggiungi llms-full.txt per il contesto completo
Per insiemi di documentazione più ampi, pubblica un file complementare llms-full.txt con il testo completo incorporato, così un agente può acquisire tutto in un'unica richiesta. Mantieni llms.txt come indice conciso.
Cura, poi convalida
Che tu scriva il file a mano o lo generi da un plugin, rivedi il risultato — i generatori automatici tendono a includere troppo. Consulta gli esempi di llms.txt per i pattern, poi convalida per confermare la struttura e che ogni link sia raggiungibile.