重组文档以提高清晰度

:white_check_mark: 更新(2024 年 6 月 4 日): 文档主题重构的初步工作已完成,新分类现已上线,并附有新的索引以展示其中的内容。您可以在此处查看:Documentation - Discourse Meta - 如果您发现任何内容有误,请在下方发帖告知!

在对当前文档结构进行全面审查后,我们很高兴地宣布,我们正在改进文档的分类方式,使主题更加有条理,并专注于社区旨在实现的目标。我们的目标是提高文档的清晰度和可用性,使每个人都能更轻松地找到所需的信息。

预期变化

:label: 新分类

今后,我们的文档将根据其描述的操作或功能进行分类和标记。基于用户角色的现有分组将不再使用,我们将更新所有文档主题,以指明执行所述活动所需的用户角色。

:eyes: 临时视觉变化

在此重构期间,您可能会发现我们文档的某些部分看起来有些格格不入或杂乱无章。别担心!这只是暂时的,因为我们正在努力完善新结构。

:white_check_mark: 全面更新

重构完成后,我们的下一步将是更新所有文档主题,以符合新的通用风格指南。我们还将纠正可能存在的任何不准确之处。这将是一个持续进行的项目,大部分工作将在未来几周内完成。

如何提供帮助

您的反馈对我们来说一如既往地宝贵。如果您遇到任何问题,或者对我们如何进一步改进文档有任何建议,请随时在 Contribute > Site feedback 频道中分享您的想法,或在本主题下发帖。

感谢您在我们进行这些更改时的耐心与配合!

14 个赞

关于审核的主题,例如 https://meta.discourse.org/t/discourse-moderation-guide/63116,属于 #documentation:site-management。也许应该将其添加到描述中,因为作为审核员,我不会查看“网站所有者和管理员”类别中的主题。

3 个赞

我对关于文本进行了一些小的调整,以表明它对版主也有用。

@JammyDodger 和/或 @hugh 稍后看到时也可能有其他想法。

2 个赞

我对其进行了额外的调整:

4 个赞

感谢您指出这一点,@Moin

@JammyDodger 您的更新在我看来不错。

文档主题重构的初步工作已完成,新类别现已上线,并附有显示其中内容的索引。

您可以在此处查看:Documentation - Discourse Meta - 如果您发现任何不正确之处,请在下方发帖!

1 个赞

您是否计划为文档插件添加新类别?

1 个赞

我们正在犹豫是否要尝试移除文档插件。:slight_smile: 目前,我已经将新类别添加进去了。:+1:

3 个赞

一个帖子已合并到现有主题:使用新的侧边栏改进文档导航

侧边栏中子类别下主题链接的文本是如何创建的?人工智能?

1 个赞

每个子类别都有一个索引主题,例如:Using Discourse Index (这些链接自每个子类别标题的描述中)。

侧边栏会从那里获取缩短的标题,而不是使用完整的文章标题。

3 个赞