正在建立機構提案

目前階段:
結果公布時程

您可以參考這份指南,建立貴機構的專案提案。

PROPOSAL TITLE - 機構名稱

提案標題必須簡短有力,「更新 ORGNAME 貢獻者指南」是合適的提案標題。「說明文件改善項目」太過籠統;「更新《貢獻者指南》、《建立常見問題》和「建立樣式指南」的第 5、7、23、99 節內容過長。

關於貴機構

請在本節中用短短幾段文字說明貴機構或專案。你的專案解決了什麼問題?誰是使用者和協作者?貴機構或專案存在多久的時間?請提供一些背景資訊,協助我們瞭解為何資助提案可在開放原始碼和世界中發揮正面影響。

GloriousPickle (目前版本 1.2.3,於 2009 年推出第 1 版) 是 MIT 授權的程式庫,能夠輕鬆計算各種可選蔬菜的完美比例,從單一光照木黃瓜,到貨物堆放量皆有。我們的貢獻者是來自全球的 Pickle 愛好者,而我們的使用者是家庭主廚、餐廳廚師,以及大型食品處理公司和機構後勤工作人員。我們規模最大的使用者機構,協助食物銀行將短期的蔬菜轉換成美味的醃菜,協助許多社區的飢餓民眾和「減少食物浪費」。另外,使用者也會將有關他們使用 GloriousPickle 的選用指標傳送給我們,用於產生內含機器學習技術的大型資料集 PickleSet。

關於專案

專案的問題

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

使用者希望能在 GloriousPickle 工具中,加入新香料和其他食材 (尤其是來自非歐洲美食的食材) 的相關資訊。不過,新增這些資訊的程序未詳盡記錄,這表示潛在貢獻者必須先在專案中建立問題,才能尋求協助 (或完全放棄該問題)。儘管許多使用者並非專業開發人員,但這項程序也假設貢獻者已熟悉我們的提取要求程序和 GitHub。

我們掌握的食材越多,對所有使用者的 GloriousPickle 來說就越實用!

專案的範圍

請告訴我們貴機構將建立、更新或改善哪些文件。如有刻意沒有完成的工作,請一併附上相關資訊。附上預估時間,以及是否已找出組織志工和技術文件撰文人員來展開專案。

GloriousPickle 專案 (程式碼名稱為 PicklePlus) 會執行以下動作:

  • 稽核現有說明文件,並針對三個主要用途 (新增食材、新增變化版本食材,以及更新/修正食材相關資訊) 建立現有說明文件的便利記錄。
  • 您可以參考阻礙記錄來瞭解說明文件中的差距,為常見用途製作新版說明文件。
  • 建立快速的「一覽表」,協助剛收到提取要求的貢獻者和 GitHub 的貢獻者,協助他們使用我們的程序。
  • 納入說明文件測試人員 (專案中志工) 和更廣大的 GloriousPickle 社群的意見回饋。
  • 與發布團隊合作,更新 GloriousPickle 網站上的說明文件,並建立流程以便讓說明文件與更新工具保持同步。

本專案不在範圍內的工作:

  • 專案不會為同一個食材的不同拼寫或名稱之間建立交叉連結程序。
  • 這項專案不會建立任何 GitHub 教學課程,而一覽表會連結至相關且有幫助的現有資料。

在這個專案中,我們有兩項擅長的技術撰寫技術,估計工作需要三個月才能完成。GloriousPickle PickleDocs SIG 和 @GloriousPicklePat (ingredient-adding API 的核心維護者) 致力於支援這項專案。

評估專案成功與否

如何得知新的說明文件已幫助您解決問題?你會使用哪些指標?如何追蹤這些指標?

GloriousPickle 每季平均收到十次提出可新增或更新食材 (已標記「ingredient」) 的提取要求數量。這類提取要求大部分 (>60%) 來自先前的貢獻者。我們相信經過改良的文件可以產生更多的提取要求,以及更多來自新貢獻者的提取要求。由於大部分活躍貢獻者都是先加入食材,所以我們也認為改善這份文件的整體活躍貢獻者。

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

我們建議在發布新文件後,將專案視為成功:

  • 食材相關提取要求的數量增加 20%
  • 來自新貢獻者的提取要求數量增加了 15%
  • 貢獻超過 3 次的貢獻者人數增加 10% (從說明文件發布後季度開始)

時間表

預估這項工作需要多少時間?您是否能每月/週次細分科技寫作人員的工作?

專案本身大約需要六個月的時間才能完成。聘僱技術文件人員後,我們會一個月研究「技術文件撰寫者指導」課程,接著進行稽核與阻礙性記錄,最後幾個月會專注於製作說明文件。

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

專案預算

一般原則

  • 您可以在提案中加入預算,也可以另外設定連結。如果您的預算少於 10 項,建議您將預算納入提案。
  • 所有預算都應該以美元計價。我們預期資金範圍從$5,000 美元到$15,000 美元不等;如果您的專案超出這個範圍,請提供其他資訊,證明預算金額。
  • 我們預計會將您大量的預算 (最低 60% 到 70%) 分配給處理專案的技術撰寫專員。建議您盡可能為每個專案設定預算。
  • 我們期望開放原始碼專案能夠採用開放原始碼工具。如果您的專案絕對需要專屬軟體授權或支援服務的資金,請註明金額的理由。
  • 其他可能的費用包括:
    • 設計文件來為說明文件網站建立品牌宣傳、標誌、範本或其他設計資源
    • 提供給參與者的專案贈品 (<$200 美元) 最低金額 (<US$200)。如果您使用文件季別標誌,必須一併加上專案或機構的標誌或名稱。你的贈品可能不會使用 Google 名稱。
    • 適用於參與重要指導或專案指導的志工,可說是最輕微的小費 (建議每位志工不要超過 $500 美元)
    • 捐給其他開放原始碼專案的下游捐款不得超過總預算的 10%。
  • 視需要加入其他預算項目,以及購物金額的理由。成本理由應強調支出如何影響專案整體的成功。

範例預算

預算項目 金額 累積總計 附註/正當理由
技術文件撰寫專員稽核、更新、測試及發布新文件,說明 GloriousPickle 的食材添加程序 $5000.00 美元 $5000.00 美元
志工流產 500 6500.00 3 位自願者 x 每個 500 人
專案 T 恤 (10 件 T 恤) 150.00 6,650.00
巨大充氣獨角獸 (15 英尺版本) 99.99 歐元 在專案開發期間,我們將把充氣獨角獸的團隊
總計 歐元

其他資訊

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

  • 以往的技術撰寫者或說明文件經驗:如果您或任何導師先前曾與技術撰寫專員合作,或已開發說明文件,請在應用程式中提及這一點。請說明您產生的說明文件,以及您與技術文件撰寫專員合作的方式。例如,說明您使用的任何審查流程,或是技術撰寫者的技能對您的專案有何幫助。請說明過往的經驗 如何協助您在文件季的 技術文件撰寫專員上交談

  • 先前參加《Google Summer of Code》或其他活動的季別:如果您或任何導師已參加 Google Summer of Code 或類似的計畫,請在應用程式中提及這一點。請描述您在該計畫中的成就。請說明本次體驗如何影響您在《文件季》的工作方式。