正在建立機構提案

目前階段:
2021 年「Docs 季」計畫已於 2021 年 12 月 14 日結束。請參閱時間表

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

PROPOSAL TITLE - organization name

提案標題應簡短明確,「更新 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 的核心維護者) 已承諾支援這個專案。

評估專案成效

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

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

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

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

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

專案預算

一般指南

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

預算範例

預算項目 金額 累積總計 附註/說明
技術文件撰寫人員稽核、更新、測試及發布新的說明文件,說明 GloriousPickle 的食材新增程序 5000.00 5000.00
志工津貼 500 6500.00 3 個志工津貼 x 每個 500 美元
專案 T 恤 (10 件 T 恤) 150.00 NT$19,050 元
大型充氣獨角獸 (15 英尺版本) 99.99 6749.99 在專案開發期間,我們會把燃燒的獨角獸交給團隊,以最快的速度解答技術文件撰寫者的問題
總計 6749.99

其他資訊

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

  • 曾與技術撰稿者或文件相關經驗:如果您或導師曾與技術撰稿者合作或已開發說明文件,請在應用程式中提及這一點。請說明您產生的說明文件,以及與技術文件撰寫人員合作的方式。例如,請說明你採用的任何審查程序,或是技術撰稿者的技能對你的專案有何助益。說明這項先前經驗如何協助你在 Google 文件季節與技術文件撰寫專員合作。

  • 曾參與「Docs 季節」、「Google 夏季程式碼」或其他計畫:如果您或任何導師曾參與 Google 夏季程式碼或類似計畫,請在申請中提及這項資訊。說明您在該計畫中的成就。說明這項經驗如何影響你在 Google 文件季節的表現。