Разработчики ищут по документации полузабытые имена методов, строки ошибок и вопросы. Поиск по документации должен справляться со всеми тремя: сопоставить «getColections» с getCollections, не пускать ответы для v2 в результаты v3 и ответить на «как ротировать ключ?» абзацем, где об этом сказано, — со ссылкой в подтверждение.
Создайте задачу загрузки из sitemap, списка URL или файлов Markdown и HTML. Перезапускайте её из CI при каждом деплое документации.
Храните их как фасетные поля, чтобы строка поиска по умолчанию работала в версии читателя, а остальные предлагала как фильтры.
Привяжите ассистента к той же коллекции. На вопросы приходит короткий ответ с пронумерованными источниками; поиск по ключевым словам остаётся мгновенным.
Поиск по идентификаторам — функция, флаг, код ошибки — требует точного и префиксного совпадения с терпимостью к опечаткам, и его нельзя «понимать» как что-то другое. Тематические запросы — «повтор вебхуков» — требуют разумного ранжирования руководств над шумом changelog. Вопросам нужен поиск плюс обоснованный ответ. Один индекс обслуживает все три: поиск по ключевым словам и гибридный — для первых двух, ассистент — для третьего.
Руководства, справочник API и changelog ранжируются по-разному и обновляются в разном ритме, поэтому лучше всего работают как отдельные коллекции с общим поиском. Один запрос multi_search возвращает их секциями одного выпадающего списка — «Руководства», «API», «Changelog» — за одно обращение.
Аналитика пустых выдач подскажет, чего не хватает вашей документации: каждый запрос, который ничего не нашёл, — это страница, которую кто-то ожидал увидеть.
Префиксный поиск, терпимость к опечаткам и настраиваемые разделители токенов сохраняют находимость имён в camelCase, путей через точку и флагов.
Фильтр по версии и продукту удерживает результаты в контексте читателя; фасеты позволяют из него выйти.
Ассистент отвечает только по вашей документации и возвращает использованные фрагменты, так что каждое утверждение ведёт на страницу.
MCP-сервер даёт Claude, Cursor и другим агентам тот же поиск по вашей документации, что и людям.
{
"searches": [
{ "collection": "docs_guides", "q": "rotate api key", "query_by": "title,headings,body",
"filter_by": "version:=v3", "per_page": 5 },
{ "collection": "docs_api", "q": "rotate api key", "query_by": "operation,summary",
"filter_by": "version:=v3", "per_page": 3 }
]
}
// -> one response, two sections: Guides, API referenceУзнать больше
Лучший способ оценить поисковую платформу — не читать ещё одну сравнительную таблицу.
И только после этого принимайте решение.