正在创建组织提案

当前阶段
2021 年“文档季”活动已于 2021 年 12 月 14 日结束。请参阅时间轴

您可以将本指南作为模板,创建贵组织的项目提案。

PROPOSAL TITLE - organization name

提案标题应简洁明了。“Update ORGNAME Contributor Guide” 是一个不错的提案标题。“Documentation Improvements”(文档改进)过于笼统;“Update Sections 5,7,23,99 of Contributor Guide, Create FAQ, and Create Style Guide”(更新贡献者指南第 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(ingredient-adding API 的核心维护人员)一直致力于为该项目提供支持。

衡量项目的成效

如何确定新文档帮助您解决了问题?您将使用哪些指标?又将如何跟踪这些指标?

GloriousPickle 平均每季度会收到 10 个拉取请求,用于添加或更新新食材(标记为“ingredient”)。其中大多数拉取请求(超过 60%)来自之前的贡献者。我们相信,经过改进的文档将会带来更多拉取请求,以及更多来自新贡献者的拉取请求。由于我们的大多数积极贡献者都是从添加原材料开始的,因此我们也认为,从总体上来说,改进本文档将会吸引更多积极的贡献者。

该文档发布后,我们将每月跟踪两个指标(与成分相关的拉取请求数量和来自新贡献者的拉取请求数量)。我们还将跟踪总贡献次数超过 3 次的贡献者的数量,从文档发布后开始,每季度进行一次跟踪。

如果新文档发布后,满足以下条件,我们会认为该项目取得了成功:

  • 与原料相关的拉取请求数量增加了 20%
  • 来自新贡献者的拉取请求数量增加了 15%
  • 做出贡献超过 3 次的贡献者数量增加了 10%(从文档发布后的季度开始)

项目预算

常规指南

  • 您可以将预算添加到提案中,也可以将其添加为单独的链接。如果您的预算少于 10 项,我们建议您在提案中添加此信息。
  • 所有预算均应以美元为单位。我们预计补助金额将在 5,000 美元到 15,000 美元之间;如果您的项目超出此范围,请提供更多信息来证明您的预算。
  • 我们希望您将大部分预算(至少 60-70%)分配给负责处理您项目的技术文档撰写者。我们建议您尽可能按项目预算。
  • 我们希望开源项目尽可能使用开源工具;如果您的项目确实需要资金来购买专有软件许可或支持,请提供相应金额的理由。
  • 其他可能的费用包括:
    • 通过设计工作,为文档网站创建品牌信息、徽标、模板或其他设计资源
    • 最低金额(<200 美元)的项目纪念品(为参赛者提供 T 恤或贴纸)。如果您使用 Google 文档季的徽标,则必须带有您的项目或组织徽标或名称。您的纪念品不得使用 Google 这一名称。
    • 为在项目中承担大量指导或引导角色的志愿者提供最低津贴(我们建议每位志愿者的津贴不超过 500 美元)
    • 向其他开源项目的下游捐赠金额不得超过总预算的 10%。
  • 根据需要添加其他预算项目,以及所期望金额的理由。支出理由应重点说明相应支出将如何有助于整个项目的成功。

示例预算

预算项 金额 累积总计 备注/理由
技术编写人员审核、更新、测试并发布了有关 GloriousPickle 添加食材流程的新文档 5,000.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 文档季的工作方式。