Файл llms.txt — это текстовый файл в формате Markdown, который обычно располагается в корневом каталоге вашего портала документации (например, https://yourportal.documenterra.net/llms.txt). Он предоставляет ИИ-агентам и большим языковым моделям (LLM) краткий, структурированный обзор содержимого вашего портала и ссылки на его наиболее важные страницы.
Относитесь к нему как к файлу robots.txt для ИИ-инструментов — с той разницей, что вместо ограничения доступа он активно направляет ИИ-агентов к вашему лучшему контенту.
Функционал llms.txt является частью аддона ИИ-инструменты.
Почему это важно
Без llms.txt ИИ-ассистенту, обращающемуся к вашей документации, приходится угадывать, какие страницы являются авторитетными. Он может выдавать устаревшие страницы, игнорировать ключевые разделы или вообще не понимать структуру вашего контента. Грамотно составленный файл llms.txt дает ИИ-инструментам надежную отправную точку.
Это особенно актуально для технической документации, справочников по API и баз знаний — именно того контента, к которому разработчики обращаются через ИИ-ассистентов для написания кода, таких как GitHub Copilot, Cursor или Claude.
| llms.txt — это скорее формирующаяся общепринятая практика, чем утвержденный стандарт. Поддержка со стороны ИИ-провайдеров все еще развивается, поэтому практический эффект может быть разным. Тем не менее, это простое в реализации дополнение, которое улучшит вашу документацию по мере развития ИИ-инструментов. |
Как использовать llms.txt
Наиболее практичный способ использования llms.txt — передать его URL-адрес напрямую в LLM вместо ссылки на домашнюю страницу вашего портала. Это дает модели мгновенный структурированный обзор вашей документации — что она содержит и где найти ключевой контент, — не требуя от нее сканирования или угадывания структуры сайта.
Например, задавая ИИ-ассистенту вопрос о вашем продукте, начните диалог так:
Вот обзор документации по этому продукту: https://yourportal.documenterra.net/llms.txt. [Ваш вопрос]
Это работает, поскольку llms.txt задуман как компактный, человекочитаемый индекс — именно тот контекст, с которым LLM может работать сразу же.
| Некоторые инструменты на базе ИИ могут автоматически извлекать llms.txt при получении URL-адреса сайта. Однако такое поведение не является универсальным. Для большинства LLM и чат-интерфейсов вам потребуется указывать URL-адрес llms.txt явно. Пока автоматическая поддержка не станет стандартом, отношение к llms.txt как к передаваемому вручную файлу контекста является наиболее надежным подходом. |
Настройка llms.txt
Чтобы настроить llms.txt для вашего портала, перейдите в Настройки → ИИ интеграции → llms.txt.
В поле Содержимое llms.txt вы вручную прописываете содержимое файла, а Документерра будет отдавать его по адресу https://yourportal.documenterra.net/llms.txt.
| В отличие от robots.txt, файл llms.txt не содержит директив и не управляет сканированием (краулингом). Он носит исключительно информационный характер — это составленный вами индекс, который помогает ИИ-агентам ориентироваться в вашем контенте. |
Поле заполнено образцом по умолчанию, чтобы помочь вам начать работу. Если вы удалили образец, но хотите посмотреть его для справки, вы можете найти его на этой странице немного ниже.
Формат файла
Файл llms.txt использует Markdown. Спецификация рекомендует следующую структуру:
- Заголовок H1 — название вашего проекта или портала. Это единственный обязательный элемент.
- Цитата (blockquote) — краткое описание содержимого портала. Ограничьтесь 2–3 предложениями.
- Необязательные разделы — обычные абзацы или списки Markdown с дополнительным контекстом о вашем контенте.
-
Разделы H2 со ссылками — сгруппированные ссылки на наиболее важные страницы. Каждая ссылка может включать краткое описание после двоеточия.
Пример файла llms.txt
Markdown |
⚠️⚠️⚠️ Контент ниже - пример структуры llms.txt, замените его на свой собственный: # Мой Портал Документации > Мой Портал Документации — официальный портал документации для Продукта. Здесь собраны руководства пользователя, справочники по API, примечания к выпускам и обучающие материалы, которые помогут пользователям и разработчикам эффективно работать с Продуктом. ## Начало работы - [Обзор](https://library.documenterra.nethttps://library.documenterra.net/articles/project-id/overview.md): Введение в Продукт и основные концепции - [Быстрый старт](https://library.documenterra.net/articles/project-id/quick-start.md): Пошаговые инструкции для новых пользователей - [Установка и настройка](https://library.documenterra.net/articles/project-id/installation.md): Системные требования и инструкции по установке - [Часто задаваемые вопросы](https://library.documenterra.net/articles/project-id/faq.md): Ответы на наиболее распространённые вопросы ## Руководство пользователя - [Основные возможности](https://library.documenterra.net/articles/project-id/user-guide.md): Подробная документация по основной функциональности - [Конфигурация](https://library.documenterra.net/articles/project-id/configuration.md): Настройки, параметры и варианты кастомизации - [Интеграции](https://library.documenterra.net/articles/project-id/integrations.md): Подключение Продукта к сторонним инструментам - [Устранение неполадок](https://library.documenterra.net/articles/project-id/troubleshooting.md): Известные проблемы и способы их решения ## Справочник по API - [Обзор API](https://library.documenterra.net/articles/project-id/api-overview.md): Аутентификация, базовые URL и соглашения об использовании - [Эндпоинты](https://library.documenterra.net/articles/project-id/api-endpoints.md): Полный список доступных эндпоинтов API - [Примеры кода](https://library.documenterra.net/articles/project-id/api-examples.md): Примеры запросов и ответов ## Примечания к выпускам - [Что нового](https://library.documenterra.net/articles/project-id/whats-new.md): Последние обновления и новые функции - [История изменений](https://library.documenterra.net/articles/project-id/changelog.md): Полная история версий ## Optional - [Глоссарий](https://library.documenterra.net/articles/project-id/glossary.md): Определения терминов, специфичных для продукта - [Видеоуроки](https://library.documenterra.net/articles/project-id/tutorials.md): Скринкасты и пошаговые разборы |
Советы по написанию
- Будьте избирательны. Давайте ссылки только на самые важные страницы вашего портала вместо того, чтобы включать абсолютно все. ИИ-агенты работают в рамках ограниченного контекстного окна, поэтому более короткий и тщательно отобранный список помогает им лучше выделять наиболее подходящий контент.
- Используйте информативные названия ссылок. Краткое описание после двоеточия помогает агентам понять назначение страницы без ее загрузки.
- Используйте URL-адреса страниц в формате Markdown. Давайте ссылки непосредственно на .md-версию каждой страницы (см. Получение страниц в формате Markdown), чтобы агенты могли читать чистый контент, переходя по ссылкам.
- Организуйте по разделам. Группируйте ссылки под заголовками H2, которые отражают структуру вашей документации (например, Введение, Справочник API, Руководства).
- Поддерживайте актуальность. Редактируйте файл при добавлении новых разделов или удалении старых.
- Отмечайте необязательный контент. Используйте раздел ## Optional в конце файла для дополнительных страниц (списки изменений, устаревший контент и т.д.). Некоторые ИИ-инструменты пропускают необязательные разделы при ограниченном контексте.