目前階段:
已公布結果。請參閱時間表。
請參考本指南的範本,為貴機構建立專案提案。
提案標題 - 機構名稱
提案標題應簡短明確,「更新 ORGNAME 貢獻者指南」是個不錯的提案標題。「改善說明文件」太含糊;「更新貢獻者指南、建立常見問題和建立風格指南的 5、7、23、99 部分」太長。
關於貴機構
請在本節中用幾段簡短的文字介紹貴機構或專案。您的專案解決了什麼問題?您的使用者和內容提供者是誰?貴機構或專案成立至今已有多久時間?請提供一些背景資訊,協助我們瞭解為什麼投入提案能為開放原始碼和世界帶來正面影響。
GloriousPickle (目前版本 1.2.3,在 2009 年首度發行) 是經過 MIT 授權的程式庫,能夠輕鬆針對從單一光料小黃瓜和容器清水等各種可能潛能的可選蔬菜量,計算出適當比例的鹽、糖、醋和香料。我們的內容提供者是來自世界各地的醃漬食品愛好者,而使用者則包括家庭主婦、餐廳主廚,以及大型食品加工公司和機構的物流人員。我們最大的使用者是一個機構,可協助食物銀行將短期的蔬菜變成穩定的醃料罐,幫助許多社區的飢餓人餵食,以及減少食物浪費。此外,使用者也會傳送 GloriousPickle 使用情況的選用指標,我們會利用這些指標產生 PickleSet,這是用於透過機器學習建立新醃漬食品食譜的大型資料集。
關於您的專案
你的專案問題
請說明你的專案能協助解決的問題,解決這個問題對貴機構或專案來說為何重要?
使用者希望能在 GloriousPickle 工具中新增香料和其他食材的資訊 (尤其是非歐洲料理的食材)。很抱歉,我們沒有詳細記錄新增這類資訊的程序,這表示潛在的貢獻者必須在專案中提出問題才能取得協助 (或者乾脆放棄)。雖然許多使用者並非專業開發人員,但這個程序也假設貢獻者已熟悉我們的提取要求程序和 GitHub。
成分資訊越多,GloriousPickle 對所有使用者就越有用!
專案範圍
請告訴我們貴機構將建立、更新或改善哪些文件。如果有部分工作是刻意不執行的,也請一併提供這項資訊。請提供預估時間,並確認貴公司是否有找到合作專案的志工和技術文件撰寫人。
GloriousPickle 專案 (代號為 PicklePlus) 將:
- 稽核現有說明文件,並針對三種主要用途建立當前說明文件的阻礙記錄 (新增食材、新增變化版本食材,以及更新/更正食材相關資訊)。
- 根據阻礙記錄瞭解說明文件中的缺失項目,為主要用途建立更新版說明文件。
- 建立快速「速查表」,協助不熟悉提取要求和 GitHub 的貢獻者使用我們的程序。
- 納入說明文件測試人員 (專案志工) 和更廣泛的 GloriousPickle 社群提供的意見回饋。
- 與發布團隊合作更新 GloriousPickle 網站上的說明文件,並制定日後讓說明文件與更新工具保持同步的程序。
不在這項專案涵蓋範圍內的工作:
- 這項專案不會建立程序,以便針對相同成分的不同拼寫方式或名稱建立交叉連結。
- 這項專案不會建立任何 GitHub 教學課程,而是會將作弊手冊連結至相關且實用的現有內容。
我們有兩位技術寫作專員候選人負責這項專案,預估這項工作需要三個月才能完成。GloriousPickle PickleDocs SIG 和 @GloriousPicklePat (食材加工 API 的核心維護者) 承諾為這項專案提供支援。
評估專案成效
如何確信這份新文件有助於解決您的問題?您會使用哪些指標,以及如何追蹤這些指標?
每季平均收到 10 項提取要求 (標記「食材」);其中大部分提取要求 (>60%) 都來自先前的貢獻者。我們相信,這份改善後的說明文件將帶來更多提取要求,也能吸引更多新貢獻者提交提取要求。由於大多數的活躍貢獻者都是從新增素材開始,我們認為改善這份文件也能吸引更多活躍貢獻者。
說明文件發布後,我們將每月追蹤兩項指標 (與成分相關的提取要求數量,以及新貢獻者提交的提取要求數量)。我們也會追蹤有超過三項貢獻的作者人數,從說明文件發布後的每季開始。
假如你公布了新的說明文件,我們就會認定專案成功:
- 食材相關的提取要求數會增加 20%
- 新協作者提交的拉取要求數量增加 15%
- 貢獻者貢獻次數超過 3 次的數量增加 10% (自說明文件發布後的季度起)
時間軸
您預估這項工作需要多久時間?您能否按月/週細分技術作家的工作?
這個專案本身大約需要六個月才能完成。聘用技術作家後,我們會花一個月時間進行技術作家的訓練,然後開始進行稽核和摩擦記錄,並在最後幾個月專注於製作說明文件。
日期 | 動作項目 |
---|---|
5 月 | 方向 |
6 月至 8 月 | 稽核現有文件並建立摩擦力記錄 |
9 月至 10 月 | 建立說明文件 |
11 月 | 專案完成 |
專案預算
一般指南
- 您可以將預算納入提案,或以單獨連結的形式提供。如果預算少於十項,建議您在提案中加入這項資訊。
- 所有預算都應以美元為單位。我們預計補助金從$5,000 美元到$15,000 美元;如果專案超出這個範圍,請提供額外資訊,證明預算符合預期。
- 我們建議您將大部分預算 (至少 60-70%) 分配給負責專案的技術作家。建議您盡可能依專案編列預算。
- 我們希望開放原始碼專案盡可能使用開放原始碼工具;如果您的專案絕對需要專屬軟體授權或支援的資金,請附上金額的理由。
- 其他可能的費用包括:
- 設計工作:為說明文件網站建立品牌、標誌、範本或其他設計素材資源
- 專案贈品 (提供給參與者的 T 恤或貼紙) 的最低金額 (低於$200 美元)。使用 Google Season of Docs 標誌時,必須加上專案或機構的標誌或名稱。你的贈品不得使用 Google 這個名稱。
- 對於在專案中擔任重要輔導或指導職位的志工,提供最低限度的貼心建議 (每位志工,建議不要超過 $500 美元)
- 向其他開放原始碼專案募得的款項不得超過預算總額的 10%。
- 視需要加入其他預算項目,並說明申請金額的理由。支出理由應強調支出如何有助於整體專案的成功。
範例預算
預算項目 | 金額 | 累積總計 | 附註/說明 |
---|---|---|---|
技術文件撰寫人員稽核、更新、測試及發布新的說明文件,說明 GloriousPickle 的食材新增程序 | 5000.00 | 5000.00 | |
志工津貼 | 500 | NT$19,500 元 | 3 個志工津貼 x 每個 500 美元 |
專案 T 恤 (10 件 T 恤) | 150.00 | NT$19,050 元 | |
巨型充氣獨角獸 (15 英尺版本) | 99.99 | 6749.99 | 在專案開發期間,我們會把燃燒的獨角獸交給團隊,以最快的速度解答技術文件撰寫者的問題 |
總計 | 6749.99 |
其他資訊
請在此加入與提案相關的任何其他資訊。
曾與技術撰稿者或文件相關經驗:如果您或導師曾與技術撰稿者合作或已開發說明文件,請在應用程式中提及這一點。請說明您產生的文件,以及與技術撰稿人合作的方式。例如,請說明你採用的任何審查程序,或是技術撰稿者的技能對你的專案有何助益。請說明先前的經驗,如何 與技術撰寫專員合作,協助您解決「Google 文件」季度作業
曾參與 Google 文件季、Google 程式設計夏令營或其他活動:如果您或任何導師曾參與 Google 程式設計夏令營或類似計畫,請在申請中提及這項資訊。說明您在該計畫中獲得的成就。說明這項經驗如何影響你在 Google 文件季節的表現。