llms.txt для сайтів документації
Опубліковано:
Сайти документації — це ідеальний сценарій використання llms.txt: люди постійно запитують AI-інструменти «як зробити X у вашому продукті», і ретельно дібраний файл спрямовує ці моделі прямо до потрібних сторінок.
Чому документація отримує найбільшу користь
Ваша документація вже є відповідями. llms.txt дозволяє передати моделі чистий покажчик до них — початок роботи, посібники, довідник API — замість того, щоб вона сканувала навігацію, інтерфейси пошуку та маркетингові сторінки.
Згенеруйте його зі своєї структури
Більшість сайтів документації вже мають sitemap.xml. Згрупуйте ці URL у кілька логічних розділів замість того, щоб вивалювати їх суцільним списком:
# 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
Додавайте посилання на Markdown-версії
Багато фреймворків для документації (Docusaurus, MkDocs, Mintlify, GitBook та інші) можуть віддавати Markdown- або звичайну текстову версію кожної сторінки. Посилайтеся на них — page.md — щоб моделі розбирали чистий вміст, а не відрендерений HTML з навігацією та бічними панелями.
Додайте llms-full.txt для повного контексту
Для більших наборів документації опублікуйте супутній файл llms-full.txt із вбудованим повним текстом, щоб агент міг отримати все за один запит. Зберігайте llms.txt як стислий покажчик.
Спершу дібрати, потім перевірити
Незалежно від того, чи ви пишете файл вручну, чи генеруєте його за допомогою плагіна, перегляньте результат — автогенератори схильні включати забагато. Перегляньте приклади llms.txt для зразків, а потім перевірте, щоб підтвердити структуру й те, що кожне посилання відкривається.