Season of Docs 是由 Google 開放原始碼計畫辦公室管理的永續發展計畫。Season of Docs 的目標如下:
- 為開放原始碼專案提供支援,透過文件解決專案問題
- 為技術作家提供開放原始碼相關經驗
- 提高對開放原始碼、說明文件和技術寫作的認識
- 在開放原始碼說明文件中收集並分享有效指標的相關資訊
如要進一步瞭解 Season of Docs,請前往該計畫的網站。
2022 年計畫總覽
Season of Docs 的運作方式
在 Season of Docs 中,機構會提交專案提案來申請參加。專案提案包括:
- 機構資訊
- 專案面臨的問題
- 專案如何使用文件解決問題
- 專案如何評估文件成效 (指標)
- 工作時間表
- 專案預算
- 任何其他資訊,例如機構在類似計畫中的經驗,或有助於 Season of Docs 管理員瞭解專案和問題的資訊
獲准加入計畫後,機構就能直接招募及聘用自己的技術作家。Season of Docs 會透過 Open Collective 為機構提供資金,機構則透過 Open Collective 支付技術寫手費用。專案預算和付款資訊公開透明,預算會列在 Season of Docs 網站上提供的機構專案提案中,付款資訊則會顯示在 Season of Docs Open Collective 帳戶中。
機構提交個案研究報告後,即視為順利完成計畫。此外,機構也必須在計畫期間完成每月評估,並在計畫結束後的一年內,完成三份每季追蹤問卷調查。
2022 年精選內容
「新文件發布後,Casbin 和 Casdoor 的每日造訪次數幾乎增加一倍,跳出率則下降約 30%。」- Casbin
「這個專案的成果令人欣喜,我們看到 [技術作家] 在社群中成長,並擔任領導職務。這兩位貢獻者現在負責主持工作組和社群會議,並協助設計及維護我們的專案。」—moja-global
「[GSoD] 協助我們招募到兩位才華洋溢的技術作家,這在一般情況下非常困難。他們持續為 OpenMined 貢獻開放原始碼,我們與他們合作的體驗也很棒。」—OpenMined
「此外,新版手冊對計算質譜法新手來說也更容易上手。為說明這一點,CZI 補助金也為歷來處於弱勢的個人提供津貼,而部分獲獎者已使用新的 OpenMS 手冊,快速展開為期六週的實習,並對新手冊給予正面評價。」—OpenMS
2022 年摘要資料
2022 年,Season of Docs 計畫從 67 份申請中接受了 31 個專案,其中 30 個專案順利完成計畫。在 31 個獲准的機構中,有 17 個機構是重複申請者。
31 個獲選專案聘用了 58 位技術寫作者。超過 190 位技術作家在 Season of Docs GitHub 存放區中新增聯絡資訊和作品集連結,表示有意參與這項計畫。
2022 年計畫:
- 100% 的機構對申請程序感到滿意
- 100% 的機構對計畫網站文件/內容的體驗良好
- 93% 的機構對這項計畫的體驗良好
- 90% 的機構認為文件專案成功
關於機構
參與 2022 年 Season of Docs 的機構代表了各種開放原始碼專案。2022 年的學員包括:
- 開發工具,例如 AsyncAPI 和 SpyderIDE
- 程式設計語言和架構,例如 Julia、LFortran、R 和 p5.js
- 科學專案,例如 CERN-HSF 和 SymPy
- 使用者應用程式,例如 Mautic、Open Food Facts、Talawa 和 Ushahidi
- 硬體和機器人專案,例如 ExpressLRS 和 Open-RMF
- 資料專案,例如 GeomScale、GeomStats、OpenMined 和 Weaviate
- 雲端和基礎架構專案,例如 cert-manager、NimbleEdge 和 Cilium

我們並未收集任何專案中繼資料 (例如成立日期、貢獻者地理分布、貢獻者人數或使用者人數)。
我們確實要求專案指出使用的開放原始碼授權。

關於文件專案
文件問題
在 2022 年計畫中,機構希望透過文件解決的主要問題包括:

請注意,機構可能會回報多個文件問題。如要瞭解詳情,請參閱 2022 年 Season of Docs 結果頁面,其中連結了各機構的原始專案提案和完整個案研究。
建立的記錄文件類型
在 2022 年的個案研究中,最常提及的說明文件類型是 How-to 說明文件。

個案研究中提及的其他文件類型包括:
- 快速入門導覽課程
- 詞彙解釋
- 常見問題
- 知識庫
- 元件
- 網誌/社群媒體內容
- 維護人員指南
其中有些類別的界線較模糊,單一文件專案可能包含多種文件類型或功能。
如要瞭解詳情,請參閱 2022 年 Season of Docs 結果頁面,其中連結了各機構的原始專案提案和完整個案研究。
預算
平均預算要求為 $11,679 美元,中位數為 $12,150 美元。有五個機構申請並獲得最高補助金額 ($15,000 美元),三個機構申請最低補助金額 (介於 $5,000 美元至 $7,000 美元之間)。
指標
個案研究中列出的專案,以及他們用來評估文件專案成效的指標。
建議的頂尖指標包括:

其他建議的指標包括:
- 更多說明文件提取要求/貢獻
- 在說明文件頁面提供更直接的意見回饋
- 網頁停留時間
- 提出的問題 (做為使用情況的替代指標)
- 論壇參與者
- 合作夥伴/志工/整合數量
- 降低跳出率
- 提高社群知名度。
由於完成技術寫作專案和提交個案研究之間的時間很短,2022 年的大部分學員在提交個案研究時,都無法收集足夠的資料來判斷是否達到初始指標。
我們會在 2023 年收到後續問卷調查的回覆後,更新這份報表,加入哪些專案已達到或修訂指標的相關資訊。
如要瞭解詳情,請參閱 2022 年 Season of Docs 結果頁面,其中連結了各機構的原始專案提案和完整個案研究。
與技術文件撰寫人員合作
在 Season of Docs 計畫中,專案應直接招募、面試、聘用及支付技術寫手薪資。技術文件撰寫人員可以在我們的 GitHub 存放區中,將自己新增至由 Season of Docs 維護的目錄,但 Season of Docs 工作人員不會審查或推薦技術文件撰寫人員。
為開放原始碼專案聘請技術作家時的最佳做法
我們請各專案分享招募、聘用和與技術作家合作的最佳做法。主要建議包括:
招募
- 減少面試人數,並使用現場模擬面試,而非僅審查履歷
- 重視書面和口頭溝通能力,而非專案語言或工具的熟練程度
- 直接詢問技術作家會如何取得專案所需的領域知識
- 如果有人對專案的使命充滿熱忱,並認同開放原始碼的核心價值,就更有可能在整個專案期間保持動力
- 歡迎全球各地的申請人,因為多元的觀點和背景有助於專案發展,但請注意,如果作家和導師位於太多時區,可能需要付出許多額外心力才能維持良好溝通
徵才資訊
- 使用合約清楚列出交付項目、付款時間表和具體時間承諾
- 如果專案有許多未知因素,請納入探索或研究里程碑,與文件建立作業分開
協調與溝通
- 記錄會議決策,方便專案團隊成員瞭解背景資訊和後續步驟
- 清楚說明預期的溝通方式和頻率,例如每週通話、每天傳送電子郵件,或在即時通訊頻道中更新狀態
- 積極回應,並提供清楚的回饋,說明「原因」而不只是「內容」
- 讓技術作家與廣大社群交流,瞭解脈絡並分享作品
程序和工具
- 建立文件程序,讓整個社群都能參與,並在 Season of Docs 計畫結束後繼續運作
- 文件審查所需時間至少與程式碼審查一樣長,且同樣需要投入大量心力,請務必預留足夠時間
為求明確,部分建議已編輯和精簡。
與 2021 年的計畫相同,2022 年 Season of Docs 的大多數技術寫手,都是直接向合作機構提出申請。

與技術作家合作時的常見問題

在 2022 年的計畫中,回報與技術文件撰寫專員合作時發生問題的專案較少。技術作家無法完成計畫是最大的問題,原因包括生病、擔任全職工作或無法配合時間。
某個專案回報,他們的說明文件專案依附於 Google Summer of Code 的工作,而這些依附元件難以管理。另一個專案也遇到困難,因為技術作家需要記錄的硬體遭該作家所在國家/地區的國防部沒收,無法進口。
後續問卷調查
我們將在 2023 年 5 月、8 月和 11 月,向 2022 年的參與者發送三份後續問卷調查。收到結果後,我們會更新這個部分。
後續問題
與以往一樣,我們越瞭解開放原始碼中的說明文件,就越想深入學習!
我們希望在未來的賽季中:
- 收集更多專案中繼資料,找出專案年齡、社群規模或語言與文件需求之間的關聯性
- 分析文件專案,看看是否能歸納出可共用的範本
- 為開放原始碼專案中的技術作家面試制定評分標準
雖然我們有很多想探究的問題,但我們也希望尊重參與 Season of Docs 的開放原始碼專案管理員和維護人員的時間。這項計畫的首要目標是協助專案解決文件相關問題。