當前階段:
說明文件開發。請參閱時間表。
「文件季度」是由 Google 開放原始碼計畫辦公室管理的永續發展計畫。Google 文件四季的目標為:
- 提供開放原始碼專案支援,透過說明文件解決專案問題
- 讓技術撰寫人員有機會透過開放原始碼獲得經驗
- 提高對開放原始碼、說明文件和技術文件撰寫的意識
- 在開放原始碼說明文件中收集及分享有效指標的相關資訊
如要進一步瞭解整季文件內容,請參閱計畫的網站。
2022 年計畫總覽
文件季度的運作方式
在文件季中,機構可以提交專案提案來提出申請。專案提案包括:
- 機構相關資訊
- 說明專案所面臨的問題
- 專案該如何運用文件協助解決問題
- 專案如何衡量說明文件的成效 (指標)
- 作業時程
- 專案預算
- 任何其他資訊,例如機構使用類似程式的經驗,或是任何可幫助「文件」季度管理員瞭解專案和問題的其他資訊
獲準加入計畫後,機構組織即可直接招聘並聘請技術撰稿人。文件季度會使用 Open Collective 架構給機構,並透過 Open Collective 將技術文件撰寫專員交由 Open Collective 處理。專案預算和付款資訊透明公開;預算已納入 Google 文件季度網站提供的機構專案提案,而款項資訊則會顯示在「文件季別開放集合」帳戶中。
機構組織在提交個案研究報告時,視同已成功完成計畫。計畫期間,組織也必須完成每月評估,並在計畫完成後的一年內進行三季的後續問卷調查。
2022 年精彩集錦
Casbin 說:「新文件推出後, Casbin 和 Casdoor 的每日造訪次數幾乎增加了一倍,跳出率則下降約 30%。」—Casbin
「這項專案的亮眼成果為 [我們的技術撰稿人] 奠定了我們社群中的領導角色。兩位貢獻者現在都是工作團隊及社群會議,也是我們專案的設計和維護的一大助力。」—moja-global
「[GSoD] 協助我們招募了兩名才華洋溢的技術作家,在日常環境中是非常困難的工作人員。他們一直在保持對 OpenMined 的活躍作業系統,而且與 Google 的合作經驗豐富。」 - OpenMined
「此外,新的手冊對於運算量譜系的新手來說也簡單多了。為了說明這一點:CZI 補助計劃也為以往缺乏特殊權限的個人和部分獲獎者提供帶點提示。他們也使用新版 OpenMS 手冊快速展開六週的實習工作,並對新的手冊給予正面評價。」—OpenMS
2022 年摘要資料
2022 年,「文件季度」計畫分別接受了 67 個申請中的 31 項專案,以及 30 項專案順利完成了這項計畫。其中 31 個合格機構中有 17 個是重複申請者。
該公司接受了 31 項專案,聘用了 58 位技術撰寫人員。超過 190 位技術撰寫人員表示他們有興趣參與這項計畫,方法是在「文件」的 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 美元。有 5 家機構要求並獲得最高的可用補助金 ($1.5 萬美元),而其中 3 個要求最低金額介於 $5,000 美元至 $7,000 美元之間。
指標
個案研究中列出的專案都研究了用來評估文件專案成效的指標。
最常見的建議指標是:
其他建議指標包括:
- 更多說明文件提取要求/捐款
- 針對說明文件頁面提供更直接的意見回饋
- 網頁停留時間
- 提出的問題 (做為 Proxy 使用)
- 論壇中的參與者
- 合作夥伴/志工/整合數量
- 跳出率降低
- 提高社群意識。
由於完成技術撰寫專案和提交個案研究之間的空窗期,多數 2022 年同類群組在提交個案研究時並未收集到足夠資料,無法判斷是否已達成初始指標。
我們會在 2023 年收到後續問卷調查回覆,屆時會更新這份報告,說明哪些專案已達成相關指標,或已修改相關指標。
如需更詳細的資訊,請參閱文件 2022 季度的結果頁面,當中含有原始專案提案的連結,以及各機構的完整個案研究。
與技術撰稿人合作
在「文件」季度計畫中,專案應直接招募、訪談、聘用及支付技術撰稿人。技術文件寫作人員可以在我們的 GitHub 存放區中,將自己加入「Google 文件」季維護的目錄。不過,文件季度職員並未自行審查或建議技術撰稿人。
聘請技術撰稿人完成開放原始碼專案的最佳做法
這些專案包括招募、聘僱及與技術撰稿人合作的最佳做法。最重要的建議如下:
招募
- 訪問較少候選人並採用即時練習,而非只評論履歷表
- 超越精通專案語言或工具的書面和口頭溝通技巧
- 直接詢問技術文件撰寫人員如何獲得處理專案所需的任何領域知識
- 對專案理念充滿熱情,且與核心開放原始碼價值相同的成員,較有可能保持整個專案的動力
- 開放全球各地的申請者踴躍報名,因為多元觀點和背景往往能提升你的專案進度。但請留意,如果身處太多時區的衝突立場寫作家和導師,可能需要投入更多心力才能維持良好溝通。
徵人啟事
- 請使用清楚載明交付項目、付款時間表和特定承諾使用時間的合約
- 如果您的專案未知數,請將探索或研究的里程碑與建立說明文件分開,
協調與溝通
- 建立會議記錄決策,方便所有專案工作人員瞭解背景資訊和後續步驟
- 清楚說明預期的溝通方式和頻率,例如每週來電、每日電子郵件,或是即時通訊管道中的狀態更新
- 積極回應並提供明確建議,並附上「原因」而非「問題」部分
- 連結技術撰稿人與廣大社群交流,提供背景資訊,並讓他們瞭解作品
處理程序和工具
- 建立文件流程,在 Google 文件計畫的季節更進一步,讓整個社群都能夠貢獻一己之力
- 說明文件審核作業至少需要一段時間才能完成,和程式碼審查也同樣需要大量時間;請務必預留充裕的時間
為求明確,部分最佳化建議已經過編輯並壓縮。
就像 2021 年計畫一樣,2022 年文件季中大部分的技術寫作者都直接應徵工作機構。
與技術撰稿人合作的常見問題
在 2022 年計畫中,與技術撰稿人合作的專案較少。無法完成計畫的技術撰寫者是最棘手的問題,因為患有疾病、需要全職工作,或是無法達到承諾的時間。
有一項專案回報他們的文件專案仰賴 Google Summer of Code 完成的工作,而且這些依附元件難以管理。另一項專案則是,在作家所在國家/地區國防部將所需硬體撰寫文件區隔開來,導致作業無法匯入。
後續問卷調查
2023 年 5 月、8 月和 11 月,我們會針對 2022 年 5 月、8 月和 11 月分別發送三份後續問卷調查。收到結果後,我們會更新這個部分。
日後的問題
和往常一樣,我們會針對開放原始碼文件學習越多,想瞭解越多越好!
我們希望在未來的季度中:
- 收集更多專案中繼資料,找出專案年齡、社群規模或語言和文件需求之間的關聯
- 分析說明文件專案,確認是否能將專案一般化為可共用的範本
- 製作評分量表,用於訪問開放原始碼專案中的技術作家
我們希望能調查許多問題,但也應該尊重參與「文件季」的開放原始碼專案管理員和維護人員的時間。這項計畫的首要任務是支援相關專案,運用說明文件來解決問題。