Современные ИИ-ассистенты — такие как ChatGPT, Claude, Gemini и другие — все чаще извлекают и обобщают контент из интернета в режиме реального времени. Чтобы эти инструменты работали максимально точно, ваш портал документации должен предоставлять контент в таком виде, чтобы ИИ-агенты могли эффективно его находить и считывать.
Что делает портал документации удобным для ИИ:
- Использование llms.txt — специально подготовленный, человекочитаемый индексный файл, который указывает ИИ-агентам, какие страницы вашего портала являются наиболее авторитетными и релевантными. Он следует конвенции llms.txt, предложенной сообществом исследователей ИИ, и является аналогом файлов robots.txt и sitemap.xml для традиционных поисковых систем. Узнайте, как настроить llms.txt для вашего портала Документерры.
- Машиночитаемые форматы — предоставление документации в формате Markdown или через API (JSON) вместо PDF-файлов или сложной HTML-разметки, которые боты не всегда могут правильно распознать. В Документерре каждую страницу на вашем портале можно получить в виде чистого Markdown. Это позволяет ИИ-агентам и инструментам на базе LLM читать отдельные страницы без необходимости парсить HTML.
- MCP-сервер — сервер на основе Model Context Protocol (MCP), который позволяет ИИ-ассистентам для разработки и ИИ-агентам программно обращаться к вашей документации.
- Семантическая разметка — строгая иерархия заголовков (H1 → H2 → H3), которая помогает моделям правильно разбивать текст на фрагменты для анализа.
- Оптимальный размер страниц — старайтесь делать отдельные страницы не слишком короткими, но и не слишком длинными. В очень коротких страницах не хватает контекста, необходимого ИИ для точных ответов на вопросы; очень длинные страницы могут превысить размер контекстного окна инструментов на базе LLM или привести к «размытию» нужной информации. Это полностью соответствует принципам постраничного создания документации: каждая страница должна быть самодостаточной и фокусироваться на одной концепции — что является одинаково хорошим подходом как для читателей-людей, так и для ИИ-агентов.
- Отсутствие "скрытого" контекста — ИИ не умеет угадывать. Термины должны быть четко определены в глоссарии, а примеры кода должны содержать все необходимые данные для немедленного запуска.
Эти советы в совокупности помогают гарантировать, что ваша документация будет корректно использоваться в ответах, сгенерированных ИИ, инструментах для разработчиков и агентных рабочих процессах.