Google 季度文件個案研究範例

目前階段:
公布結果。請參閱時間表

您可以參考這個範例,建立自己的個案研究報告。

PicklePlus:記錄 GloriousPickle 捐款工具

機構或專案:Glorious Pickle 點選連結即可查看貴機構或專案的主要網站

組織說明:GloriousPickle (目前版本 1.2.3,於 2009 年首次發布) 是一種由 MIT 授權的圖書館,可輕鬆為各種可能的可食用蔬菜數量,從單一單一單營灌籃子長方形和容器 T 形陣營中計算出的鹽含量、糖、醋和香料的完美比率。

作者:選填:列出個案研究的作者;如有需要,請使用使用者名稱

問題聲明/提案摘要

你想要使用全新或改善的說明文件解決哪些問題?如果可以,請提供專案網站上的提案頁面連結。

在 GloriousPickle 工具成分資料庫新增食材不僅耗時又複雜,而且這項工具沒有完善的說明文件。許多貢獻者都沒有使用 Git 或發出提取要求的經驗。也就是說,GloriousPickle 在原料資料上出現嚴重落差,讓這項工具的實用性降低。藉由改進新增食材的說明文件,我們希望鼓勵更多貢獻者和更多精通知識!

專案說明

建立提案

您如何構思自己的 Google 文件季工作提案?貴機構以什麼流程做出構想?你如何徵求與採納意見回饋?

GloriousPickle PickleDocs SIG 透過 Google 開放原始碼計畫辦公室發布的推文,得知 Google Season of Document 程式。SIG 會在每兩週會議中討論這項計畫,並同意建立提案。有兩名 SIG (@KimChiCook 和 @Dillicious) 自願參與下一場會議,討論草擬提案。

PickleDoc SIG 同意草擬提案草稿後,系統會發送電子郵件給規模較大的專案,徵求意見回饋。十四位社群成員提供意見回饋,包括 @GloriousPicklePat 的食材新增 API 維護人員。@GloriousPicklePat 在計畫期間擔任志工。

在討論並採納收到的意見回饋後,提案已送交 GloriousPickle 專案指導委員會進行投票。GPPSC 五位成員均投票 +1 提出提案和申請書,而 @VinegarViv 同意協助建立參與計畫及監督付款的必要公開募集帳戶。

預算

提供簡短的預算。您如何估算預估費用?是否有任何非預期的費用?你的支出最終是否低於資助金額?您是否適當分配資金,或有些項目為了增加/減少/不必要的預算而編列預算?請問您是否能使用 Google 文件季別以外的其他資金?

GloriousPickle PickleDoc SIG 的兩位成員分別擔任技術撰稿人 (分別位於歐洲和阿根廷)。幫助我們估算工作成效、找出類似的專案預算,並比較先前完成的提案草稿。我們也在 2019 年 PicklePals 慣例中,分配到的無限制贊助款項還有$1,000 美元。

當時我們的技術文件製作人員位於野火所波及的區域,他們家裡的網際網路斷線,因此難以預料。最終,寄給參與者的 T 恤數量也比我們預計的數量來得少,因此相輔相成。

此外,我們也決定向 GloriousPickle 貢獻者 @Piccalily (曾經在她不省事的情況下擔任專業文案編輯器) 提供補償,協助他們進行文案編輯和校對技術寫作文件。

參與者

負責這項專案的人員 (如果參與者要求的話,請改用使用者名稱)?您是如何找到並聘用技術撰稿人?你是如何找到其他志工或付費參與者?對方擔任什麼角色?是否有人棄賽?您在招聘、溝通及專案管理方面學到了什麼?

本專案的主要團隊如下:

  • @Dillicious, @KimChiCook (PickleDocs SIG)
  • @Piccalily (副本編輯器)
  • @GherKen、@VinegarViv (管理員說明、GPPSC)
  • @BBChips、@GloriousPicklePat (主題專家專家)
  • Sam Scribe (技術文件撰稿者)

我們在 Google Season of Document GitHub 存放區中發現 Sam Scribe 清單,我們認為他們的經驗 (小山負責烹飪雜誌,以及撰寫網站文件),也符合我們的專案。Sam 每兩週加入 PickleDoc SIG 進行討論,並針對專案內容提出了幾項寶貴的建議,並在提案中納入這些建議。我們也透過 SIG 成員的網路與另外兩名技術撰稿人聯絡,不過在計畫期間,這些都不是問題。

由於小山的時區與 PickleDoc SIG 的大多數成員只在幾小時內重疊,因此我們在我們的論壇中打電話給 Picklers 團隊,對方位於 Sam 的時區,也熟悉食材添加過程。@BBChips 自願回答 Sam 的問題,並協助他們視需要尋找其他專家。@GloriousPicklePat 也自願協助 Sam 瞭解這項工具的基礎架構和 API 可能顯示的錯誤訊息,並提供 GitHub 與 Git 協助。

很遺憾,在進行 @VinegarViv 計畫的過程中,必須出於個人理由不要離開專案。GPPSC 成員 @GherKen 採取行動處理管理和付款問題。

在遺漏了一些問題之後 (GloriousPickle 使用免費的 Slack 執行個體,有時討論會因為滾動式封存限製而迅速中斷) 我們就知道在共用文件時,應該將執行中的問題清單留存在共用文件中 (我們使用了共用的 Google 文件)。PickleDoc SIG 成員每場會議前就已確認過文件,確保在會議結束前已得到答案。Sam 可以直接透過連線偵測 (ping) @BBChips 回答緊急問題。

我們很開心與 Sam 和 Sam 合作,除了更新 GloriousPickle 說明文件,也變成喜歡自己熱愛的挑選器!

時間表

概略介紹專案時間表 (如果專案進行中,請說明預估結束日期或中繼里程碑)。

在等待 Google 季節性文件計畫公布參與組織的同時,PickleDocs SIG 成員搜尋了之前認為對 Sam 實用的作業。一整個月內,我們發現有些先前為了更新故障文件而付出的筆記,並探討了 Google 開放文件存放區中各個文件成熟度稽核資料的部分內容。

當我們收到好消息,獲選為 Google 文件季別後,Sam 和 PickleDoc SIG 會相遇,並制定了一場粗略的時間表:

階段 完成者
查看文件稽核 5 月 7 日
幹擾記錄 3 個用例 5 月 14 日
透過 @GloriousPicklePat 和 @BBChips 查看重新導向記錄,以及回答問題 5 月 28 日
更新文件用途的第一個草稿 1 6 月 25 日
@GloriousPicklePat 和 @KimChiCook 審查了應用實例 1 草稿 7 月 2 日
更新文件用途的第一個草稿 7 月 2 日
由 @GloriousPicklePat 和 @Dillicious 審查的用途 2 草稿 7 月 9 日
更新文件用途的第一個草稿 3 7 月 9 日
由 @Dillicious 和 @KimChiCook 審查的用途 3 草稿 7 月 16 日
適用於所有用途的查詢 7 月 30 日
大多數的 PickleDoc SIG 都在 8 月 1 日至 20 日休假 --
開始在社群中測試新文件 (文件在 GloriousPickle 網站發布為草稿) 8 月 21 日
整合測試意見回饋 9 月 10 日
複製新文件並校對 9 月 17 日
已移除文件的草稿狀態,文件已正式推出 9 月 28 日
已建立文件的更新程序 11 月 1 日
這份個案研究已建立 11 月 8 日
已提交個案研究 11 月 16 日

根據我們的提案預算,我們預估技術撰稿人每週會花 10 至 15 小時執行專案。Sam 記錄了每週花費的時間,平均每週 11.5 小時。

研究結果

哪項功能會建立、更新或進行其他變更?附上已發布的說明文件連結 (如有)。提案中是否有任何未創建的交付項目?請一併列出。

以下提供三大主要使用案例:完整的使用者使用指南:

如何在 GloriousPickle 新增食材

如何將子類食材新增至 GloriousPickle

如何更新或更正 GloriousPickle 中的食材

這些指南也納入新的提取要求範本,協助您更輕鬆做出貢獻。

此外,在專案執行期間,Sam 建立了小型的 Pickle 詞彙表,這份詞彙也發布於 GloriousPickle 專案網站。

我們在專案維基方面,加入了有關使用者使用指南的更新說明。

我們製作了一份一覽表,協助第一次使用 GitHub 的貢獻者運用我們的程序和工具。不過,我們查看可用的資源後,就能改為建立其他專案的一覽表。

指標

貴公司選用哪些指標來評估專案成果?你能否收集這些指標?這些指標是否符合你希望專案成果的關聯或差?指標是否在提案後改變?

提案中,我們提出了兩項指標:

  • 與食材相關的提取要求數
  • 來自新協作者的提取要求數

在 9 月 (發布草稿文件後的第一個完整月) 中,我們發現與食材相關的提取要求數增加了 5% (從 8 月 20 日到 9 月 21 日),而我們發現有三位新貢獻者共提出四項提取要求 (意即 8 月提出兩次提取要求的新貢獻者)。我們計劃每月追蹤這些指標。

自 1 月 1 日起,我們也會追蹤在文件發布後每季內貢獻超過三次的協作者人數。

不幸地,Google 相信這份新版說明文件可以讓新貢獻者加入 GloriousPickle 成分資料庫,因為他們曾在 PR 評論中提到一位新貢獻者,因為他們不瞭解流程而未完成更新。

分析

哪些地方很順利?哪些部分出乎意料?您面臨哪些困難或背負?你認為自己的專案成功嗎?原因為何?(如果時間太早,請說明您何時能夠判斷專案成功與否)。

我們對於 Google Season of Document 專案成果非常滿意,認為這個專案的成效非常出色。新版說明文件清楚且實用,我們觀察到與食材相關的提取要求數量以及新貢獻者的提取要求數量都有所成長。

我們也很高興 GloriousPickle 社群參與整個 GloriousPickle 社群,除了針對原始提案提供意見,我們也希望以草稿形式測試新文件。

然而,我們遇到了一些意想不到的障礙,我們很感激,阿山州的野火並未造成比網際網路服務中斷更高的損害。此外,對於失去 @VinegarViv 這個專案也,我們深感遺憾。衷心祝福她和家人能事半功倍,希望很快就能再見到她。

我們在研究文件之前,不知道 Sam 開始研究文件時,發現有太多相關字詞和縮寫,對於進入專案的人來說,沒有明確的背景。不過,Sam 將所有陌生字詞列成清單,並透過自己的研究及社群成員尋求說明與參考資料。這個 Pickle 詞彙解釋能夠有效協助更多人加入精挑細選的社群。

摘要

使用 2 到 4 個段落,總結專案體驗。請強調你的學習成果,以及你日後該如何改變做法。對於想解決文件上類似問題的其他專案,你會給予什麼建議?

總而言之,我們的經驗相當驚人!我們完成了文件交付,而且相關指標似乎都符合我們的目標。

這項專案能夠成功的重要關鍵,就是我們與技術撰稿人 Sam Scribe 合作的成績非常好。[我並未寫字—Sam] 雖然 Sam 沒有採摘或使用 GitHub 的經驗,但身為經驗豐富的技術撰稿人,但他們很願意深入研究新的學科領域、提出問題,以及進行研究。Sam 很快就掌握了專案工具 (我們使用記錄板記錄工作情況),也會接納我們的冷笑話!我們很高興 Sam 抓到了醃漬錯誤,而且也成功在社群中解救他們了。

我們建議其他專案採取下列行動:

  • 確保提案內容精簡且易於管理。(我們原本想要在提案中附上相關文件,說明如何搭配使用 Estimator 和工業批發機械,但由於我們的其中一位社群成員深入參與開放採礦機械,因此計劃在計畫期間撰寫自己的博士學位。)最終我們做了太多工作,讓 Sam 保持忙碌!
  • 想聘請技術撰稿人時,請善用您的網路。請社群中的所有人獲得推薦。雖然我們在 Google 文件 GitHub 提供了 Sam,但我們很有信心與他們合作,因為在申請期間我們和幾位人員討論。
  • 歡迎技術撰文者加入社群!Sam 讓我們知道 GloriousPicklers 熱情的態度讓大家能輕鬆發問。
  • 協助技術撰寫人員學習開放原始碼技能。Sam 從未使用過 Git 工具,但是完成一些教學課程後,他們很快就學會快速操作。一開始,Sam 擔心社群成員會得到多少回饋,以及如何採納社群,但我們的社群「共識」模型 (「共識」在解決所有問題後即達成共識,但不一定能配合調整),因此 Sam 有信心運用自身的技術專業能力來因應批評。

附錄

如果想連結其他資料 (例如您建立了與技術撰稿人合作的合約、文件專案範本或其他開放性文件資源,可以在這裡列出及連結)。「附錄」也非常適合列出您所用說明文件工具或資源的連結,或提供補充說明或致謝的時候,與上述部分不符。

特別銘謝

本次團隊要感謝以下人員和事物:

  • @Dillicious 想感謝她的伴侶和低傳真嘻哈電台
  • @KimChiCook 想感謝他的驗證達人
  • @Piccalily 感謝芝加哥線上樣式手冊
  • @GherKen 想感謝他的三位孩子吃下他可以做的所有醃黃瓜
  • @VinegarViv 想感謝團隊成員為自己下落後
  • @BBChips 想感謝 Tunnock 的 Caramel Wafers 優質不挑選的食物
  • @GloriousPicklePat 感謝 PickleDoc SIG 參與這項專案
  • Sam Scribe 想感謝 GloriousPickle 全體成員,更要感謝所有 GloriousPickle 社群在 2021 年夏日短罐 罐裝罐裝果醬的 Picklers,她先帶大家來到許多美味醃黃瓜!