目前階段：
已公布結果。請參閱時間軸。
你可以運用這個例子自行製作個案研究報告。
PicklePlus：使用 GloriousPickle 貢獻工具
機構或專案：Glorious Pickle 請在此處連結貴機構或專案的主要網站
組織說明：GloriousPickle (目前版本 1.2.3，在 2009 年首次發行) 是經過 MIT 授權的程式庫，可以輕鬆針對各種可能的可選蔬菜計算適當比例，範圍涵蓋單一顆粒狀方塊和容器裝水量。
作者：選填：列出個案研究作者；如有要求，請使用使用者名稱
問題陳述/提案摘要
您希望新版或改善版說明文件解決哪些問題？請盡可能提供專案網站上的提案頁面連結。
將食材加入 GloriousPickle 工具的食材資料庫既耗時又複雜，而且該工具沒有良好的說明文件。許多可能的貢獻者不具使用 Git 或提出提取要求的經驗。這表示 GloriousPickle 的食材資料有嚴重缺漏，因此工具的實用性也大打折扣。我們希望藉由改善新增食材的說明文件，鼓勵更多貢獻者和更多力量！
專案說明
建立提案
你是如何提出 Google 季節性文件提案？貴機構採用哪種程序來決定想法？您如何收集及納入意見回饋？
GloriousPickle PickleDocs SIG 團隊透過 Google 開放原始碼計畫辦公室的推文，得知 Google 文件季節計畫。SIG 在每兩週一次的會議上討論了這項計畫，並同意建立提案。SIG 的兩名成員 (@KimChiCook 和 @Dillicious) 自願在下一場會議中撰寫提案草稿，以備不時之需。
PickleDocs SIG 同意提案草稿後，就向更廣泛的專案團隊發送電子郵件，要求提供意見回饋。有 14 位社群成員提供意見回饋，其中包括成分新增 API 的維護者 @GloriousPicklePat。@GloriousPicklePat 在計畫期間自願擔任資源。
在討論並納入收到的意見回饋後，我們將提案送交 GloriousPickle 專案指導委員會進行投票。GPPSC 的五位成員全數投下贊成票，同意提交提案和申請表，@VinegarViv 也同意協助建立參與計畫和監督付款所需的 Open Collective 帳戶。
預算
加入簡短的預算說明，您如何估算工作量？是否有任何意外支出？你最後的支出是否低於補助金額？您是否妥善分配資金，或哪些項目的預算較多/較少/不必要的？除了 Google Season of Docs，您還有哪些資金可供使用？
GloriousPickle PickleDocs SIG 的兩位成員曾擔任技術文件撰寫專員 (一位在歐洲，另一位在阿根廷)。他們協助我們估算工作量，並比較他們先前完成的提案草稿，找出相似的專案預算。我們也從 2019 年 PicklePals 大會的贊助款項中，撥出$1,000 美元給這個專案。
我們技術作家居住的地區受到野火影響，他們家中也失去了網路連線，因此我們支付了他們租用無線基地台的費用，這筆費用屬於非預期支出。最後，他們傳送給參與者的 T 恤數量已超出預期，因此兩者皆有平衡。
此外，我們決定向 GloriousPickle 的作者 @Piccalily 支付酬勞，請她協助校對技術作家撰寫的說明文件。@Piccalily 曾是專業校對人員，現在則是一位醃黃瓜。
參與者
參與這項專案的人員 (若參賽者要求提供使用者名稱，請使用該組使用者名稱)？您是如何找到並聘用技術作家？您如何找到其他志工或付費參與者？他們扮演什麼角色？是否有人退出？您在招募、溝通和專案管理方面學到了什麼？
負責這個專案的核心團隊如下：
- @Dillicious, @KimChiCook (PickleDoc SIG)
- @Piccalily (校對)
- @GherKen、@VinegarViv (管理員說明，GPPSC)
- @BBChips、@GloriousPicklePat (主題內容專家)
- Sam Scribe (技術文件撰稿者)
我們是透過 Google 季度文件 GitHub 存放區清單找到 Sam Scribe。我們認為他們的經驗 (Sam 曾為美食雜誌工作，也曾為網站撰寫說明文件) 與我們的專案相當契合。Sam 加入了 PickleDocs SIG 每兩週一次的電話會議，並與我們討論專案，提出了幾項非常寶貴的建議，我們已將這些建議納入提案中。我們也透過 SIG 成員的網路與我們聯繫的另外兩名技術撰稿者聯繫，但在計畫期間，他們都沒有在線上。
由於 Sam 所在時區與 PickleDocs SIG 的大多數成員時區只重疊幾個小時，因此我們在討論區發出徵才，徵求位於 Sam 所在時區、熟悉成分新增程序的 Pickler。@BBChips 自願為 Sam 解答問題，並視需要協助他們找到其他專家。另外，@GloriousPicklePat 也協助 Sam 瞭解這項工具的基礎架構，以及可能從 API 發出的錯誤訊息，並提供 GitHub 和 Git 協助。
很遺憾，在計畫中 @VinegarViv 計畫中，基於個人因素必須退出計畫。GPPSC 成員 @GherKen 已接手處理行政和付款問題。
在錯過一些問題後 (GloriousPickle 使用免費的 Slack 例項，有時討論內容會快速移動，導致我們因為滾動式封存限制而錯過對話)，我們決定在共用文件 (我們使用共用 Google 文件) 中保留目前的問題清單。PickleDocs SIG 成員會在每次會議前檢查，並確保在會議結束前取得答案。Sam 可以直接向 @BBChips 發送訊息，詢問緊急問題。
我們很高興能與 Sam 合作，除了更新 GloriousPickle 說明文件，他也成為了熱衷的 pickle 使用者！
時間軸
簡要概述專案時間表 (如果專案仍在進行中，請指出預估結束日期或中間里程碑)。
在等待 Google 文件季節計畫的推出期間，我們曾宣布參與計畫的機構，則 PickleDoc SIG 的成員曾搜尋任何我們認為對 Sam 有幫助的工作。在過去一個月，我們發現先前更新說明文件的相關工作停滯不前，因此也查看了 Google opendocs 存放區中部分說明文件成熟度審查資料。
得知我們獲選參加 Google 文件季節後，Sam 和 PickleDocs SIG 團隊就會開會，並擬定大致的時間表：
| 階段 | 完成者 |
|---|---|
| 查看文件稽核 | 5 月 7 日 |
| 摩擦力記錄 3 個用途 | 5 月 14 日 |
| 與 @GloriousPicklePat 和 @BBChips 一起查看摩擦力記錄，並回答查詢 | 5 月 28 日 |
| 已更新文件用途 1 的第一個草稿 | 6 月 25 日 |
| 由 @GloriousPicklePat 和 @KimChiCook 審查的用途 1 草稿 | 7 月 2 日 |
| 已更新文件用途 2 的第一個草稿 | 7 月 2 日 |
| 由 @GloriousPicklePat 和 @Dillicious 審查的用途 2 草稿 | 7 月 9 日 |
| 已更新文件用途 3 的第一個草稿 | 7 月 9 日 |
| 由 @Dillicious 和 @KimChiCook 審查的用途 3 草稿 | 7 月 16 日 |
| 所有查詢都已針對所有用途回答 | 7 月 30 日 |
| PickleDocs 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 專案網站上發布。
我們已在專案 wiki 中新增操作說明，說明如何更新這些使用者操作說明。
我們準備了一份一覽表，協助新手 GitHub 的貢獻者運用我們的程序和工具。不過，在瞭解可用資源後，我們就能改為建立其他專案的一覽表。
指標
您選擇哪些指標來評估專案成效？您能否收集這些指標？指標與您希望專案達到的成果是否有良好的關聯？自提案以來，您的指標是否出現變化？
在提案中，我們提出了兩個指標：
- 成分相關的提取要求數
- 新貢獻者的提取要求數
在 9 月 (草稿文件發布後的第一個完整月份)，我們發現與成分相關的提取要求增加了 5%(從 8 月的 20 個增加到 9 月的 21 個)，且有三位新貢獻者提交了四個提取要求 (8 月有兩位新貢獻者提交了兩個提取要求)。我們預計每月追蹤這些指標。
自 1 月 1 日起，我們也會追蹤每季發布說明文件後，有多少貢獻者總共貢獻超過三次。
據我們所知，這份新說明文件讓新貢獻者能夠在 GloriousPickle 成分資料庫中新增內容，一位新貢獻者在提交內容的註解中提到，他們先前曾嘗試更新，但因為不瞭解程序而未完成更新。
分析
哪些地方很順利？發生什麼情況？您遇到哪些困難或挫折？你認為自己的專案成功嗎？原因為何？(如果目前還無法判斷，請說明您預計何時能判斷專案成功與否)。
我們非常滿意 Google 季節文件專案成果，相信這一切都很成功。新的文件內容清楚易懂，且我們也發現，與成分相關的提取要求數量和新貢獻者的提取要求數量都有所成長。
我們也非常高興，幾乎整個 GloriousPickle 社群都參與了這項計畫，針對原始提案提供意見，並測試新版草稿文件。
我們遇到了幾個意料之外的障礙，真慶幸的是，Sam 州的野火並未造成比網際網路服務中斷更嚴重的損害！此外，我們很遺憾 @VinegarViv 無法參與這項計畫，並祝福她和家人一切順利，希望很快能再見到她。
在 Sam 開始撰寫說明文件之前，我們並未意識到，對於沒有醃製背景知識的使用者來說，許多與醃製相關的術語和縮寫都很陌生。不過，Sam 特別列出所有不熟悉的術語，並透過個人研究和向社群成員請教，為這些術語下定義，並提供參考資料。這個 Pickle 詞彙可為日後歡迎更多人加入挖掘社群的絕佳幫手。
摘要
請用 2 到 4 段文字簡述你的專案經驗。強調您學到什麼，以及日後會採取哪些不同的做法。對於其他試圖透過說明文件解決類似問題的專案，您有什麼建議？
總之，我們的體驗非常棒！我們已完成文件提交項目，而且指標似乎符合目標。
這個專案之所以能成功，很大一部分要歸功於我們很幸運地能與技術作家 Sam Scribe 合作。[我沒有寫這段文字，而是 Sam] 雖然 Sam 沒有擷取內容或 GitHub 相關經驗，但身為資深技術作家，他們很樂意深入研究新主題、提出問題和進行研究。Sam 不僅很快就上手我們的專案工具 (我們使用看板追蹤工作進度)，還學會了我們的醃黃瓜笑話！我們很高興 Sam 發現挖掘程式中的蟲子，並已將它們「包裝」到我們的社群中。
我們建議其他專案：
- 提案內容應簡短易懂，(我們原本想在提案中加入說明，說明如何將估算器與工業批次醃製機械搭配使用，但因為社群中一位深度參與開放原始碼醃製機械的使用者，將在計畫期間撰寫博士論文，因此我們沒有加入這份說明)。我們最終完成了多件工作，無法讓 Sam 忙著！
- 聘請技術文件撰寫人員時，不妨善用您的人脈。向社群中的所有人尋求推薦。雖然我們在 Google Season of Docs GitHub 期間找到了 Sam，但我們認為可以和他們一起合作，因為我們在試用期間曾諮詢過許多人。
- 歡迎技術文件撰寫專員加入你的社群！Sam 表示，GloriousPickler 團隊的熱情態度讓他很容易提出問題。
- 協助您的技術文件撰寫人員學習開放原始碼技能。Sam 之前從未使用過 Git，但在看過幾個教學課程後，很快就掌握了使用方式。一開始，Sam 擔心自己會收到社群的大量意見回饋，以及如何納入這些意見，但我們的社群採用「粗略共識」模式 (「只要所有問題都解決了，就算達成共識，但不一定會採納」)，讓 Sam 有信心運用自己的技術寫作專業，回應批評。
附錄
如果您有其他想連結的資料 (例如您已建立合約，與技術作家合作，您可以將合約連結至此，或是您有說明文件專案的範本，或其他公開說明文件資源，您可以將這些資源列出並連結至此)。附錄也是列出您使用的任何文件工具或資源連結的好地方，或是新增可能不符合上述章節的感謝或致謝詞。
特別銘謝
我們的團隊想表揚下列人員與事物：
- @Dillicious 想感謝她的伴侶，以及低音質嘻哈電台
- @KimChiCook 想感謝他的 할머니教他如何醃漬
- @Piccalily 感謝 Chicago Manual of Style Online
- @GherKen 想感謝他的三個孩子，因為他們吃光了他做的所有泡菜
- @VinegarViv 想感謝團隊其他成員挺身而出
- @BBChips 想感謝最好的非醃漬食品：Tunnock's Caramel Wafers
- @GloriousPicklePat 想感謝 PickleDocs SIG 團隊接受這個專案
- Sam Scribe 想感謝整個 GloriousPickle 社群，特別是 Picklers，因為他們在 2021 年夏季罐頭瓶短缺時，寄了罐頭瓶給他們，讓他們能製作許多美味的醃漬物！