Как устроить поиск внутри сайта разработчика программного обеспечения

Разбираем, как настроить внутренний поиск на сайте софтверной компании: от выбора разделов для индекса до страницы «ничего не найдено». В статье есть условный пример выдачи и проверочный список.

Раздел: Разработка — статьи о сайтах
Обложка статьи: как устроить поиск информации внутри сайта

На сайте разработчика ПО одновременно бывают потенциальный заказчик, действующий пользователь, подрядчик-интегратор и соискатель. Задачи у них разные, а строка поиска одна. Если она ищет только по заголовкам страниц, пользователь не найдёт код ошибки в документации, а покупатель не доберётся до нужного продукта. Ниже — что решить заранее, чтобы поиск работал на эти задачи.

Что на самом деле ищут на сайте софтверной компании

Типичные запросы делятся на несколько групп: название продукта и версия («модуль 4.2»), код или текст ошибки, термин из документации, вопросы про лицензирование и подключение, скачивание дистрибутива, вакансии. Прежде чем выбирать технологию, выпишите 30–50 реальных формулировок: из обращений в поддержку, писем отдела продаж, вопросов на демонстрациях. Если на сайте уже есть статистика внутреннего поиска, добавьте её запросы. Этот список станет тестовым набором, по которому вы потом проверите результат.

Какие разделы включить в индекс и как их разделить

Частая ошибка — искать только по маркетинговым страницам, тогда как документация и база знаний живут на отдельном поддомене или в генераторе документации. Для посетителя это один сайт. В индекс стоит включить:

  • Страницы продуктов и тарифов или условий поставки;
  • Документацию, включая справочник API;
  • Базу знаний и ответы поддержки;
  • Журнал изменений и заметки к релизам;
  • Блог и вакансии.

Выдачу лучше группировать по типу материала, а не смешивать в одну ленту. Устаревшие версии документации нужно либо помечать, либо опускать ниже актуальных.

Как выглядит полезная выдача: условный пример

Посетитель вводит «ошибка 403 api». Ниже схема страницы результатов (пример вымышленный, названия разделов условные):

  • Фильтры слева: продукт, версия, тип материала.
  • Документация · версия 4.2. «Коды ответов API: 403 Forbidden». Фрагмент с подсветкой: «…ответ 403 возникает, если у токена нет права на вызываемый метод…»
  • База знаний. «Токен интеграции получает 403 после обновления».
  • Журнал изменений · 4.1. «Изменена модель прав для токенов».
  • Страницы продуктов: свёрнутый блок, так как запрос не коммерческий.

Что здесь сделано намеренно: у каждого результата видны тип материала и версия, по сниппету понятно, есть ли ответ, а порядок групп зависит от характера запроса. Для «цена» или «купить» первыми стоят страницы продуктов и условия, для кода ошибки — документация.

Версии, синонимы и написание: что настроить в движке

Стандартный поиск часто ломается именно на технических текстах. Проверьте и при необходимости настройте:

  • Номера версий: «4.2», «4_2» и «v4.2» должны находить одно и то же, а не разбиваться на отдельные цифры;
  • Коды ошибок и имена методов API как цельные токены; запрос «getOrders» не должен терять точное совпадение;
  • Синонимы: «выгрузка» и «экспорт», «API» и «апи», «интеграция» и «коннектор»;
  • Раскладку и алфавит: «1С» с кириллической и латинской буквой, «SDK» и «СДК»;
  • Морфологию русского языка: «лицензии», «лицензию», «лицензирование» ведут к одной теме.

Словарь синонимов составляйте по списку реальных запросов, а не по догадкам, и храните его так, чтобы редактор мог дополнить его без разработчика.

Что показывать, когда ничего не найдено

Пустая страница с надписью «Ничего не найдено» — тупик. Добавьте подсказку проверить написание, ссылки на основные разделы документации и форму обращения в поддержку, в которую подставляется текст запроса. Журнал запросов без результатов разбирайте регулярно: по каждому пункту решите, нужен ли синоним, новая статья или более понятный заголовок существующей.

Учтите, что в строку поиска иногда вставляют адреса почты, номера договоров или лицензионные ключи. Решите, что попадает в журнал, и не сохраняйте такие значения без необходимости.

Как выбрать решение и проверить его перед запуском

Встроенный поиск CMS подойдёт при небольшом объёме материалов на одной платформе. Если документация собирается отдельным генератором, нужен общий индекс или внешний сервис, который обходит оба источника. Собственный поисковый движок оправдан при большом объёме и сложных правилах, но требует сопровождения. Спросите подрядчика, как новые страницы попадают в индекс и как быстро удаляются снятые с публикации.

Проверочный список перед приёмкой:

  • Каждый запрос из тестового списка даёт нужный материал в первых результатах;
  • Документация, база знаний и журнал изменений ищутся из одной строки;
  • В выдаче видны тип материала и версия;
  • Коды ошибок и номера версий находятся по точному написанию;
  • Синонимы и разные раскладки обработаны;
  • Есть фильтры по продукту и версии;
  • Страница «ничего не найдено» предлагает следующий шаг;
  • Журнал запросов собирается, а чувствительные данные не хранятся;
  • Поиск удобен на телефоне, а строка доступна с любой страницы.

Поиск не настраивают один раз: после каждого крупного релиза продукта проверяйте тестовый набор запросов заново.

Все статьи блога

Читайте также

Заявка

Расскажите о проекте

Свяжемся в течение рабочего дня, зададим уточняющие вопросы и предложим варианты. Без навязчивых звонков.

Форма обратной связи

Согласия перед отправкой

Отвечаем в рабочие дни с 10:00 до 19:00

Написать в Telegram
Расчёт стоимости

Узнайте стоимость сайта