目前階段：
「2021 年文件季別」計畫已於 2021 年 12 月 14 日結束。請參閱時間表。
請使用這個例子協助你建立個案研究報告。
PicklePlus：記錄 GloriousPickle 貢獻工具
機構或專案：Glorious Pickle (可前往貴機構或專案的主要網站連結)
機構說明：GloriousPickle (目前版本 1.2.3，於 2009 年推出第一項) 是 MIT 授權的程式庫，能夠輕鬆計算各種可選蔬菜的理想比例，從單一獨木製嬰兒包到容器，數量不一。
作者：選用：列出個案研究的作者，視需要使用使用者名稱
問題陳述/提案摘要
您試圖透過全新或改良的說明文件解決哪些問題？可能的話，請提供專案網站上的提案頁面連結。
在 GloriousPickle 工具的食材資料庫中加入食材，既耗時又複雜，而且工具未提供完善的說明文件。許多潛在貢獻者並沒有使用 Git 或提取要求的經驗。這表示 GloriousPickle 所含的食材資料有嚴重的缺漏，導致我們的工具較不實用。改善新增食材的說明文件，進而鼓勵新的貢獻者進行更多挑選！
專案說明
建立提案
您如何構思一份文件季的提案？貴機構如何決定構想？您是透過何種方式徵求及納入意見回饋？
GloriousPickle PickleDocs SIG 是透過 Google 開放原始碼計畫辦公室發文，得知文件季度。SIG 在每兩週的會議中討論了這項計畫，並同意提出一份提案。共有兩名 SIG (@KimChiCook 和 @Dillicious) 成員自願回覆草擬提案內容，我們將在下一場會議中審閱。
PickleDocs SIG 議定提案草稿後，系統會將電子郵件傳送至更廣泛的專案，要求他們提供意見回饋。14 位社群成員提供意見回饋，包括 ingredient-adding API 的維護者 @GloriousPicklePat。@GloriousPicklePat 自願在計畫期間擔任資源。
在討論並整合收到的意見回饋後，這份提案會送交 GloriousPickle 專案指導委員會投票。GPPSC 共有 5 名成員投票 +1，以提交提案和申請，@VinegarViv 也同意協助建立參加計畫所需的 Open Collective 帳戶，以及監管付款。
預算
加入簡短的預算區段。您如何預估成果？有任何意料之外的費用嗎？您的支出是否低於獎助金？您是否有其他資金可以用在文件季度之外呢？
GloriousPickle PickleDocs SIG 的兩位成員曾任職於技術文件撰寫專員 (其中一位位於歐洲，另一位位於阿根廷)。他們幫助我們預估工作成果，找出類似的專案預算，並與先前完成的提案草稿進行比較。自 2019 年，我們分配給這項專案的 PicklePals 慣例中，還有價值$1,000 美元的贊助款項。
我們的技術作家曾發生意外費用，協助技術撰寫人員租用 Wi-Fi 無線基地台，原因是這些熱點位於野火影響的地區，而住家成員在家中無法上網。此外，發送給參與者的 T 恤數量也比預期來得少，因此發送出去。
此外，我們決定補償 GloriousPickle 貢獻者 @Piccalily (他曾是過往生活的專業文書編輯者)，協助複製及校對技術撰寫者製作的文件。
參與者
參與這項專案的人員 (如參與者要求，請提供使用者名稱)？你是如何找到並聘僱技術文件撰稿人？您是如何找到其他志工或付費參與者？他們扮演什麼角色？有人漏掉了嗎？您在招募、溝通和專案管理方面學到哪些相關知識？
這項專案的核心團隊如下：
- @Dillicious、@KimChiCook (PickleDocs SIG)
- @Piccalily (文案編輯器)
- @GherKen、@VinegarViv (管理員說明、GPPSC)
- @BBChips、@GloriousPicklePat (主旨-matter 專家)
- Sam Scribe (技術文件撰寫者)
我們在文件的 GitHub 存放區季度清單中找到 Sam Scribe。我們認為他們的經驗 (Sam 曾任職於烹飪雜誌，同時也在撰寫網站說明文件方面) 和我們的專案相符。Sam 每兩週都會加入 PickleDocs SIG，與 Google Cloud 專案分享，我們提出了幾項非常寶貴的建議，納入提案中。我們也透過 SIG 成員的網路，與其他兩位技術文件撰寫專員聯繫，但在計畫期間，這兩個人都無法取得。
由於 Sam 的時區只有幾小時的時間與 PickleDocs SIG 的大多數成員重疊，因此我們在我們的討論論壇中為位於 Sam 時區、熟悉食材加入程序的 Pickler 發起通話。@BBChips 是自願回答 Sam 的問題，並視需要協助尋找其他專家。@GloriousPicklePat 也是自願協助 Sam 瞭解此工具的基礎架構和可能來自 API 的錯誤訊息，同時提供 GitHub 和 Git 的協助。
很遺憾，在參加計畫 @VinegarViv 期間，基於個人因素，必須離開專案。GPPSC 成員 @GherKen 負責處理管理和付款問題。
先前錯過了一些問題 (GloriousPickle 使用免費的 Slack 執行個體，但有時討論過程變得很快，使得討論內容因滾動式封存限制的限度而逐漸消失，但我們仍發現必須在共用文件 (使用共用的 Google 文件) 中列出執行中的問題清單。PickleDocs SIG 成員已在每場會議開始前查看過，並確實在會議結束前取得答案。Sam 能夠直接透過 @BBChips 提出緊急問題。
我們非常高興與 Sam 和 Sam 合作，除了更新 GloriousPickle 文件之外，也逐漸成為精挑細選者！
時間表
概略說明專案時間表。如果專案仍在進行，請指定預估結束日期或中間里程碑。
在等待「文件季別」計畫公布參與機構的期間， PickleDocs SIG 成員曾搜尋任何我們先前認為對 Sam 有幫助的工作。一整個月，我們發現先前設法更新失敗說明文件的演練。此外，我們也在 Google Opendocs 存放區中逐一介紹說明文件成熟度的稽核資料，
幸好我們獲選為 2021 年文件季、Sam 和 PickleDocs SIG 的獲選，並展開大致的時間表：
| 階段 | 完成者 |
|---|---|
| 查看文件稽核 | 5 月 7 日 |
| 阻礙記錄 3 用途 | 5 月 14 日 |
| 透過 @GloriousPicklePat 和 @BBChips 檢視摩擦力記錄，回答問題 | 5 月 28 日 |
| 更新文件用途的第一個草稿 | 6 月 25 日 |
| 用途 1 草稿是由 @GloriousPicklePat 與 @KimChiCook 審查 | 7 月 2 日 |
| 更新文件用途的第一個草稿 | 7 月 2 日 |
| 用途 2 草稿是由 @GloriousPicklePat 與 @Dillicious 審核 | 7 月 9 日 |
| 更新文件用途的第一個草稿 | 7 月 9 日 |
| 使用案例 3 經過 @Dillicious 和 @KimChiCook 審核 | 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 個小時進行專案。小山留存記錄，每週平均使用 11.5 小時。
成果
什麼是建立、更新或變更？附上已發布文件的連結 (如有)。提案中是否有任何並非建立的可交付項目？請一併列出這些建議。
附有完整使用指南的三個主要用途：
如何將新食材加入 GloriousPickle
如何將變化版本原料新增至 GloriousPickle
如何更新或修正 GloriousPickle 中的食材
這些指南也包含新的提取要求範本，讓貢獻變得更簡單。
此外，在專案期間，Sam 製作了一小筆的 Pickle 詞彙表，並發布在 GloriousPickle 專案網站。
我們已在專案維基中加入更新使用者使用指南的指示。
我們包括為 GitHub 新手的貢獻者製作一覽表，協助他們使用我們的程序和工具。但在瞭解可用資源後，我們可以直接建立另一個專案的一覽表。
指標
您選擇使用哪些指標來評估專案成效？您是否能夠收集這些指標？這些指標是否與你期望的專案成果相關？自您提案後，指標是否有變化？
我們在提案中提出了兩項指標：
- 食材相關提取要求數量
- 新貢獻者提出的提取要求數量
就 9 月 (發布草稿文件後的第一個完整月份) 我們發現食材相關的提取要求 (從 8 月 20 日到 9 月 21 日) 成長 5%，我們會每月追蹤這些指標。
自 1 月 1 日起，我們也會追蹤整體文件發布後，從每季一次貢獻超過三次的貢獻者人數。
說到這些新的說明文件，能促使新的貢獻者加入 GloriousPickle 成份資料庫。在公關發表的註解中提到一名新的貢獻者，他們曾嘗試過但因為不清楚相關程序，卻未完成更新。
分析
您滿意的部分嗎？發生未預期的狀況？你遇到了哪些障礙或失蹤？您認為自己的專案是否成功？原因為何？(如果時間過早，請說明你預計何時能夠判斷專案成效)。
我們很滿意 Google 文件季度專案的結果，也認為這項計畫成功。新的說明文件清楚又實用，我們發現食材相關提取要求的數量及新貢獻者提出的提取要求數量有所成長。
我們也很高興幾乎整個 GloriousPickle 社群因為對原始提案提出意見，並透過草稿表單測試新文件。
我們曾遇到一些意想不到的困難，我們深知 Sam 州的野火並未造成任何其他損害，於網際網路中斷下了！此外，對於失去 @VinegarViv 專案的權限，我們深感遺憾。我們也希望她和她的家人做得最好，希望很快就能再見到她。
在開始製作說明文件前，Sam 都發現了一件事，例如那些在沒有挑選背景的情況下，流傳很多的 Pickle 字詞和縮寫。不過，Sam 收集了一份清單，列出每個不熟悉的字詞，並透過自己的研究定義每個陌生詞，並要求社群成員提供解釋與參考資料。這個 Pickle 詞彙解釋將能有效協助更多人加入 Pickle 社群。
摘要
請用 2 到 4 段文字，概述你的專案體驗。強調您學到的知識，以及您日後打算做出哪些不同的做法。對於想要透過說明文件解決類似問題的其他專案，你有什麼建議？
簡言之，我們的體驗非常完美！我們已取得文件交付項目，且指標似乎與我們的目標相符。
本專案能成功的關鍵在於我們與技術文件撰寫專員 Sam Scribe 合作，[我並未寫下此內容—Sam] 雖然 Sam 對 GitHub 的挑選和經驗沒有背景，但是經驗豐富的技術作家，他們願意深入探索新科目、提問和進行研究。Sam 不僅迅速接起了我們的專案工具 (我們使用看板記錄工作進度)，更迅速點出了心中的趣味笑話！我們很高興 Sam 找到了醃製錯誤，社群中也出現了「瓶頸」的問題。
我們建議其他專案採取下列行動：
- 讓提案保持精簡且易於管理。(我們原本想在提案中納入使用 Estimator 搭配工業批次挑選機械的說明文件，但由於我們其中一個社群成員深入研究開放原始碼挑選機械的製圖，因此撰寫了博士論文。)我們最後有足夠的工作，要讓 Sam 忙得不可開交！
- 尋找技術文件撰寫專員時，善用您的網路。向社群中的所有人尋求建議。雖然我們在 Document GitHub 的季度中發現 Sam，但是在申請期間，我們曾與幾位人進行討論，所以感覺到和他們合作後感覺很有信心。
- 歡迎技術文件撰寫者加入社群！根據 Sam 的案例，瞭解「GloriousPicklers」的熱忱能排除在合適的問題。
- 協助技術撰寫者培養開放原始碼技能。Sam 先前從未使用過 Git，但在完成幾個教學課程後，他們很快就上手。Sam 一開始擔心社群會向社群提供多少意見，以及如何有效運用社群，但社群的「粗略共識」模式 (「共識解決所有問題，卻不一定能達成共識」)，讓 Sam 有信心運用自己的技術寫作能力處理批評。
附錄
如果您想連結其他資料 (例如，您建立了與技術文件撰稿人合作的合約、想要分享的文件範本，或其他開放式文件資源範本，請在這裡列出這些內容並建立連結)。你也可以參閱附錄，列出您所使用文件工具或資源的連結，或是提及可能不適合上述各節說明的內容。
認證
我們的團隊有意認同以下人員與事物：
- @Dillicious 感謝她的伴侶和低傳真嘻哈電台
- @KimChiCook 想感謝他經營的 and 머不滿意
- @Piccalily 感謝芝加哥線上風格線上手冊
- @GherKen 想感謝三位孩子吃各種可調的食物
- @VinegarViv 感謝其他團隊一起努力下班
- @BBChips 要感謝提供最美味的甜筒食物，《Tunnock Caramel Wafers》
- @GloriousPicklePat 感謝 PickleDocs SIG 參與這項專案
- Sam Scribe 想感謝整個 GloriousPickle 社群，尤其是在 2021 年夏天，摘錄放罐罐頭的 Pickers 發文時，開始向許多美味酸菜展開挑戰！