A help button could be useful either way
AI-generated summary
The discussion revolves around whether Discourse should include a dedicated help button in the composer interface. While some users, like awesomerobot and sam, argue for its value—especially for new users or those unfamiliar with Markdown—others, including codinghorror, note that such buttons historically see low usage, citing Stack Overflow’s experience. cpradio points out that a plugin already exists to add such a button, though it’s not widely adopted and could be improved with modern UI outlets. Several users, including featheredtoast and jidanni, emphasize the need for clear, centralized documentation of Discourse’s custom Markdown features (like [details]), which are not well-documented in common resources. mforbes shares frustration over the difficulty of discovering and using Discobot, the built-in tutorial bot, and argues that a visible help button would guide users to authoritative documentation. pfaffman and others note that even experienced users often overlook help features, but Don suggests integrating help into existing new-user guides. The consensus leans toward the help button being useful for onboarding, though implementation may be better handled via plugins or improved documentation rather than core UI, given usability concerns and low engagement with similar features historically. mforbes concludes that while Discobot exists, its discoverability and usability are poor, reinforcing the case for a more intuitive help mechanism.
We had this button on Stack Overflow and the analytics / data showed that almost nobody used it. That does not mean it should not exist, of course, but the general rule is that the type of people you would want to use this button, pretty much never do.
Stack Overflow seems way more aggressive these days for brand new users and audience for Discourse is way wider so this kind of approach may be applicable
I think there is definite value in giving some extra tips for tl0/tl1 that are getting accustomed and also for more advanced users that are looking for secret magic.
I guess what I want a little is a help mode that goes away after a bit
To be fair, there is a plugin that sort of permits this already and I don’t think a lot of people use it…
https://github.com/cpradio/discourse-plugin-composer-help-button
Granted, it isn’t right aligned, but it gives people a way to add customize help for the format bar should they deem that a necessity.
Also, this was written before the new outlet (that Canned Replies uses) to display help text at. So it could be improved to use that same location instead of a modal now (if someone has the time PR welcome).
Right-aligning the button might require a new outlet or a new option to the toolbar component (PR welcome for that too).
But those would be the only necessary improvements to make it meet the UI mock ups above.
None of that is new; I worked with Ben to add that in 2010/2011. See proof here…
Yeah it fealt eerily familiar. I guess I think there is merit for a help mode that kicks out once you posted a bit
But sure this can be plugin territory, agree that for seasoned users a help button is largely noise
For what it’s worth, I appreciate the comfort of being able to find some kind of formatting help, even if it’s rarely used.
It’s good for bootstrapping new users unfamiliar with markdown (like communities coming from more bb related forms, or with wysiwyg editors), and a nice reminder for when I just can’t figure out how how to do something simple like code formatting, and have been deep in JIRA or Sharepoint or something with vastly different formatting options.
Кросс-постинг более недавнего запроса на аналогичную тему — Hard to find the Markdown help button
Мое мнение по этому поводу:
Неопытные пользователи не всегда знают, как использовать возможности Markdown.
Справка по Markdown помогла бы новичкам быстрее освоить этот язык. Другие пользователи уже публиковали материалы по этой теме. Я считаю, что такая функция была бы полезна, так как упростила бы доступ к информации.
В качестве альтернативы можно добавить больше кнопок Markdown в верхней панели для новичков. Однако проблема в том, что это может усложнить интерфейс и сделать его менее понятным.
Я думаю, что было бы отличной идеей добавить этот раздел (панель инструментов) и на страницу New User Tips, как и упомянул выше Джефф в этом обсуждении. ![]()
С небольшим описанием и настраиваемой ссылкой внутри. Она может вести на отдельную тему о форматировании, например Understanding Discourse for new users
Или же напрямую на справку по Markdown Markdown Reference
Пользователи видят:
Введите текст здесь. Используйте Markdown, BBCode или HTML для форматирования.
Хорошо, они используют Markdown, BBCode или HTML, но обнаруживают, что некоторые функции не работают, а другие, которые используют другие пользователи, работают, но о них они не знали.
Существуют разные версии Markdown, BBCode или HTML.
Поэтому в разделе «Справка» Discourse должно быть указано, какие версии используются.
Или вместо этого просто предоставить полный список элементов разметки, которые использует Discourse.
Или хотя бы дать ссылку на то, где в исходном коде это реализовано.
Но обычные пользователи не смогут понять этот исходный код,
Поэтому всё равно лучше иметь полный список или, как его ещё называют, шпаргалку по операторам разметки, реализованным в Discourse.
Итак, где документирован синтаксис [details=summary][/details]?
- Он не упоминается ни на одной из страниц, указанных выше, поскольку это собственная функция Discourse.
- Поиск по “[details]” на meta показывает, что эта функция существует и может описываться как «скрыть», но не даёт никаких подсказок о том, как работает синтаксис summary.
- Поиск в интернете выявляет репозиторий discourse-details, но теперь он содержит только информацию: «Плагин устарел, теперь включён в Discourse по умолчанию».
- Я наконец нашёл это в Details in topic styling changes - Feedback. Не то место, куда я бы направил пользователей, чтобы они изучили синтаксис.
Мне очень хотелось бы видеть кнопку помощи со ссылкой на какую-либо официальную документацию…
Это часть обучающего пособия discobot
Если вы нажмёте на шестерёнку, система предложит вставить её за вас.
Так что люди, которые не нажмут на шестерёнку, вероятно, не нажмут и на значок помощи. ![]()
Существует ли учебник по discobot? Я использую и продвигаю Discourse уже много лет, но ни разу не сталкивался с этим, ни с идеей, что именно здесь нужно учиться пользоваться Discourse. Даже сейчас, глядя на наш экземпляр Discourse, я не представляю, как запустить это.
Я подумал, что, возможно, что-то упускаю, или, может быть, discobot появился после того, как я начал использовать Discourse, поэтому я перешел по ссылке Understanding Discourse for new users. Там нет ни упоминания об учебнике по discobot, ни о теге [details]. Указана ссылка Markdown Tutorial - Introduction, но только для CommonMark.
@pfaffman Теперь я вижу эту опцию под шестеренкой. Дело не в том, что я бы не нажал на шестеренку, а в том, что я думал, будто знаю, что она означает — изменить настройки. (Я ошибался.) В сочетании с предположением, что, вероятно, существует множество специфичных для Discourse функций, подобных [details], я убедил себя, что они не могут быть все перечислены в каком-то скрытом меню, поэтому начал искать руководство.
Я определенно нажал бы на кнопку помощи, если бы одна из кнопок явно предназначалась для помощи (например, вопросительный знак). Я также нажал бы на кнопку, если бы она явно предназначалась для вставки элементов. Я просто подсознательно убедил себя, что это не может быть шестеренка…
Возможно, я придерживаюсь старых подходов, но мне действительно нужен авторитетный источник, где я мог бы изучить все функции и на который мог бы ссылаться в будущем. Существует ли что-то подобное, или обучение через ботов — это новая тенденция?
Создайте новую учётную запись на сайте Discourse.
Никакого другого источника, кроме как следить за объявлениями здесь, нет. Здесь, в документации, прилагаются дополнительные усилия для документирования информации: Documentation - Discourse Meta, но не уверен, что это ощущается как авторитетный источник.
Спасибо. То есть, если я создам новую учётную запись, я действительно увижу discobot. Однако для пользователя, который присоединился до запуска discobot, взаимодействие с ним вызывает сильную путаницу. Возможно, это немного не по теме, но это подчёркивает потенциальную необходимость в кнопке «Помощь», поэтому я продолжу обсуждение здесь. Пожалуйста, не стесняйтесь переместить эту тему или направить меня к более подходящей, если считаете это уместным.
После того как я недавно обнаружил discobot, я попытался использовать его на наших сайтах. Судя по различным обсуждениям и упоминаниям, я ожидал, что смогу где-то ввести @discobot start tutorial и получить обучение…
- Я попробовал это в чате сайта на одном из сайтов. Ничего не произошло. Я также попытался начать личный чат с @discobot, но он не был найден.
- Затем я попытался отправить «Личное сообщение» discobot, но это тоже не удалось.
- На одном из наших сайтов я смог добавить discobot в свой список личных чатов, но команда «start tutorial» ничего не сделала.
- Наконец, я создал новую учётную запись на этом сайте и был встречен ботом, который дал понять, что должна существовать тема с моим взаимодействием с ботом (и что мне следует добавить эту тему в закладки).
Теперь я вижу, что могу найти discobot на нашем сайте, перейти на его страницу пользователя, а затем отправить ему сообщение, где, к моему удивлению, нужно ввести длинный заголовок и какой-то текст. Только после создания этого сообщения я могу попросить его «start tutorial».
Почему это так сложно? Почему бот не реагирует на запросы начать обучение в чатах или личных сообщениях? Что делать, если новый пользователь на сайте пропустит настройки уведомлений и не заметит discobot? Как он сможет получить помощь позже?
Я не знаю, какое решение будет лучшим, но кнопка «Помощь», которая провела бы меня через этот процесс, была бы крайне полезна.
Вы отключили Discobot в настройках? Вы используете очень старую версию Discourse?



