Skip to content

报告文档问题

在过去的七年中,我们的文档已经增长到超过 60 页。由于文档规模较大,可能会出现不一致性。如果您发现不一致性,或者认为有需要澄清或改进的地方,请按照以下指南将问题提交到我们的公共问题跟踪器

问题模板

报告文档问题通常比报告错误问题更简单,因为我们不需要一个复现。在创建新的文档问题之前,请仔细阅读以下指南,并提供以下信息作为问题的一部分:

标题

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

示例
清晰 澄清 Windows 上的社交卡设置
不清楚 文档中缺少信息
泛泛 请帮助

描述

提供对您在文档中遇到的不一致性或问题的简明扼要摘要,或需要改进的文档部分。解释为什么您认为文档应该进行调整,并描述问题的严重程度:

  • 保持简短和简洁 – 如果不一致性或问题可以在一两个句子中准确解释,那就太好了。维护者和未来的用户会感谢您少读一些。

  • 一次一个问题 – 如果您遇到几个不相关的不一致性,请为它们创建单独的问题。请不要在同一个问题中报告它们,这样会导致归因困难。

为什么我们需要这个:为了我们能够理解问题,我们需要对问题进行清晰的描述,并量化其影响,这对于问题的分类和优先级很重要。

相关链接

在上面描述需要进行调整的文档部分后,我们现在要求您分享该特定文档部分的链接以及其他可能相关的部分的链接。尽可能使用锚链接(永久链接),因为这样可以简化查找。

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

建议的更改 可选

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

为什么我们需要这个:改进建议对于遇到相同问题的其他用户可能会有益处,因为它们在我们维护者更新文档之前提供了解决方案。

清单

感谢您遵循指南并创建了高质量和完整的问题报告 - 您几乎完成了。这一部分确保您已经阅读了本指南,并尽力提供了我们需要改进文档的所有信息。

接下来,我们将接手处理。