文档问题¶

我们的文档由超过80页组成，包含有关功能、配置、自定义等的广泛信息。如果您发现了不一致之处或认为有改进的空间，请按照本指南在我们的问题跟踪器上提交问题。

问题模板¶

报告文档问题通常比报告错误要简单，因为我们不需要重现。请在创建新的文档问题之前仔细阅读本指南，并在问题中提供以下信息：

• 标题
• 描述
• 相关链接
• 建议更改 可选
• 检查清单

标题¶

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

描述¶

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

• 保持简短和简洁 – 如果不一致或问题可以用一两句话精确解释，那就完美。维护者和未来的用户会感激您减少阅读量。

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

我们为什么需要这个: 清晰简洁地描述问题是改善我们文档的前提 – 我们需要了解哪里出错，以便进行修复。

相关链接¶

在您描述了需要调整的文档部分后，我们现在要求您分享该特定文档部分的链接以及其他可能相关的部分。请确保尽可能使用锚链接（永久链接），因为这简化了发现过程。

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

建议更改 可选¶

现在您已经为我们提供了描述和文档部分的链接，您可以通过提出改进建议来帮助我们、维护者和社区。您可以勾勒出粗略的想法或写出具体的提案。此字段是可选的，但非常有帮助。

我们为什么需要这个: 改进提案可以为遇到相同问题的其他用户提供帮助，因为它们在我们维护者更新文档之前提供了解决方案。

检查清单¶

感谢您遵循指南并为我们的文档提供有价值的反馈 – 您快完成了。检查清单确保您已阅读本指南，并尽您所能提供我们改善所需的每一条信息。

接下来由我们来处理。