本指南提供了编写有效的 Discourse 操作指南的说明。它涵盖了结构、风格、受众考量以及维护等关键要素。
所需用户等级：任何人都可以编写新的操作指南
编写有效的操作指南对于帮助用户、版主、管理员和系统管理员在 Discourse 中执行各种任务至关重要。本指南将帮助您为社区制作清晰且有价值的操作指南。
摘要
在本文档中，您将了解：
- 为什么编写操作指南很重要
- 应包含哪些信息
- 结构和风格的指导原则
- 在哪里发布这些主题
- 发布后如何维护
为什么要编写操作指南？
您是否曾需要执行某项任务却想不起如何操作？编写操作指南文档是在 Discourse 中记录流程的绝佳方式。如果您在某个流程上遇到困难，很可能其他人也有同样的问题。将其记录下来对每个人都有帮助。
在 Divio 的这篇指南 中了解更多关于操作指南与其他文档类型（如教程或参考指南）的区别。
编写或审核操作指南是开始向社区贡献 Discourse 知识的好方法。 如需了解其他贡献方式，请查看 如何为 Discourse 做贡献 指南。
应包含哪些信息？
操作指南应是一份分步指南，引导用户达成特定结果。例如，标题为“为 Discourse 设置 HTTPS"的操作指南应提供设置 HTTPS 的说明。
编写操作指南时请记住以下要点：
- 紧扣主题，表述清晰
- 避免不必要的信息
- 简洁但信息丰富
- 解释为什么达成该结果有益
考虑您的受众
Discourse 操作指南有不同的受众群体，每个群体需要不同深度的解释。请使用文档类别作为指南，确定您的目标受众：
- Documentation > Using Discourse
- Documentation > Site Management
- Documentation > Integrations
- Documentation > Hosted Customers
- Documentation > Self-Hosting
- Documentation > Migrating to Discourse
- Documentation > Developer Guides
- Documentation > Contributing
了解受众的技术技能水平，并相应调整您的指南。以下是一些建议：
- 避免包含受众无法执行的步骤（例如，托管客户通常无法访问控制台命令）
- 保持说明清晰，对非技术用户避免使用过于技术性的语言
- 不要添加受众应该已经知道的背景信息
结构和风格
文档风格指南涵盖了您所需了解的所有关于如何构建和美化操作指南（以及所有其他 Discourse 文档）的内容：
发布指南
请将指南发布在父级 Documentation 类别的子类别中，并打上 how-to 标签。所有指南都需要 Discourse 团队的批准，这将通过自动化的审核流程处理。风格指南详细介绍了每个类别，以帮助您决定指南应发布的位置。
维护您的指南
发布操作指南后，请保持其更新。以下是您可以协助维护的方法：
- 关注回复 —— 将社区反馈整合到指南中。
- 亲自测试指南 —— 定期查阅指南，确保其仍然准确。
- 编辑缺失或错误的信息 —— 如果您处于信任等级 2 或以上，请编辑操作指南的第一篇帖子。
- 标记帖子以寻求帮助 —— 如果您无法进行编辑，请使用“其他事项”标记该帖子，并说明所需内容。
在大多数情况下，官方操作指南会在一个月后删除评论，以保持对指南本身的关注。
感谢您为改善 Discourse 社区文档做出的贡献！如果您遇到困难，请随时寻求帮助。最好的开始方式是一边贡献一边学习。