改进我们文档的下一步

最近,我们一直在努力改进 meta 上的文档,重点是进行分类,以便不同的用户可以找到与他们相关的主题,并忽略不相关的主题。

我们的目标是让所有文档都归入以下类别之一:

  • #documentation:users - 常用通用用法
  • #documentation:moderators - 社区管理
  • #documentation:theme-developers - 主题和主题组件开发
  • #documentation:admins - Discourse 站点管理
  • #documentation:devs - Discourse 功能、插件和集成开发
  • #documentation:sysadmin - 自托管系统管理

我们计划在本月底移除 #documentation:faq#documentation:tips-and-tricks(但已开始在新的类别中标记一些主题为 #tips-and-tricks)。

我们还希望根据 此前的帖子,使用来自 divio 的以下分类标签来标记文档:

事情并不总是能完美契合。在某些情况下,我们正在拆分主题,在其他情况下,我们只是使用最适合其当前状态的标签或类别。

到目前为止,我们对单个主题进行的一些常见更改(我们现在已完成约 50%)。

  • 将需要控制台访问的内容从 #documentation:admins 移至 #documentation:sysadmin。
  • #documentation:faq 主题拆分为 #documentation:admins 主题和 #documentation:users 主题。
  • 将特定于主题或主题组件开发的主题从 #documentation:devs 移至 #documentation:theme-developers。
  • 更新主题标题以使其更一致
    • 对主题标题使用祈使语气(并从标题中删除“how to”)。
    • 使用正常的句子大写
  • 使用 H2 开始的标题格式化内容
    (相关:我们还为所有文档主题启用了目录)

在某些情况下,我们正在对内容本身进行一些更改,但深入研究不是我们眼下的目标。在将来的迭代中,我们希望做一些事情,例如:

  • 将回复中的内容合并到文档中
  • 删除所有回复
  • 配置主题在 1 或 2 个月后删除回复

然后,我们将提供关于贡献新文档和维护现有文档的更新指南,并更新以下主题:

我们可能希望将更多文档设为 Wiki,或者在文档由非原帖子的用户维护时,为文档寻找新的所有者。


我们还认为,这里可能有一个机会为人们提供一个单独的空间,让他们可以进行更多的“展示和分享”,类似于一些曾经是 #documentation:tips-and-tricks 的内容。在文档之外为这些主题腾出空间,可能会为同行之间的讨论留出更多空间。但与我们现在对文档所做的类似,也许为系统管理员、管理员和开发人员提供单独的空间来进行这些讨论会很有帮助。您怎么看?

14 个赞

文档中对材料的重新分类已按上述计划全部完成。

如果您对目前已完成的工作有任何反馈或疑问,请随时在此处提出。

目前我们还没有计划下一步的具体行动,但正在探索一些想法。

5 个赞