在Discourse中增加更多线索,链接到Meta上的相关文档

背景

Discourse 团队在多个地方提到他们正致力于改进管理员体验。

问题

Discourse 中有很多设置和大量的文档。但您不太可能在恰当的时机找到正确的文档。

功能

Discourse 的设置和菜单中可以有更多的地方链接到 https://meta.discourse.org/docs 上的相应文档。

例如,有一个 Discourse 安装中会链接到的博客文章 https://blog.discourse.org/2018/06/understanding-discourse-trust-levels/。

但还有很多没有链接。

例如,有一个关于删除分类的操作指南。

似乎应该将其包含在您可以看到删除分类按钮的模态框中。

它可以是一个链接,但不必只是每个案例的链接——它可以是一个链接到文档的问号按钮,或者可以是“阅读更多……”等。

Discourse 团队可以浏览文档,从主要的文档开始,找出软件中最相关的链接到该文档的位置。

(又名“即时”)

其他软件示例

Ghost(一款开源博客软件)有几个地方在您需要时会链接到其文档。

例如,此“了解更多”按钮链接到相关文档:

同样,这里也是:

不确定这是否属于 FeatureUX,请随意移动。

5 个赞

我不太同意。您可以创建不同范围的帮助内容。如果我们采用 Diátaxis 模型,它包括教程、操作指南、参考资料和解释。

教程可能适合链接到应用程序本身,这样如果您进入一个页面并打算“我想了解它是如何工作的”,即使该页面本身并不容易理解,您也可以学到它。甚至可能有一个教程中心,如果您愿意,可以完成一个关于该软件的课程。

我对其他三个类别有些异议。

如果我转到类别设置页面,可能会有 20 项不同的操作我想做。在那里放置一个操作指南将导致一个我必须搜索的列表——而且因为我期望我寻找的东西不一定有专门的操作指南文章,我可能会在谷歌上输入这个问题,而不是搜索列表。

站外参考资料是我每天都要处理的麻烦。我们有一个“参考手册”,它会告诉你每个滑块和按钮的作用,具体到:

取消按钮:关闭对话框而不应用更改
确定按钮:关闭对话框,应用更改

使用此参考资料意味着您必须滚动浏览大量技术内容才能找到您的部分,而您真正需要的是一个用几个词重新解释选项的工具提示。

如果我尝试删除一个类别,当前的行为几乎是理想的。我看到按钮,通常是灰色的,但带有一个问号,如果我点击它,它会显示:

无法删除此类别,因为它有子类别。

或者:

无法删除此类别,因为它有 25852 个主题。最早的主题是……

这种行为很好,我知道哪里出了问题以及我的下一步是什么——删除大量帖子和子类别。如果不是链接到“删除类别”的操作指南,它不会得到改进。

当然,这仍然是解决真正问题的权宜之计:为什么它不允许我删除包含帖子的类别? 我可以在我的系统上删除带有子文件夹和文件的文件夹,为什么我不能删除带有子类别和帖子的类别?如果它没有这些奇怪的限制,一开始就不需要在应用程序中提供操作指南。

最后是解释——这就是“理解信任级别”博客文章的内容。当我第一次遇到它时,它相当令人困惑——“一个 6 年前的随机博客文章真的是你最好的文档吗?”——它链接到一个参考文章,其中以表格形式列出了所有内容,这更符合我的预期(尽管排序方式不符合我的预期)。解释不能直接帮助我完成一项任务,所以将它们放在一个将要完成任务的地方效果不太好。


我认为,最终,虽然文档在某些地方很重要(例如入职培训,或在设计失败的情况下),但设计本身才是应该关注的重点。阅读或观看某人向您解释网站的视频很少是理想的体验。

5 个赞

是的,作为一名游戏设计专业的学生,我完全同意你的观点。(我记得你是 Audacity 的设计师。顺便说一句,我经常使用 Audacity,非常感谢它!)

我认为整个体验也可以从头开始重新构思(从思考:“管理员想做什么,我们如何才能最好地帮助他们做到这一点?”适用于所有用例),以便更好地传达流程,同时使流程本身尽可能简单明了。

以不允许删除包含帖子的类别为例,软件可以更优雅地处理这种情况。当你尝试删除一个包含帖子的类别时,它首先会建议你是否要:

  • 将所有现有帖子移动到另一个类别,或
  • 将所有现有帖子放入“未分类”,或
  • 删除该类别中的所有帖子

然后再确认你是否要删除该类别。

我猜看到 Discourse 团队在这个阶段倾向于进行渐进式更改:

我一直在呼吁采取更容易实现的目标——在最相关的地方添加指向最受欢迎/最常见/最重要的文档的链接。

(我稍后可能会就我们在这里讨论的关于改进删除类别的体验的反馈/建议另开一个新主题。)

我非常喜欢这个建议——感谢您提出它,@bloomexperiment!我们目前正在努力改进我们文档的总体结构和分类,我认为在这一过程中可以考虑纳入这种功能。我将把它添加到文档路线图中,作为需要探索的内容,看看如何最好地实现它。

2 个赞

抱歉重新提起这个旧话题,并且非常清楚目前围绕管理员搜索和改进整体管理员体验正在进行的工作。在过去几周的许多时候,我一直在想,我多么希望每个站点设置的名称都能链接到 Meta 上相关的文档主题。在过去的几年里,Meta 文档有了巨大的改进,现在已经相当全面、有条理且信息丰富。

示例:

在上面的示例中,我希望“备份位置”链接到 Meta 主题,例如 Configure automatic backups for Discourse

我们能否逐步达到一个阶段,让每个站点设置名称都链接回相关的 Meta 线程?我可以看到您可能不想将 URL 硬编码到 Discourse 代码中,但我想这可能以某种方式存在于站点文本中。

完成所有这些链接的工作量相当大,但也许可以由许多自托管用户进行众包?

3 个赞