文档问题¶
¥Documentation issues¶
我们的文档超过 80 页，包含有关功能、配置、自定义等诸多方面的详尽信息。如果您发现任何不一致之处或有改进空间，请按照本指南在我们的问题跟踪器上提交问题。
¥Our documentation is composed of more than 80 pages and includes extensive information on features, configurations, customizations, and much more. If you have found an inconsistency or see room for improvement, please follow this guide to submit an issue on our issue tracker.
问题模板¶
¥Issue template¶
报告文档问题通常比报告错误简单，因为我们不需要重现问题。请在创建新的文档问题之前仔细阅读本指南，并在问题中提供以下信息：
¥Reporting a documentation issue is usually less involved than reporting a bug, as we don't need a reproduction. Please thoroughly read this guide before creating a new documentation issue, and provide the following information as part of the issue:
标题¶
¥Title¶
好的标题应该是问题的简短的、一句话的描述，包含所有相关信息，特别是关键字，以简化我们的问题跟踪器中的搜索。
¥A good title should be a short, one-sentence description of the issue, contain all relevant information and, in particular, keywords to simplify the search in our issue tracker.
例子 ¥Example | |
|---|---|
清除 ¥ Clear | 澄清 Windows 上的社交卡设置 ¥Clarify social cards setup on Windows |
不清楚 ¥ Unclear | 文档中缺少信息 ¥Missing information in the docs |
无用 ¥ Useless | 帮助 ¥Help |
描述¶
¥Description¶
请清晰简洁地概述您在文档或文档部分中遇到的不一致或问题，并说明需要改进的地方。请解释您认为文档需要调整的原因，并描述问题的严重性：
¥Provide a clear and concise summary of the inconsistency or issue you encountered in the documentation or the documentation section that needs improvement. Explain why you think the documentation should be adjusted and describe the severity of the issue:
保持简短明了——如果不一致或问题能用一两句话准确解释，那就完美了。维护人员和未来的用户都会感激您阅读的更少内容。
一次解决一个问题– 如果您遇到多个不相关的不一致问题，请为它们创建单独的问题。请勿在同一问题中报告它们 – 这会增加归因难度。
我们为什么需要这样做：清晰简洁地描述问题是改进文档的先决条件——我们需要了解问题所在，这样我们才能修复它。
¥
Why we need this: describing the problem clearly and concisely is a prerequisite for improving our documentation – we need to understand what's wrong, so we can fix it.
相关链接¶
¥Related links¶
在您描述了上述需要调整的文档部分后，我们现在请您分享此特定文档部分以及其他可能相关部分的链接。请确保尽可能使用锚链接（永久链接），因为它可以简化查找过程。
¥Keep it short and concise – if the inconsistency or issue can be precisely explained in one or two sentences, perfect. Maintainers and future users will be grateful for having to read less.
我们为什么需要这个：提供文档链接可以帮助我们了解文档的哪些部分需要调整、扩展或彻底修改。
¥
Why we need this: providing the links to the documentation help us understand which sections of our documentation need to be adjusted, extended, or overhauled.
建议的变更可选¶
¥Proposed change optional¶
既然您已向我们提供了文档部分的描述和链接，您可以通过提出改进建议来帮助我们、维护人员和社区。您可以勾勒出大致的想法，也可以撰写一份具体的提案。此字段为选填项，但非常有用。
¥One issue at a time – if you encounter several unrelated inconsistencies, please create separate issues for them. Don't report them in the same issue – it makes attribution difficult.
我们为什么需要这个：改进建议可以使遇到相同问题的其他用户受益，因为他们在我们维护人员更新文档之前提供解决方案。
¥
Why we need this: an improvement proposal can be beneficial for other users who encounter the same issue, as they offer solutions before we maintainers can update the documentation.
清单¶
¥Checklist¶
感谢您遵循本指南并为我们的文档提供宝贵的反馈意见——您即将完成。这份清单旨在确保您已阅读本指南，并已尽最大努力向我们提供改进指南所需的所有信息。
¥Why we need this: describing the problem clearly and concisely is a prerequisite for improving our documentation – we need to understand what's wrong, so we can fix it.
我们就从这里开始。
¥After you described the documentation section that needs to be adjusted above, we now ask you to share the link to this specific documentation section and other possibly related sections. Make sure to use anchor links (permanent links) where possible, as it simplifies discovery.