当前阶段：
案例研究已发布。请参阅时间轴。
您可以将本指南作为模板，创建贵组织的项目提案。
PROPOSAL TITLE - organization name
提案标题应简短且具体。“更新 ORGNAME 贡献者指南”是一个不错的提案标题。“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（添加食材 API 的核心维护者）已承诺支持该项目。
衡量项目的成效
您如何知道新文档帮助您解决了问题？ 您将使用哪些指标？如何跟踪这些指标？
GloriousPickle 平均每季度会收到 10 个拉取请求，用于添加或更新新食材（标记为“ingredient”）。其中大多数拉取请求（超过 60%）来自之前的贡献者。我们相信，经过改进的文档将会带来更多拉取请求，以及更多来自新贡献者的拉取请求。由于大多数活跃贡献者都是从添加食材开始的，因此我们还认为，改进此文档将总体上带来更多活跃贡献者。
该文档发布后，我们将每月跟踪两个指标（与成分相关的拉取请求数和来自新贡献者的拉取请求数）。我们还将跟踪总贡献次数超过 3 次的贡献者的数量，从文档发布后开始，每季度进行一次跟踪。
如果新文档发布后，满足以下条件，我们会认为该项目取得了成功：
- 与成分相关的拉取请求数量增加了 20%
- 来自新贡献者的拉取请求数量增加了 15%
- 贡献了 3 次以上内容的贡献者数量增加了 10%（从文档发布后的季度开始）
时间轴
您估计这项工作需要多长时间？您能否按月或按周细分技术编写者任务？
该项目本身大约需要 6 个月才能完成。技术文档撰写人员到位后，我们会花一个月的时间进行技术文档撰写人员入职培训，然后再进行审核和摩擦日志，最后几个月则会专注于创建文档。
| 日期 | 操作项目 |
|---|---|
| 5 月 | 方向 |
| 6 月 - 8 月 | 审核现有文档并创建摩擦日志 |
| 9 月 - 10 月 | 创建文档 |
| 11 月 | 项目完成 |
项目预算
常规指南
- 您可以在提案中添加预算，也可以通过单独的链接添加。如果您的预算少于 10 项，我们建议您在提案中添加预算。
- 所有预算均应以美元为单位。我们预计补助金额将在 5,000 美元到 15,000 美元之间；如果您的项目超出此范围，请提供更多信息来证明您的预算。
- 我们希望您将大部分预算（至少 60-70%）分配给负责处理您项目的技术文档撰写者。我们建议您尽可能按项目预算。
- 我们希望开源项目尽可能使用开源工具；如果您的项目绝对需要专有软件许可或支持资金，请附上相应金额的理由。
- 其他可能的费用包括：
- 为文档网站创建品牌推广内容、徽标、模板或其他设计资源的设计工作
- 项目周边商品（面向参与者的 T 恤或贴纸）的金额不超过 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 文档季的工作方式。