Сделать документацию более заметной на форуме?

Я состою на этом форуме уже несколько лет, но никогда не использую Documentation - Discourse Meta, потому что забываю о его существовании.

Однажды я даже подумал: «Было бы здорово, если бы в верхнем меню была ссылка на Документацию…», а затем осознал, что она уже есть:

image

По какой-то причине мой мозг полностью игнорировал её.

Кроме того, ссылка в боковой панели скрыта в конце меню «Ещё», и, как мне кажется (у меня нет данных, подтверждающих эту мысль), очень немногие люди на неё нажимают.

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

image

А как насчёт размещения ссылки рядом с логотипом в шапке? Может быть, две ссылки? Одна для Documentation - Discourse Meta, другая для https://docs.discourse.org?

Также меня беспокоит следующее:

  • Документация (Docs) — это мета-документация.
  • Discourse Docs — это плагин.
  • #docs — это тег, связанный с плагином.
  • Ссылки image и image ведут к Документации.
  • #documentation — это категория, не имеющая прямого отношения к Документации.
  • docs.discourse.org — это документация по API.

Немного запутанно, не так ли?

Тем не менее, главная суть в том, что я всегда забывал о существовании Documentation - Discourse Meta, и поэтому никогда его не использовал. Ближе всего я подхожу к этому, используя поиск с тегом #documentation.

7 лайков

Кстати, в качестве дополнительного бонуса вы также можете использовать фильтр in:docs при поиске. :+1:

4 лайка

Я тоже!

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

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

Не уверен, является ли это проблемой UX или же «коня к воде можно подвести, но заставить его пить нельзя».

1 лайк

Я думаю, что небольшая часть проблемы, которую @chapoi поднимал в прошлом, заключается в том, что это меню на самом деле не предназначено для навигации… это меню фильтров, к которому мы добавили несколько навигационных ссылок (категории и документация).

Screenshot 2023-05-16 at 12.30.08 PM

Скорее всего, было бы логичнее разместить Документацию в разделе «Сообщество» боковой панели вместе с другими ссылками навигации (не в выдвижном меню). Однако это может снизить её заметность, если кто-то не использует боковую панель. Поэтому, если ссылка на Документацию должна быть более очевидной, возможно, стоит выделить её где-то ещё :thinking:

5 лайков

Практически ни один из моих обычных мобильных пользователей не использует боковую панель. Им не кажется, что в ней есть необходимость. И… на самом деле я их понимаю.

3 лайка

Я думаю, что в данном случае подходит принцип «да, и…»

На самом деле документация связана в трёх местах:

  • баннер для новых анонимных пользователей
  • заголовок фильтра вверху
  • боковая панель

Мое предложение: переместить документацию в боковую панель «выше сгиба», чтобы она отображалась под разделом «Темы». Также добавить для неё какой-нибудь символ книги :open_book:.

Кроме того, стоит добавить ссылку на неё в тему New to Discourse? Start here!, которая закреплена, и мы ожидаем, что пользователи прочитают её при входе на Meta.

1 лайк

Я только что добавил Документацию в первую часть меню, в раздел Темы, чтобы посмотреть, как это будет выглядеть. Мне нравится!

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

3 лайка

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

1 лайк