Документация: советы и приемы по использованию поиска

Сначала немного общей мета-информации :wink:

На моём форуме я использовал довольно много категорий. В основном потому, что на других сайтах у меня была такая же структура, и все делают так же. Но, как известно всем (или должно быть известно), огромное количество категорий, множество подкатегорий и ещё больше под-подкатегорий практически невозможно эффективно управлять. И самое главное: категории не помогают пользователю найти релевантный контент.

Ничего нового, на самом деле. Это одна из причин, почему Discourse поддерживает только двухуровневую структуру категорий и так часто рекомендует использовать теги.

Однако многие выступают против тегов. Я считаю, что это связано с широким злоупотреблением тегами на других платформах: их смешивают с ключевыми словами (частично теги и ключевые слова — одно и то же), а также с злоупотреблением хештегами в Instagram и подобных сервисах. Кроме того, распространённое мнение гласит, что из-за этого опыта обычные пользователи не знают, как правильно использовать теги.

Они могут. Для них, с точки зрения того, что они видят на экране, теги — это то же самое, что и категории, но дают лучшие результаты (ЕСЛИ администраторы используют их правильно).

Но теги работают лучше всего вместе с поиском. И это тоже проблема. Поскольку теги широко используются неправильно, то же самое происходит и с поиском — потому что он просто не работает. Пользователи научились не использовать поиск, так как он выдаёт слишком много результатов. Это бесконечная борьба между навыками пользователей: должны ли показываться все результаты поиска или можно использовать какой-то алгоритм предположений, как это делает Google.

Это проблема, которую должны решить разработчики. Но это уже другая история.

В любом случае. Моя аудитория — обычные люди, совсем не технически подкованные. Им трудно начать использовать редактор Discourse, и они не могли менять тему. Конечно, сейчас они могут, в основном, но для этого требовалось довольно много инструкций.

Однако они быстро адаптировались к отсутствию категорий и сразу начали использовать теги. Для них это было действительно интуитивным действием. Или, как сказали несколько пользователей: «Нажатие на теги похоже на поиск, но лучше». Всё, что мне нужно было сделать на уровне инструкций, — это просто сказать им нажать на теги, посмотреть, что произойдёт, и объяснить, куда ведёт пункт Tags в меню «гамбургер».

Вернёмся к делу

У Discourse один из лучших поисковых движков в бесплатном сегменте интернета. Конечно, он не идеален, но значительно превосходит встроенный поиск WordPress и других CMS (если вы не знаете плагин для поиска WordPress под названием Relevantti, вам стоит его проверить; он довольно хорош).

Сейчас я обучаю своих пользователей, как улучшать результаты поиска. На самом деле это оказалось гораздо проще, чем я ожидал, — и эти пользователи почти нигде не используют поиск (я их не виню, потому что поиск часто работает ужасно).

Но теперь мне не хватает некоторых ссылок. Я знаю, что в поисковых запросах Discourse можно использовать множество приёмов, но эти фрагменты и кусочки знаний разбросаны по многим сообщениям и темам.

Я понимаю — написание документации и сборник советов и приёмов требуют больше работы, чем само программирование. Я уже написал довольно много документации. Просто написать один документ недостаточно; нужно как минимум три разных документа в зависимости от потребностей и уровня навыков пользователей. Кроме того, кто-то должен постоянно обновлять их.

Вот почему я полностью понимаю, что не смог найти исчерпывающее руководство по освоению поиска в Discourse :wink: (или я просто… не умею искать).

Что я прошу у сообщества:

  • простой список параметров поиска (или с параметров; иногда я так ненавижу английский) или просто примеры/ссылки
  • обучайте своих пользователей использованию поиска, большинство из них просто не умеют
  • откажитесь от категорий и начните использовать теги (хотя для этого нужно некоторое планирование, чтобы сделать всё правильно)
6 лайков

Полностью согласен. Существует два отличных плагина, которые также могут улучшить пользовательский опыт (UX) при поиске:

  • Сохранённые поисковые запросы
  • Документация

Однако, да, создание руководств по форуму — это обязательное условие, чтобы помочь пользователям лучше ориентироваться на форуме и улучшить их опыт. Именно здесь плагин «Документация» может стать настоящим активом. Также существует компонент темы, который можно использовать вместе с этим плагином.

1 лайк

@hugh / @JammyDodger, нужно ли что-то подобное в теме документации?

3 лайка

Вот ссылка: Searching for content effectively

4 лайка

Круто, я всё интегрировал (используя claude-3.5-sonnet). Редактура мне нравится, но, пожалуйста, проверь, если есть время.

4 лайка

Я удалил большинство из них, потому что:

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

Я оставил варианты сортировки, так как они не отображаются в поле ввода поиска, поэтому без выпадающего списка ими сложнее пользоваться.

1 лайк

Я думаю, лучше изменить область применения… это правило кажется очень произвольным. Может, просто вычеркнуть из него «Эта тема призвана перечислить другие фильтры, недоступные в форме расширенного поиска»?

@JammyDodger, что ты думаешь?

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

Например:

tracking search больше не найдет этот документ, что жаль.

3 лайка