目前階段:
已發布個案研究。請參閱時間表。
文件季是由 Google 開放原始碼計畫辦公室管理的永續發展計畫。Season of Docs 的目標如下:
- 為開放原始碼專案提供支援,以便透過說明文件解決專案問題
- 讓技術作家有機會累積開放原始碼相關經驗
- 提高開放原始碼、說明文件和技術寫作相關知識的知名度
- 在開放原始碼說明文件中收集及分享有效指標相關資訊
如要進一步瞭解「影像故事季」計畫,請造訪網站。
2022 年計畫簡介
Season of Docs 的運作方式
在「Google 文件季」中,機構組織可以提交專案提案來申請。專案提案內容包括:
- 機構組織資訊
- 說明專案面臨的問題
- 說明文件如何協助解決問題
- 專案如何評估文件成效 (指標)
- 工作時間表
- 專案預算
- 任何其他資訊,例如機構在類似計畫中的經驗,或任何有助於 Docs 季節管理員瞭解專案和問題的資訊
機構加入計畫後,即可直接招募及聘用技術作家。文件季節會透過 Open Collective 為機構提供資金,而機構則會透過 Open Collective 支付技術作家的費用。我們會公開專案預算和付款資訊,Season of Docs 網站上的機構專案提案會列出預算,Season of Docs Open Collective 帳戶則會顯示付款資訊。
機構提交個案研究報告後,就視為已順利完成計畫。機構也必須在計畫期間每月完成評估,並在計畫結束後的一年內,每季填寫三次問卷調查。
2022 年精選
「新文件發布後,Casbin 和 Casdoor 的每日訪客數幾乎翻倍,跳出率也下降約 30%。」--Casbin
「這項專案的成果令人振奮,因為我們看到 [技術作家] 在社群中擔任領導角色。兩位作者目前都負責主持工作小組和社群會議,並協助設計及維護我們的專案。」—moja-global
「[GSoD] 協助我們招募到兩位才華洋溢的技術作家,這在一般情況下非常困難。他們持續為 OpenMined 提供積極的 OS 貢獻,我們也與他們有過愉快的合作經驗。」—OpenMined
「此外,新版手冊也更適合初學者使用,舉例來說,CZI 補助金也為歷來處於弱勢的個人提供津貼,而部分獲獎者已使用新的 OpenMS 手冊,在為期六週的實習期間取得良好開端,並對新手冊給予正面評價。」—OpenMS
2022 年摘要資料
2022 年,Season of Docs 計畫接受了 67 件申請中的 31 件專案,其中 30 件專案順利完成計畫。在 31 個獲准的機構中,有 17 個是重複申請者。
31 個獲准的專案聘請了 58 位技術寫作者。超過 190 位技術作家在 Docs 季節 GitHub 存放區中加入聯絡資訊和作品集連結,表示有意參與這項計畫。
2022 年計畫:
- 100% 的機構對申請程序的體驗皆為正面
- 100% 的機構對計畫網站說明/內容的體驗為正面
- 93% 的機構對這項計畫的體驗良好
- 90% 的機構認為自己的文件製作專案成功
關於機構
參與 2022 年「文件季」的組織代表了各種開放原始碼專案。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 說明文件季」結果頁面,其中提供各機構的原始專案提案和完整案例研究連結。
建立的文件類型
在 2022 年個案研究中,說明文件是最常提及的文件類型。
個案研究中提到的其他文件類型包括:
- 快速入門導覽課程
- 詞彙解釋
- 常見問題
- 知識庫
- 元件
- 網誌/社群媒體內容
- 維護者指南
其中有些類別不易區分,單一說明文件專案可能包含多種說明文件類型或功能。
如需更多詳細資訊,請參閱「2022 說明文件季」結果頁面,其中提供各機構的原始專案提案和完整案例研究連結。
預算
平均預算要求為 $11,679 美元,中位數為 $12,150 美元。五個組織申請並獲得最高金額的補助金 ($15k),三個組織申請並獲得最低金額的補助金 (介於 $5k 至 $7k 美元之間)。
指標
個案研究中列出的專案,以及他們用來評估說明文件專案成效的指標。
建議的熱門指標如下:
其他建議的指標包括:
- 更多說明文件提取要求/貢獻
- 在說明文件頁面上提供更直接的意見回饋
- 網頁停留時間
- 提出的問題 (做為使用率的代理指標)
- 論壇參與者
- 合作夥伴/志工/整合項目數
- 跳出率降低
- 提高社區的認知度。
由於完成技術寫作專案和提交個案研究之間的時間很短,2022 年班級的大部分學生在提交個案研究時,無法收集到足夠的資料,無法判斷是否達到初始指標。
我們會在 2023 年收到後續問卷調查的答案後,更新這份報告,新增哪些專案已達到或修訂指標的相關資訊。
如需更多詳細資訊,請參閱「2022 說明文件季」結果頁面,其中提供各機構的原始專案提案和完整案例研究連結。
與技術文件寫作人員合作
在「文件季」計畫中,專案應直接招募、面試、聘用和支付技術作家的薪水。技術文件寫作人員可以將自己加入「Season of Docs」在 GitHub 存放區中維護的目錄,但「Season of Docs」團隊不會審查或推薦技術文件寫作人員。
聘請開放原始碼專案技術作家的最佳做法
我們請各專案分享招募、聘用和與技術作家合作的最佳做法。最熱門的建議如下:
招募
- 減少面試人數,並使用實地練習,而非只審查履歷
- 重視書面和口頭溝通技巧,而非專案語言或工具的熟練程度
- 直接詢問技術作家如何取得專案所需的任何領域知識
- 對專案使命充滿熱忱,並認同開放原始碼核心價值的人員,更有可能在整個專案中保持動力
- 歡迎來自世界各地的申請者,因為多元觀點和背景有助於專案的進行,但請注意,如果編劇和導師所在的時區差異過大,可能就需要花費許多心力維持良好的溝通
徵人啟事
- 使用合約,清楚說明成果、付款時程和具體時間承諾
- 如果專案中有很多未知的項目,請在建立文件時,另外納入探索或研究的里程碑
協調和溝通
- 記錄會議記錄,記錄決策內容,方便所有專案成員瞭解背景資訊和後續步驟
- 明確說明預期的溝通方式和頻率,例如每週通話、每天傳送電子郵件,或是在即時通訊管道中更新狀態
- 回應並提供明確的意見回饋,說明「為什麼」而非「什麼」
- 讓技術作家與更廣大的社群互動,提供相關背景資訊,並讓他們分享自己的作品
程序和工具
- 建立文件製作程序,讓這個程序持續進行,並讓整個社群都能貢獻心力
- 文件審查作業的時間至少與程式碼審查作業一樣長,且同樣繁瑣,因此請務必預留足夠的時間
為求明確,部分建議已經過編輯和濃縮。
如同 2021 年計畫,大多數 2022 年「文件季」的技術作家都是直接向合作機構提出申請。
與技術作家合作時常見的問題
在 2022 年計畫中,有較少專案回報與技術文件撰寫專員合作時遇到的問題。技術作家因生病、全職工作或無法配合時間安排而無法完成課程,是最大的問題。
有一個專案回報,指出其說明文件專案依附於 Google 程式設計夏令營的相關工作,而這些依附元件難以管理。另一個專案遇到困難,因為技術作家需要記錄的硬體遭到該作家所在國家/地區的國防部沒收,無法進口。
後續追蹤問卷調查
我們將在 2023 年 5 月、8 月和 11 月,向 2022 年參與者發送三份後續問卷調查。我們會在收到結果後更新此部分。
未來的問題
一如往常,我們越是瞭解開放原始碼的說明文件,就越想進一步瞭解!
我們希望在未來的季度中:
- 收集更多專案中繼資料,找出專案年齡、社群規模或語言與文件需求之間的關聯
- 分析文件專案,看看是否能將其概括為可共用的範本
- 擬定評量標準,用於面試開放原始碼專案的技術作家
雖然我們有很多問題想調查,但也希望能尊重參與文件季的開放原始碼專案管理員和維護者的時間。本計畫的首要目標,就是協助專案解決說明文件相關問題。