正在建立機構提案

目前階段:
已發布個案研究。請參閱時間表

請參考本指南的範本,為貴機構建立專案提案。

PROPOSAL TITLE - organization name

提案標題應簡短明確,「更新 ORGNAME 貢獻者指南」是個不錯的提案標題。「改善文件」太含糊;「更新『貢獻者指南』、『Create 常見問題』和『Create 風格指南』的 5、7、23、99 節」太長。

關於貴機構

請在本節中用幾段簡短的文字介紹貴機構或專案。您的專案解決了什麼問題?您的使用者和貢獻者是誰?貴機構或專案成立至今已有多久時間?提供一些背景資訊,協助我們瞭解為何資助您的提案會對開源和世界產生正面影響。

GloriousPickle (目前版本為 1.2.3,於 2009 年首次發布) 是 MIT 授權的程式庫,可輕鬆計算每種可醃製的蔬菜的鹽、糖、醋和香料的完美比例,從單一小黃瓜到裝滿蘿蔔的容器運輸船,皆可計算。我們的內容提供者是來自世界各地的醃漬食品愛好者,使用者則包括家庭主婦、餐廳主廚,以及大型食品加工公司和機構的物流人員。我們的最大使用者是一家協助食物銀行將保存期限短的蔬菜製成醃漬品,以便餵飽許多社區飢餓的人,並減少食物浪費的組織。此外,使用者也會傳送自選指標,說明他們如何使用 GloriousPickle。我們會利用該資料產生 PickleSet,這是用於透過機器學習建立新醃漬食品食譜的大型資料集。

關於專案

你的專案問題

請說明您的專案將解決哪些問題。為什麼解決這個問題對貴機構或專案很重要?

使用者希望能在 GloriousPickle 工具中新增新香料和其他食材的資訊 (尤其是非歐洲料理的食材)。不幸的是,新增這類資訊的程序並未妥善記錄,這表示潛在的貢獻者必須在專案中提出問題才能取得協助 (或者乾脆放棄)。這個程序也假設貢獻者已熟悉我們的 pull request 程序和 GitHub,但許多使用者並非專業開發人員。

成分資訊越多,GloriousPickle 對所有使用者就越有用!

專案範圍

請告訴我們貴機構將建立、更新或改善哪些文件。如果有部分工作是刻意不執行的,也請一併提供這項資訊。請提供預估時間,並說明是否已找出組織志工和技術撰稿人,以便與您合作進行專案。

GloriousPickle 專案 (代號為 PicklePlus) 將:

  • 稽核現有說明文件,並針對三個主要用途 (新增成分、新增變化版本成分,以及更新或修正成分資訊) 建立目前說明文件的阻礙記錄。
  • 請參考阻礙記錄,瞭解說明文件中的缺失項目,並為主要用途建立更新版說明文件。
  • 建立快速「作弊單」,協助不熟悉提取要求和 GitHub 的貢獻者使用我們的程序。
  • 納入說明文件測試人員 (專案中的志工) 和更廣泛的 GloriousPickle 社群提供的意見回饋。
  • 與發布團隊合作,更新 GloriousPickle 網站上的說明文件,並建立後續同步說明文件與更新工具的程序。

這項專案範圍外的作業:

  • 這個專案不會建立跨連結程序,以便針對同一個成分的不同拼寫方式或名稱建立跨連結。
  • 本專案不會建立任何 GitHub 教學課程,而是會將作弊手冊連結至相關且實用的現有內容。

我們有兩位優秀的技術寫作候選人負責這項專案,並估計這項工作需要三個月才能完成。GloriousPickle PickleDocs SIG 和 @GloriousPicklePat (成分新增 API 的核心維護者) 已承諾支援這個專案。

評估專案成效

如何判斷新文件是否有助於解決問題?您會使用哪些指標,以及如何追蹤這些指標?

GloriousPickle 每季平均會收到十個要求,用於新增或更新新的成分 (標記為「ingredient」)。這些提取要求大多來自先前的貢獻者 (超過 60%)。我們相信,這份改善後的文件會帶來更多提取要求,也能吸引更多新貢獻者提交提取要求。由於大多數的活躍貢獻者都是從新增素材開始,我們認為改善這份說明文件,整體上也能吸引更多活躍的貢獻者。

說明文件發布後,我們將每月追蹤兩項指標 (與成分相關的提取要求數量,以及新貢獻者提交的提取要求數量)。我們也會追蹤有超過三項貢獻的貢獻者人數,從說明文件發布後的季度開始。

在發布新說明文件後,如果符合下列條件,我們會視為專案成功:

  • 與成分相關的提取要求數量增加 20%
  • 新協作者提交的拉取要求數量增加 15%
  • 貢獻次數超過 3 次的貢獻者人數增加 10% (自說明文件發布後的季度開始)

時間軸

您預估這項工作需要多久時間?您能否按月或週細分技術作家的工作?

這個專案本身大約需要六個月才能完成。聘用技術作家後,我們會花一個月時間進行技術作家的訓練,然後開始進行稽核和摩擦記錄,並在最後幾個月專注於製作文件。

日期 動作項目
5 月 方向
6 月至 8 月 稽核現有文件並建立摩擦力記錄
9 月至 10 月 建立說明文件
11 月 專案完成

專案預算

一般指南

  • 您可以將預算納入提案,或以單獨連結的形式提供。如果預算少於十項,建議您在提案中加入這項資訊。
  • 所有預算都應以美元為單位。我們預計補助金額介於$5,000 美元至$15,000 美元之間;如果您的專案超出這個範圍,請提供額外資訊來說明預算。
  • 我們預期大部分的預算 (至少 60-70%) 會分配給負責專案的技術作家。建議您盡可能依專案編列預算。
  • 我們希望開放原始碼專案盡可能使用開放原始碼工具;如果您的專案絕對需要專屬軟體授權或支援的資金,請附上金額的理由。
  • 其他可能的費用包括:
    • 設計工作:為說明文件網站建立品牌、標誌、範本或其他設計素材資源
    • 專案贈品 (提供給參與者的 T 恤或貼紙) 的最低金額 (低於$200 美元)。如果你使用 Google 季節性文件標誌,必須搭配專案或機構的標誌或名稱。你的贈品「不得」使用 Google 這個名稱。
    • 為在專案中擔任大量指導或諮詢角色的志工提供最低津貼 (建議每位志工的津貼不超過 $500 美元)
    • 向其他開放原始碼專案進行的下游捐款,不得超過總預算的 10%。
  • 視需要納入其他預算項目,並說明所需金額的理由。支出理由應強調支出如何有助於整體專案的成功。

預算範例

預算項目 金額 累積總計 附註/說明
技術作家對 GloriousPickle 的成分新增程序進行稽核、更新、測試,並發布新的說明文件 5000.00 5000.00
志工津貼 500 6500.00 3 個志工津貼 x 每個 500 美元
專案 T 恤 (10 件 T 恤) 150.00 6650.00
巨型充氣獨角獸 (15 英尺版本) 99.99 6749.99 我們會將充氣獨角獸贈送給在專案開發期間最快回答技術作家問題的團隊
總計 6749.99

其他資訊

請在此提供與提案相關的任何其他資訊。

  • 曾與技術作家或文件合作的經驗:如果您或任何導師曾與技術作家合作,或曾編寫文件,請在申請中提及這項經驗。說明您產生的文件,以及與技術撰寫者合作的方式。舉例來說,您可以說明所採用的任何審查程序,或是技術作家的技能如何對您的專案有所助益。說明這項先前的經驗如何協助你在 Google 文件季節與技術文件撰寫專員合作。

  • 曾參加 Google 季節性文件、Google 夏季程式或其他計畫:如果您或任何導師曾參加 Google 夏季程式或類似計畫,請在申請中提及這項資訊。說明您在該計畫中取得的成就。說明這項經驗如何影響你在 Google 季節性文件計畫中的工作方式。