PEP 732 – Python 文档编辑委员会
- 作者:
- Joanna Jablonski
- 赞助人:
- Mariatta Wijaya
- 讨论邮件列表:
- Discourse 帖子
- 状态:
- 活跃
- 类型:
- 流程
- 主题:
- 治理
- 创建日期:
- 2023年10月14日
- 更新历史:
- 2023年10月20日
- 决议:
- Discourse 消息
摘要
本 PEP
- 建立 Python 文档编辑委员会
- 提出编辑委员会的工作方式
动机
指导委员会于 2021 年 3 月批准成立一个 文档工作组 来为文档设定方向。该小组现在被称为编辑委员会，以将其与后来创建的专注于更战术性工作的文档工作组区分开来。
Python 文档的目的是服务于 Python 的现在和未来的最终用户。因此，核心开发社区和更广泛的 Python 文档贡献者共同努力实现这一目标。
规范
授权
编辑委员会将
- 确保流程到位，以维护和提高 Python 文档的质量
- 将 Python 文档培养成一个社区资源，以服务于当前和未来的用户
- 根据 Python 软件基金会使命 行动，该使命是促进 Python 编程语言的发展，并支持和促进多元化和国际化的 Python 程序员社区的成长
- 确保文档贡献易于访问、包容且可持续
- 为文档内容建立适当的决策流程
- 在做出决策之前寻求达成贡献者之间的共识
- 成为文档内容决策的最终仲裁者
职责
该委员会有权对 Python 的文档做出决策，如下所述。例如，它可以
- 设定 Python 文档的大方向战略
- 设定文档的预期结构
- 对写作和设计做出风格和编辑决策
- 处理文档治理（例如，将决策权委托给主题专家、解决分歧、做出决策）。
范围
编辑委员会监督以下内容和策略
| 在范围内 | 不在范围内 |
|---|---|
| CPython 文档 (docs.python.org) | CPython 代码库中的代码注释 |
| CPython 开发指南 (devguide.python.org) | CPython 文档字符串 |
| CPython 文档的翻译 | PEP (peps.python.org) |
| PyPA 文档 | |
| www.python.org | |
| Python Wiki (wiki.python.org) |
组成
Python 文档编辑委员会由五名成员组成。
编辑委员会成员
最初的编辑委员会成员是
- Mariatta Wijaya
- Ned Batchelder
- Joanna Jablonski
- Guido van Rossum
- Carol Willing
编辑委员会成员资格
编辑委员会成员应具备
- 对 Python 项目理念有良好的理解
- 具有 Python 教育和面向开发人员的文档背景
- 具有建设性和乐于助人的良好记录
- 对 Python 做出重大贡献的历史
- 愿意投入时间改进 Python 的文档
编辑委员会成员应具有教育、沟通、技术写作、Python 文档、可访问性、翻译或社区管理方面的经验。
任期
编辑委员会成员任期不限，但通常预计每年都会发生编辑委员会成员的变化。编辑委员会成员将每年确认他们是否希望继续担任委员会成员。成员可以随时辞职。
如果一位委员会成员失去联系，并且一个月或更长时间无法联系到，那么其余的委员会成员可以投票替换他/她。
编辑委员会规模的变更
每年在每个主要 Python 版本发布后，编辑委员会将审查委员会规模是否应发生变化。如果文档社区的需求随着时间的推移而改变，这将提供灵活性。需要简单多数才能做出增加委员会规模的决定，其中法定人数为当前委员会的 80%。
作为文档编辑委员会的赞助组织，指导委员会可以随时更改委员会成员人数，包括任命新成员或解聘现有成员。
空缺
如果由于任何原因委员会存在空缺，文档编辑委员会将公开宣布征集潜在的委员会成员。潜在的委员会成员将提交一份简短的文件，说明他们的资格和服务动机。现任编辑委员会成员将以简单多数投票选出新委员会成员，其中法定人数为当前委员会的 80%。
修订
本 PEP 作为文档编辑委员会的章程。对其运作方式的更改可以通过新的 PEP 或对本 PEP 的更改来进行。无论哪种情况，更改都将在社区讨论后由指导委员会决定。
PEP 接受
PEP 732 于 2023 年 12 月 11 日 获得 Python 指导委员会批准。
指导委员会评论说，虽然他们并不反对 PEP 中提出的范围界定，但一旦委员会充分建立起来并且优先事项得到解决，编辑委员会可能会考虑将范围扩展到包括标准库中的文档字符串，这可能是有意义的。
联系方式
要请求编辑委员会做出决定，社区成员可以在 python/editorial-board 存储库中打开一个问题。
版权
本文档放置在公共领域或根据 CC0-1.0-Universal 许可证，以较宽松者为准。
来源: https://github.com/python/peps/blob/main/peps/pep-0732.rst
上次修改时间: 2024-02-28 06:14:55 GMT