Более эффективный способ управления индексами для категорий документов?

На мой взгляд, это шаг назад по сравнению с оригинальным плагином Docs.

1 лайк

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

1 лайк

Но при тысячах документов и частом добавлении новых это превращается в очень трудоемкую ручную работу.

2 лайка

Согласен, не уверен, что справился бы с документацией в 1000 страниц через Discourse. Хотя, возможно, я бы всё же попробовал, даже несмотря на то, что есть более специализированные решения для документации. 1000 страниц без Git — это тоже больно :stuck_out_tongue:

Почему бы и нет? Это отлично работает с оригинальными Документами. Например, у нас есть темы в категории «Библиотека», которые содержат один или несколько PDF-файлов или других вложений в дополнение к тексту поста. Каждая тема также помечена соответствующими тегами, поэтому поиск с помощью фильтрации по поиску и тегам очень прост.

Возможно, это зависит от конкретного случая использования. Возможно, вы привыкаете к этому, если начинаете использовать Discourse для документации на раннем этапе, но в моей области (техническая/пользовательская документация) мне всё равно требовалось бы ручное индексирование.

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

Однако с точки зрения пользователя, который не знаком с вашим продуктом или только начинает разбираться в теме, он может не знать, что именно искать. В таком случае структурирование имеет большой смысл (по моему опыту), иначе пользователи теряются в лабиринте документации. Вы можете проверить это сами: представьте 5–10 случайных документов с различными тегами, которые, как вы ожидаете, прочитают ваши пользователи. Затем попробуйте найти их, просто кликая по вашему сайту. Если вам самим будет трудно их найти, вы сможете представить, каков будет пользовательский опыт.

2 лайка

Поиск становится простым благодаря фильтрам. Допустим, вам нужны инструкции по установке двигателя для самолёта Glastar. Вы точно не знаете, что искать, но концепции легко найти и отфильтровать:

В старой системе документации всё, что я добавлял в категорию «Библиотека», автоматически попадало в документацию. Не нужно вручную поддерживать отдельный индекс, что и вызывает у меня возражения.

1 лайк

Я согласен, что текущий дизайн не идеален.

Нам требовалась гибкость, и мы пошли на компромисс в дизайне ради её достижения. Это основная причина, по которой мы считаем Discourse Doc Categories всё ещё #экспериментальным.

Мы намерены в будущем спроектировать и создать здесь что-то лучшее, но в настоящее время это не является приоритетом.

5 лайков

Я думаю, что проблема в том, что оригинальный плагин, который многие сайты приняли и широко внедрили, теперь помечен как end-of-life, хотя не предлагает практичного перехода к новому.

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

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

7 лайков

Я полностью согласен со Стивеном.

Интересно, почему это было реализовано как совершенно новый плагин, а не как эволюция оригинала. Революции в программном обеспечении могут быть мощными, но они наиболее эффективны, когда проводятся быстро и решительно.

3 лайка

На самом деле я не использую плагин Docs для управления документацией — мне нужен лишь простой интерфейс для фильтрации тем по нескольким категориям и нескольким тегам одновременно, всё на одной странице.

Интерфейс Discourse по умолчанию требует перехода к Расширенному поиску, который слишком скрыт и включает множество ненужных мне фильтров (например, по автору или дате). Мне нужен более сфокусированный и прямой опыт работы.

Старый плагин Docs позволяет мне реализовать фильтрацию по нескольким категориям и тегам, но у него есть одно ограничение:
При выборе родительской категории показываются только темы, находящиеся непосредственно внутри неё — темы из её подкатегорий не включаются.
В то же время стандартный просмотр категории отображает темы как родительской категории, так и её подкатегорий.

Именно поэтому я всё ещё использую этот плагин, хотя он и не идеален.
Вот моя предыдущая просьба, связанная с этим: Multi menu select Group tags

Ещё раз большое спасибо всем, кто нашёл время обсудить эту тему и помочь её доработать — ваша поддержка и советы очень ценны.

2 лайка