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 文档翻译 | PEPs (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
最后修改: 2025-02-01 07:28:42 GMT