文件问题¶

我们的文档由80多页组成，包括广泛的 有关功能、配置、自定义等的信息。如果你 发现不一致或有改进空间，请按照以下步骤操作 在我们的[问题跟踪器]上提交问题的指南。

问题模板¶

报告文档问题通常比报告错误少， 因为我们不需要复制品。请仔细阅读本指南 创建新的文档问题，并提供以下信息 问题的一部分：

• Title
• Description
• Related links
• Proposed change optional
• Checklist

名称¶

一个好的标题应该是一个简短的、一句话的问题描述，包含 所有相关信息，特别是关键字，以简化搜索 我们的问题跟踪器。

描述¶

为您的不一致或问题提供清晰简洁的总结 在需要的文档或文档部分中遇到 改进。解释为什么你认为文件应该调整 描述问题的严重性：

• 保持简短明了 – 如果不一致或问题可以 用一两句话精确解释，完美。维护人员和未来 用户会感激不得不少读书。

• 一次一个问题 – 如果你遇到几个不相关的不一致， 请为他们创建单独的问题。不要在同一问题中报告它们 这使得归因变得困难。

为什么我们需要这个: 清晰简洁地描述问题是 改进文档的先决条件——我们需要了解什么是 错了，所以我们可以修复它。

相关链接¶

在您描述了上面需要调整的文档部分之后， 我们现在要求您分享此特定文档部分的链接，以及 其他可能相关的部分。确保使用锚链接（永久链接） 在可能的情况下，因为它简化了发现。

为什么我们需要这个: 提供文档链接有助于我们 了解我们文档的哪些部分需要调整、扩展， 或彻底检修。

拟议变更 optional¶

既然您已经向我们提供了描述和链接 文档部分，您可以通过以下方式帮助我们、维护人员和社区 提出改进建议。你可以草拟出粗略的想法，也可以写一个具体的想法 建议。此字段是可选的，但非常有用。

为什么我们需要这个: 改进建议可能对其他人有益 遇到同样问题的用户，因为他们在我们之前提供了解决方案 维护人员可以更新文档。

清单¶

感谢您遵循指南并为我们的 文档——你几乎完成了。检查表确保您已阅读 本指南，并尽您所能为我们提供每一件作品 我们需要改进的信息。

我们从这里开始。