当前阶段:
公布的结果。请参阅时间轴。
请使用本指南作为模板来创建组织的项目提案。
提案名称 - 组织名称
提案标题应简短而具体。“更新 ORGNAME 贡献者指南”是一个不错的提案标题。“文档改进”过于含糊;“更新贡献者指南、创建常见问题解答和创建风格指南的第 5、7、23、99 节”太长。
关于贵组织
在此部分中,请以几段简短的文字介绍您的组织或项目。您的项目解决什么问题?您的用户和贡献者是谁?您的组织或项目存在多久了?提供一些背景信息,帮助我们了解为何为您的提案提供资金支持会对开源项目和世界产生积极影响。
GloriousPickle(当前版本 1.2.3,于 2009 年发布的第一版)是获得麻省理工学院许可的库,用于轻松计算每种可能的腌蔬菜的盐、糖、醋和香料的完美比例,数量范围从单一的单独黄瓜到集装箱小黄瓜不等。我们的贡献者包括世界各地的泡菜爱好者,我们的用户是家庭厨师、餐厅厨师,以及为大型食品加工公司和组织从事物流管理的人员。我们最大的用户是一个组织,该组织帮助食物救济所把保质期短的蔬菜变成稳定的泡菜,帮助许多社区的饥饿人群吃饭,并减少食物浪费。此外,我们的用户还向我们发送了关于其使用 GloriousPickle 的可选指标,我们用它来生成 PickleSet,这是一个通过机器学习创建新 Pickle 配方的大型数据集。
项目简介
项目的问题
告诉我们您的项目将帮助解决的问题。为什么解决这个问题对您的组织或项目很重要?
用户希望能够将有关新香料和其他食材的信息(尤其是非欧洲美食的食材)添加到 GloriousPickle 工具中。遗憾的是,添加这些信息的过程并未得到很好的记录,这意味着潜在贡献者必须在项目中提出问题以获取帮助(或者他们干脆放弃)。该流程还假定贡献者已熟悉我们的拉取请求流程和 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 月 | 项目完成 |
项目预算
通用指南
- 您可以在提案中添加预算,也可以将其作为单独的链接添加。如果您的预算少于 10 项,我们建议将其加入您的提案。
- 所有预算均应以美元为单位。我们预计拨款范围为 5000 美元至 15000 美元;如果您的项目不在此范围内,请提供更多信息来证明您预算的合理性。
- 我们预计您的大部分预算(最低 60-70%)会分配给负责您项目的技术文档工程师。建议您尽可能按项目制定预算。
- 我们希望开源项目尽可能使用开源工具;如果您的项目确实需要一些资金用于专有软件许可或支持,请说明金额的正当理由。
- 其他可能的费用包括:
- 完成设计作品,为您的文档网站创建品牌宣传、徽标、模板或其他设计资源
- 项目纪念品(参与者的 T 恤或贴纸)的最低金额(<US$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 文档季的方式产生什么影响。