正在建立機構提案

當前階段:
說明文件開發。請參閱時間表

請將這份指南當做範本,並著手製作貴機構的專案提案。

提案標題 - 機構名稱

提案標題應簡短明確,「更新 ORGNAME 貢獻者指南」是不錯的提案標題。「說明文件改善項目」內容過於籠統;「貢獻者指南、建立常見問題和建立風格指南的第 5,7,23,99 節」內容太長。

關於貴機構

請在本節中簡單說明您的機構或專案,你的專案能解決什麼問題?您的使用者和貢獻者是誰?貴機構或專案存在多久了?提供一些背景資訊,協助我們瞭解為什麼資金能為開放原始碼和世界帶來正面影響。

GloriousPickle (目前版本 1.2.3,2009 年首次發布) 是 MIT 授權的圖書館,可輕鬆為各種可能的可醃蔬菜 (從單一單向小黃體到容器船載物) 計算其完美的鹽值,例如鹽、糖、醋與香料。我們的貢獻者是來自全球各地的精選愛好者,使用者是家庭主廚、餐廳主廚,以及為大型食品加工公司和機構工作的物流人員。我們最大的使用者是一間機構,協助食品銀行將生活短缺的蔬菜變成穩定的醃黃瓜,協助在許多社區為飢餓的民眾提供糧食,並減少食物浪費。此外,使用者將關於他們使用 GloriousPickle 的選用指標傳送給我們,我們使用這些資料產生 PickleSet。這個大型資料集透過機器學習建立新料理的醃製食譜。

關於您的專案

專案問題

請告訴我們你的專案能協助解決的問題。為什麼貴機構或專案必須解決這個問題?

使用者希望能在 GloriousPickle 工具新增香料和其他食材 (尤其是非歐洲美食的食材) 的相關資訊。很抱歉,新增這項資訊的流程並未詳盡,因此潛在協作者必須在專案中提出問題,才能取得協助 (或完全放棄)。此外,這個程序也假設貢獻者已熟悉我們的提取要求程序和 GitHub,但許多使用者並非專業開發人員。

我們擁有的資訊越多,對所有使用者來說 GloriousPickle 就越實用!

專案範圍

請告訴我們貴機構要建立、更新或改進的文件。如果有某些作業刻意未完成,請一併附上相關資訊。請附上預估時間,並確認您是否已指明瞭機構組織志工和技術撰稿人來完成專案。

GloriousPickle 專案 (代號為 PicklePlus) 將執行以下動作:

  • 稽核現有說明文件,並針對三個主要用途建立現行說明文件的阻礙,例如新增食材、新增變化版本食材,以及更新或更正食材資訊。
  • 請使用摩擦記錄來解讀說明文件中的落差,建立有關主要用途的新版說明文件。
  • 快速建立「一覽表」,協助初次提取要求的提供者和 GitHub 運用我們的程序。
  • 整合文件測試人員 (專案中志工) 和更廣泛的 GloriousPickle 社群的意見回饋。
  • 與發布團隊合作更新 GloriousPickle 網站上的說明文件,並建立相關程序,確保日後文件與更新工具保持同步。

超出這項專案的工作範圍:

  • 這項專案不會為相同的食材建立不同的拼字或名稱交叉連結程序。
  • 這項專案不會建立任何 GitHub 教學課程,而是將連結至相關且實用的現有教材。

我們有兩名優秀的技術人員要參與這項專案,預估這項工作需要三個月才能完成。GloriousPickle PickleDoc SIG 和 @GloriousPicklePat (ingredient-adding API 的核心維護人員) 已致力於支援這項專案。

評估專案是否成功

如何得知新的文件解決了問題?您會使用哪些指標?該如何追蹤這些指標?

GloriousPickle 每季平均收到十個有關新增或更新食材 (標記為「成分」) 的提取要求。這些提取要求 (>60%) 大部分來自先前的貢獻者。我們認為這份改良版說明文件將帶來更多提取要求,並增加新貢獻者的提取要求。大部分的活躍貢獻者都先新增食材,因此我們也認為改進這份說明文件的做法,能吸引更多積極參與的觀眾。

我們會在說明文件發布後,每個月追蹤兩項指標 (與食材相關的提取要求數和新協作者提出的提取要求數)。文件發布後,我們也會追蹤整體貢獻超過三次的貢獻者人數。

我們發布新的說明文件後,只要以下行為,我們就會認定專案成功:

  • 與食材相關的提取要求數量增加 20%
  • 新貢獻者的提取要求數量增加 15%
  • 貢獻超過 3 次的貢獻者數量會增加 10% (自文件發布後一季起算)

時間軸

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

專案本身大約需要六個月的時間才能完成。聘僱技術人員後,我們會花一個月在技術撰寫人員的職位上講解技術撰寫人員的職位,然後繼續進行稽核與改善記錄,最後花費幾個月的時間專注於建立說明文件。

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

專案預算

一般原則

  • 您可以在提案中加入預算,也可以另外提供連結。如果您的預算少於 10 個項目,建議您將其納入提案。
  • 所有預算都應以美元為單位。我們預計補助金額會介於$5,000 美元到$1,5,000 美元之間;如果您的專案不在這個範圍內,請提供其他資訊,證明您的預算合理性。
  • 我們預計將大量預算 (最低 60-70%) 分配給處理專案的技術撰稿人。如果可以,建議您根據專案逐一編列預算。
  • 我們期望開放原始碼專案盡可能使用開放原始碼工具。如果您的專案極需付費購買專屬軟體授權或支援,請附上這筆費用的理由。
  • 其他可能的費用包括:
    • 精心設計工作,為您的說明文件網站建立品牌宣傳內容、標誌、範本或其他設計資產
    • 將專案贈品 (參與者專屬的 T 恤或貼紙) 納入最低金額 (<US$200)。使用 Google 文件季別的標誌時,必須搭配您的專案或機構標誌或名稱。您的禮物「不得」使用 Google 的名稱。
    • 針對專案中擔任重要輔導或指導職務的志工,只需支付極少費用即可 (建議每位志工不要超過 $500 美元)
    • 其他開放原始碼專案的下游捐款金額不得超過預算總額的 10%。
  • 視需要加入其他預算項目,並說明要求的金額。成本合理化應突顯出支出對專案整體成效的貢獻。

範例預算

預算項目 金額 累積總計 附註/理由
技術撰寫人員稽核、更新、測試並發布 GloriousPickle 食材新增程序的新說明文件 $5000.00 美元 $5000.00 美元
志工服務 500 $6,500.00 美元 3 位志工個人資料各 500 位
專案 T 恤 (10 件 T 恤) NT$4,500 元 $6650.00 美元
大型充氣獨角獸 (15 英尺版本) 99.99 歐元 在專案開發期間,我們會把出現充氣的獨角獸交給團隊,以最快的速度回答技術作家的問題
總計 歐元

其他資訊

在這裡加入與提案相關的任何其他資訊。

  • 過去技術撰寫人員或說明文件的經驗:如果您或任何導師曾與技術撰稿人合作,或已開發過文件,請在申請表內提及。說明您產生的文件,以及與技術寫入者合作的方式。例如,描述您使用的任何審查流程,或是技術撰寫人員的技能對您的專案有何助益。請說明以往的經歷如何協助您 在 Google 文件季度中與技術撰稿人合作。

  • 曾參加 Google 季節性文件、Google Summer of Code 等活動:如果您或任何導師已參加 Google Summer of Code 或類似計畫,請在申請書中提及這點。說明您在該計畫中的成就。請說明這項經驗可能會影響您在 Google 文件季中工作的方式。