PEP 732 – Python 文件編輯委員會
- 作者:
- Joanna Jablonski
- 贊助人:
- Mariatta Wijaya
- 討論於:
- Discourse 討論串
- 狀態:
- 作用中
- 類型:
- 流程
- 主題:
- 治理
- 建立日期:
- 2023年10月14日
- 公告歷史:
- 2023年10月20日
- 決議:
- Discourse 訊息
摘要
本 PEP
- 設立 Python 文件編輯委員會
- 提案說明編輯委員會運作方式
動機
指導委員會（Steering Council）於 2021 年 3 月批准成立了文件工作小組 (Documentation Working Group)，旨在為文件制定方針。該小組現更名為「編輯委員會」，以與後來為處理具體戰術性工作而成立的文件工作小組做出區隔。
Python 文件的宗旨是服務 Python 當前與未來的最終使用者。因此，核心開發社群與廣大的 Python 文件貢獻者將共同努力達成此目標。
規範
授權範圍
編輯委員會將
- 確保有相關流程以維護並提升 Python 文件的品質
- 培育 Python 文件作為服務當前與未來使用者的社群資源
- 遵循Python 軟體基金會的使命，即推廣 Python 程式語言，並支持與促進多元且國際化的 Python 程式設計師社群之成長
- 確保文件貢獻過程具備易用性、包容性與永續性
- 為文件內容建立適當的決策流程
- 在做出決策前，致力於達成貢獻者之間的共識
- 作為文件內容決策的最終仲裁者
職責
委員會擁有對 Python 文件相關事務的決策權，範圍如下。例如，它可以：
- 制定 Python 文件的大局戰略
- 設定文件的預期架構
- 對寫作與設計做出風格與編輯方面的決策
- 處理文件治理事務（例如：委託專業領域專家決策、解決分歧、做出決策等）
範圍
編輯委員會負責監督下列內容與戰略：
| 適用範圍 | 不適用範圍 |
|---|---|
| CPython 文件 (docs.python.org) | CPython 程式碼庫中的註解 |
| CPython 開發指南 (devguide.python.org) | CPython 文件字串 (docstrings) |
| 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 中設定的範圍，但一旦委員會運作順暢且較高優先級的事務處理完畢，編輯委員會考慮將標準函式庫中的文件字串（docstrings）納入適用範圍是合理的。
聯絡方式
若社群成員欲請求編輯委員會做出決策，可於 python/editorial-board 儲存庫開啟議題 (issue)。
版權
本文件已進入公有領域或遵循 CC0-1.0-Universal 授權，以較寬鬆者為準。
來源： https://github.com/python/peps/blob/main/peps/pep-0732.rst
最後修改時間： 2025-02-01 07:28:42 GMT