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

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

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

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

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

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

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

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

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

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

或者:

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

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

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

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


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

5 个赞