目前階段：
2021 年「Docs 季」計畫已於 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 位社群成員提供意見回饋，其中包括成分新增 API 的維護者 @GloriousPicklePat。@GloriousPicklePat 在計畫期間自願擔任資源。
我們討論並採納收到的意見回饋後，已將提案送交 GloriousPickle 專案指導委員會進行投票。GPPSC 的五位成員都投票了 +1 來提交提案和申請，@VinegarViv 也同意協助建立參與計畫及監督款項所需的 Open Collective 帳戶。
預算
加入一小段預算。您如何估算工作量？是否有任何意外支出？你最後的支出是否低於補助金額？你是否有其他可用的資金 (不含 Docs 季節)？
GloriousPickle PickleDocs SIG 的兩位成員曾擔任技術文件撰寫專員 (一位在歐洲，另一位在阿根廷)。他們協助我們估算工作量，並比較他們先前完成的提案草稿，找出相似的專案預算。我們也從 2019 年的 PicklePals 慣例推舉資金，再從這項專案分配到專案的無限制贊助金額中，剩餘了$1,000 美元。
我們技術作家居住的地區受到野火影響，他們家中也失去了網路連線，因此我們支付了他們租用無線基地台的費用，這筆費用屬於非預期支出。我們也向參與者寄送的 T 恤數量比預期少，因此這兩項費用相抵。
此外，我們決定向 GloriousPickle 的作者 @Piccalily 支付酬勞，請她協助校對技術作家撰寫的說明文件。@Piccalily 曾是專業校對人員，現在則是一位醃黃瓜。
參與者
誰參與了這個專案 (如果參與者要求，請使用使用者名稱)？您如何尋找並聘用技術撰稿者？您如何找到其他志工或付費參與者？他們扮演什麼角色？是否有人退出？您在招募、溝通和專案管理方面學到什麼？
負責這個專案的核心團隊如下：
- @Dillicious, @KimChiCook (PickleDoc SIG)
- @Piccalily (校對)
- @GherKen、@VinegarViv (管理員說明，GPPSC)
- @BBChips、@GloriousPicklePat (主題內容專家)
- Sam Scribe (技術撰稿人)
我們是透過 Season of Docs 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 使用者！
時間軸
簡要概述專案時間表 (如果專案仍在進行中，請指出預估結束日期或中間里程碑)。
在等待「Docs 季節」計畫公布參與機構的同時，PickleDocs SIG 成員搜尋了任何我們認為對 Sam 有用的先前作品。在過去一個月，我們發現先前更新說明文件的相關工作停滯不前，因此也查看了 Google opendocs 存放區中部分說明文件成熟度審查資料。
獲悉這個消息後，我們獲選為 2021 賽季的文件、Sam 和 PickleDocs SIG 相見，然後規劃一套粗略的時間表：
| 階段 | 完成者 |
|---|---|
| 查看文件稽核 | 5 月 7 日 |
| Friction 記錄 3 用例 | 5 月 14 日 |
| 與 @GloriousPicklePat 和 @BBChips 一起查看摩擦力記錄，並回答查詢 | 5 月 28 日 |
| 已更新文件用途 1 的第一個草稿 | 6 月 25 日 |
| 由 @GloriousPicklePat 和 @KimChiCook 審查的用途 1 草稿 | 7 月 2 日 |
| 更新文件用途 2 的第一版草稿 | 7 月 2 日 |
| 用途 2 草稿，已由 @GloriousPicklePat 和 @Dillicious 審查 | 7 月 9 日 |
| 更新文件用途 3 的第一版草稿 | 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 小時處理專案。Sam 記錄了花費的時間，平均每週 11.5 小時。
結果
您建立、更新或變更了哪些內容？加入已發布說明文件的連結 (如有)。提案中是否有任何未完成的項目？請一併列出這些資訊。
我們記錄了三個主要用途，並提供完整的使用者操作說明：
如何在 GloriousPickle 中新增成分
如何在 GloriousPickle 中新增變化版本的食材
如何更新或修正 GloriousPickle 中的成分
此外，這些指南也提供新的提取要求範本，方便您做出貢獻。
此外，Sam 在專案期間也建立了 Pickle 詞彙表，其中包含他們學到的詞彙，並在 GloriousPickle 專案網站上發布。
我們新增了操作說明，說明如何在專案維基中更新這些使用者使用指南。
我們準備了一份一覽表，協助新手 GitHub 的貢獻者運用我們的程序和工具。不過，在瞭解可用資源後，我們就能改為建立其他專案的一覽表。
指標
您選擇哪些指標來評估專案成效？您是否能收集這些指標？這些指標是否與您想為專案的目標明確相關？自提案以來，您的指標是否有變化？
在提案中，我們提出了兩個指標：
- 食材相關的提取要求數
- 新貢獻者的提取要求數
在 9 月 (發布草稿文件後的第一個整個月) 與食材相關的提取要求數量增加 5% (8 月 20 日到 9 月的 21 日)，我們發現新貢獻者總共提出了四項提取要求 (相較於 8 月提出兩次提取要求的新貢獻者，約有 2 位)。我們計劃每個月追蹤這些指標。
自 1 月 1 日起，我們也會追蹤整體貢獻超過三次的貢獻者人數，最晚將於說明文件發布後每季開始記錄。
據我們所知，這份新說明文件讓新貢獻者能夠在 GloriousPickle 成分資料庫中新增內容，一位新貢獻者在提交內容的註解中提到，他們先前曾嘗試更新，但因為不瞭解程序而未完成更新。
分析
哪些地方很順利？發生什麼情況？您遇到哪些困難或挫折？您是否認為專案成功？原因為何？(如果目前還無法判斷，請說明您預期何時能夠評估專案成效)。
我們對「Document Season」專案的成果感到非常滿意，並認為這項計畫是成功的。新的說明文件清楚實用，而且與食材相關的提取要求數量也有所增加，新貢獻者提出的提取要求數量也有所增加。
我們也非常高興，幾乎整個 GloriousPickle 社群都參與了這項計畫，針對原始提案提供意見，並測試新版草稿文件。
我們確實遇到了一些意料之外的困難，很高興 Sam 所在州的野火除了造成網路中斷，並未造成其他損失！同時，也很遺憾未能在這項專案中失去 @VinegarViv，希望她和她的家人能永保不已，希望很快就能再見到她。
在 Sam 開始製作說明文件之前，我們都沒發現到，在沒有挑選背景的情況下，某人進入我們的專案時，不太會發現鏈條相關詞彙和縮寫。不過，Sam 特別列出所有不熟悉的術語，並透過個人研究和向社群成員請教，為這些術語下定義，並提供參考資料。這份醃漬食品字典將有助於在日後吸引更多人加入醃漬食品社群。
摘要
用 2 到 4 個段落總結你的專案體驗。強調您學到什麼，以及日後會採取哪些不同的做法。對於其他試圖透過說明文件解決類似問題的專案，您有什麼建議？
簡而言之，我們的經驗非常累人！我們已完成文件提交項目，而且指標似乎符合目標。
這個專案之所以能成功，很大一部分要歸功於我們很幸運地能與技術作家 Sam Scribe 合作。[我沒有寫這段文字，而是 Sam] 雖然 Sam 沒有擷取內容或 GitHub 相關經驗，但身為資深技術作家，他們很樂意深入研究新主題、提出問題和進行研究。Sam 不僅很快就上手我們的專案工具 (我們使用看板追蹤工作進度)，還學會了我們的醃黃瓜笑話！我們很高興 Sam 已修復醃製功能的錯誤，並將錯誤「封裝」在社群中。
我們建議其他專案：
- 提案內容應簡短易懂，(我們原本想在提案中加入說明，說明如何將估算器與工業批次醃製機械搭配使用，但因為社群中一位深度參與開放原始碼醃製機械的使用者，將在計畫期間撰寫博士論文，因此我們沒有加入這份說明)。我們最後有足夠的工作讓 Sam 忙碌！
- 尋找技術作家時，請善用人脈。徵求社群成員的建議。雖然我們是透過 Docs 季節的 GitHub 找到 Sam，但我們在申請期間與幾位參與者交談過，因此對與他們合作感到有信心。
- 歡迎技術文件撰寫專員加入你的社群！Sam 表示，GloriousPickler 團隊的熱情態度讓他很容易提出問題。
- 協助技術作家學習開放原始碼技能。Sam 以前從未用過 Git，但經過幾堂教學課程後，Sam 更快上手。一開始，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 年夏季罐頭瓶短缺時，寄了罐頭瓶給他們，讓他們能製作許多美味的醃漬物！