帮助文档

Python 以其编写精良的文档而闻名。保持文档的准确性和高质量需要付出很多努力。像您这样的社区成员帮助编写、编辑和更新内容，这些贡献受到赞赏和欢迎。

此高级帮助文档部分提供

• Python 文档概述

• 如何帮助解决文档问题

• 校对信息

您将在 编写 Python 文档 页面上找到有关如何编写文档和提交更改的详尽信息。

Python 文档

编写 Python 文档 部分介绍了 Python 文档的工作原理的详细信息。其中包括有关所用标记语言、特定格式和样式建议的信息。入门时，查看预先存在的文档源文件会非常有帮助。如何构建文档 将引导您完成创建草稿构建的步骤，这使您能够了解更改的外观并验证新标记是否正确。

您可以在 正在开发中 和 维护 分支中查看从 https://docs.pythonlang.cn/dev/ 构建的文档。正在开发中和最近的维护分支每天重新构建一次。

如果您想更多地参与文档编写，请考虑订阅 Python Discourse 上的文档类别 和 [email protected] 邮件列表，用户可以在其中提出问题并讨论文档工具链、项目和标准。

帮助解决文档问题

如果您查看 问题跟踪器 上的 文档问题，您会发现可能需要解决的各种文档问题。问题从错别字到不明确的文档和缺少文档的项目不等。

如果您看到您想解决的文档问题，您可以

• 检查问题标题右侧是否有拉取请求图标，或在问题正文中的 关联的 PR 下列出打开的拉取请求。如果有，则表示有人已经为该问题创建了拉取请求。

• 在问题上留言，说明您将尝试创建一个拉取请求，以及您认为大约需要多长时间才能完成（如果碰巧忘记或失去兴趣，这将允许其他人解决该问题）。

• 提交 拉取请求 以解决该问题。

通过按照 拉取请求快速指南 中的步骤，您将了解文档拉取请求的工作流程。

校对

虽然在 问题跟踪器 上提交的问题意味着某个地方存在已知问题，但这并不意味着文档中没有其他问题潜伏。校对文档的一部分，例如“操作方法”或特定于操作系统的文档，通常可以发现问题（例如，需要针对 Python 3 更新的文档）。

如果您决定校对，请从头到尾阅读文档的一部分，针对您发现的每种主要问题类型在问题跟踪器中提交问题。简单的错别字不需要单独的问题，而是直接提交拉取请求。最好避免针对包含多个问题的整个部分提交单个问题；相反，提交多个问题，以便更容易为多人分配工作并提高审查效率。

如果您需要有关英语技术写作的更精细方面的帮助，请在任何 @python 存储库中提及 @python/proofreaders 团队。如果您想加入该团队，打开一个类似于 python/core-workflow#461 的 core-workflow 问题。