Добавьте больше подсказок в Discourse, ссылающихся на соответствующую документацию на Meta

Контекст

Команда Discourse в нескольких местах упоминала, что стремится улучшить опыт работы администраторов.

Проблема

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

Функционал

В настройках и меню Discourse могло бы быть гораздо больше ссылок на соответствующую документацию по адресу https://meta.discourse.org/docs.

Например, в установках Discourse есть ссылка на пост в блоге Understanding Discourse Trust Levels.

Но есть множество других материалов, на которые ссылок нет.

Например, есть инструкция по удалению категории:

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

Это может быть просто ссылка, но не обязательно: в каждом случае это может быть кнопка с вопросительным знаком, ведущая к документации, или надпись «Читать далее…» и т. д.

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

(Так называемый принцип «точно в срок»)

Примеры из других программ

В Ghost (программа для ведения блогов с открытым исходным кодом) есть несколько мест, где документация предлагается именно тогда, когда она нужна.

Например, эта кнопка «Узнать больше» ведет на соответствующий документ:

То же самое здесь:

Не был уверен, подходит ли это в раздел #feature или ux, так что переместите, если нужно.

5 лайков

Я немного не согласен с этим. Существует разная глубина контента помощи, который можно создать. Если следовать модели Diátaxis, то это учебные пособия, практические руководства, справочные материалы и объяснения.

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

С остальными тремя категориями я не совсем согласен.

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

Ссылки на внешние справочные материалы — это проклятие, с которым мне приходится сталкиваться ежедневно. У нас есть «справочное руководство», которое рассказывает, что делает каждый ползунок и кнопка, вплоть до:

Кнопка «Отмена»: Закрывает диалоговое окно без применения изменений.
Кнопка «ОК»: Закрывает диалоговое окно, применяя изменения.

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

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

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

или:

Невозможно удалить эту категорию, так как в ней 25852 темы. Самая старая тема…

Поведение хорошее: я понимаю, что не так и каков мой следующий шаг — удалить кучу сообщений и подкатегорий. Это не улучшилось бы, если бы вместо этого была ссылка на практическое руководство «Как удалить категорию».

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

И наконец, объяснения — это то, что представляет собой статья в блоге «Понимание уровней доверия». Когда я впервые с ней столкнулся, она была довольно запутанной: «Неужели случайная статья в блоге шестилетней давности — это лучшее, что у вас есть в качестве документации?» — и она ссылается на статью-справочник, в которой всё перечислено в таблице, что больше соответствовало моим ожиданиям (хотя и не в том порядке, который я ожидал). Объяснения не помогают мне напрямую выполнить задачу, поэтому размещать их там, где должна выполняться задача, не очень эффективно.


Я считаю, что в конечном итоге, хотя документация важна в нескольких местах (например, при вводе в систему или в случаях, когда дизайн не справляется), именно дизайн должен быть главным приоритетом. Чтение или просмотр видео, в котором кто-то объясняет вам работу сайта, редко является желаемым опытом.

5 лайков

Да, как бывший студент по геймдизайну, я полностью согласен с вами. (Кстати, я помню, что вы дизайнер Audacity. Я часто использую Audacity и очень благодарен за него!)

Я также считаю, что весь опыт можно переосмыслить с нуля (начиная с вопроса: «Что бы хотел сделать администратор и как мы можем лучше всего помочь ему в этом?» для всех случаев использования), чтобы процессы не только передавались гораздо лучше, но и сами процессы были максимально простыми.

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

  • переместить все существующие темы в другую категорию, или
  • поместить все существующие темы в категорию «Без категории», или
  • удалить все темы в категории

а затем подтвердить, что вы хотите удалить категорию.

Полагаю, учитывая, что команда Discourse на данном этапе ориентировалась на более постепенные изменения:

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

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

Мне очень нравится это предложение — спасибо, что обратили на это внимание, @bloomexperiment! Мы в настоящее время работаем над улучшением общей структуры и категоризации нашей документации, и я считаю, что подобная функция заслуживает рассмотрения в рамках этого процесса. Я добавлю это в дорожную карту документации как тему для изучения, и мы посмотрим, как лучше всего её реализовать.

2 лайка

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

Пример:

В приведённом примере я бы хотел, чтобы «Расположение резервных копий» было ссылкой на тему на Meta, например: Configure automatic backups for Discourse

Могли бы мы постепенно прийти к состоянию, когда названия каждой из этих настроек сайта будут вести на соответствующую тему на Meta? Я понимаю, что, возможно, вы не хотите прописывать URL-адреса напрямую в код Discourse, но, возможно, это можно было бы реализовать через тексты сайта.

Работа по созданию всех этих ссылок довольно объёмна, но, возможно, было бы возможно организовать коллективные усилия среди нескольких владельцев самохостинговых инсталляций?

3 лайка