当前阶段：
文档制作。请参阅时间表。
您可以用本指南作为模板来创建组织的项目提案。
提案标题 - 组织名称
提案标题应简短而具体。“更新 ORGNAME 贡献者指南”是一个不错的提案标题。“文档改进”过于模糊；“更新贡献者指南、创建常见问题解答和创建风格指南的第 5、7、23、99 节”太长。
关于贵组织
在此部分中，请简要说明贵组织或项目。您的项目解决了什么问题？您的用户和贡献者是谁？您的组织或项目存在多长时间？提供一些背景信息，帮助我们了解为什么为您的提案提供资金支持会对开源和世界产生积极影响。
GloriousPickle（现行版本 1.2.3，于 2009 年第一版）是获得麻省理工学院许可的库，能轻松计算每一种可能的腌制蔬菜的完美比例：盐、糖、醋和香料的比例，数量范围从一只小黄瓜到装运货箱的萝卜。我们的贡献者是来自世界各地的泡菜爱好者，我们的用户则是家庭厨师、餐厅厨师，以及为大型食品加工公司和组织从事物流管理的人员。我们最大的用户是一个组织，该组织致力于帮助食物救济所把存货期短的蔬菜制成稳定的泡菜罐，为许多社区的饥饿人群提供食物，减少食物浪费。此外，我们的用户还会向我们发送有关其 GloriousPickle 使用情况的可选指标，我们会用它来生成 PickleSet，这是一个通过机器学习创建新泡菜食谱的大型数据集。
项目简介
您的项目问题
告诉我们您的项目将帮助解决的问题。为什么说解决此问题对您的组织或项目很重要？
用户希望能够向 GloriousPickle 工具中添加有关新香料和其他食材（尤其是非欧洲菜肴的食材）的信息。遗憾的是，添加此信息的过程没有得到很好的记录，这意味着潜在贡献者必须在项目中提出问题以获取帮助（或者他们完全放弃）。该流程还假设贡献者已经熟悉我们的拉取请求流程和 GitHub，尽管我们的许多用户都不是专业开发者。
我们掌握的成分信息越多，对所有用户来说，GloriousPickle 才就越有用！
项目范围
请告诉我们贵组织将创建、更新或改进哪些文档。如果有部分工作故意不完成，也请一并添加这些信息。估算时间，以及是否已确定组织志愿者和负责处理您项目的技术文档工程师。
GloriousPickle 项目（代号为 PicklePlus）将：
- 审核现有文档，并针对三个主要用例（添加新成分、添加变体成分以及更新或更正原料相关信息）创建当前文档的摩擦日志。
- 参照摩擦日志来理解文档中的不足，为常见用例创建更新的文档。
- 创建一份简短的“备忘单”，以帮助刚接触拉取请求的贡献者以及 GitHub 来帮助他们使用我们的流程。
- 整合文档测试人员（项目中的志愿者）以及更广泛的 GloriousPickle 社区的反馈。
- 与发布团队合作，更新 GloriousPickle 网站上的文档，并制定流程以在日后让文档与更新工具保持同步。
此项目之外的工作：
- 此项目不会创建在相同食材的不同拼写或名称之间进行交叉链接的过程。
- 此项目不会创建任何 GitHub 教程；备忘单会链接到相关且有用的现有资料。
此项目有两个优秀的技术文案，预计需要三个月才能完成。GloriousPickle PickleDocs SIG 和 @GloriousPicklePat（成分添加 API 的核心维护者）已承诺为该项目提供支持。
衡量项目成功与否
如何判断新文档是否帮助您解决了问题？您将使用哪些指标？如何跟踪这些指标？
GloriousPickle 平均每个季度会收到十个拉取请求，用来添加或更新新食材（带有“成分”标记）。其中大多数拉取请求 (>60%) 来自之前的贡献者。我们相信，这个改进后的文档将导致更多拉取请求和更多来自新贡献者的拉取请求。由于我们的大多数积极贡献者都是从添加要素开始的，因此我们也认为，改进此文档会提升总体的积极贡献者。
文档发布后，我们每月会跟踪两个指标（与原料相关的拉取请求数量和来自新贡献者的拉取请求数量）。我们还会从文档发布后的每季度开始，跟踪总体贡献超过三项的贡献者的人数。
如果在发布新文档后，该项目符合以下条件，我们将被视为已成功完成此项目：
- 与食材相关的拉取请求数量增加了 20%
- 来自新贡献者的拉取请求数量增加了 15%
- 贡献超过 3 次的贡献者数量增加了 10%（从文档发布的季度起）
时间轴
您认为这项工作需要多长时间？您能按月或按周细分技术文档工程师的任务吗？
该项目本身大约需要 6 个月的时间才能完成。技术撰稿人入选后，我们将花一个月的时间进行技术撰稿人培训，然后进入审核和摩擦日志，最后几个月专注于创建文档。
| 日期 | 操作项目 |
|---|---|
| 5 月 | 方向 |
| 6 月 - 8 月 | 审核现有文档并创建摩擦日志 |
| 9 月至 10 月 | 创建文档 |
| 11 月 | 项目完成 |
项目预算
通用指南
- 您可以在提案中添加预算，也可以将其作为单独的链接添加。如果您的预算少于 10 项，建议您将预算添加到提案中。
- 所有预算均应以美元为单位。我们预计公益金应该从 5,000 美元到 15,000 美元不等；如果您的项目在此范围之外，请提供更多信息来证明预算的合理性。
- 我们预计你的大部分预算（最低 60-70%）会分配给负责你项目的技术文档工程师。我们建议您尽可能按项目制定预算。
- 我们希望开源项目尽可能使用开源工具；如果您的项目确实需要一些资金来购买专有软件许可或支持，请提供相关金额的正当理由。
- 其他可能的费用包括：
- 完成设计作品，为您的文档网站创建品牌宣传、徽标、模板或其他设计资源
- 项目纪念品（参与者的 T 恤或贴纸）最低金额 (<US$200)。如果您使用 Google 文档季徽标，则必须与项目或组织的徽标或名称一起显示。您的纪念品不得使用 Google 这一名称。
- 为在项目中担任大量指导或指导的志愿者提供最低资助（我们建议每位志愿者不超过 500 美元）
- 向其他开源项目的下游捐款不应超过预算总额的 10%。
- 根据需要添加其他预算项，以及要求支出的金额的理由。开支合理性应突出开支将如何影响整个项目取得成功。
示例预算
| 预算项 | 金额 | 累计总计 | 备注/理由 |
|---|---|---|---|
| 技术文档撰写人审核、更新、测试并发布有关 GloriousPickle 成分添加流程的新文档 | 5,000.00 | 5,000.00 | |
| 志愿者补助 | 500 | 6500.00 | 3 笔志愿者补助金 x 500/张 |
| 项目 T 恤（10 件 T 恤） | 150.00 | 6,650.00 | |
| 巨型充气独角兽（15 英尺版） | 99.99 | 6749.99 | 在项目开发期间，我们将把充气独角兽送给团队，让他们能够尽快回答技术文档工程师提出的问题 |
| 总计 | 6749.99 |
更多信息
请在此填写与您的提案相关的所有其他信息。
拥有与技术文档编写人员或文档合作的经验：如果您或任何导师之前与技术文档编写人员合作过，或编写过文档，请在申请中提及这一点。描述您生成的文档以及您与技术文档撰写者合作的方式。例如，说明您使用的任何审核流程，或技术文档工程师的技能对您的项目有何帮助。在 Google 文档季中，解释之前的这段体验如何帮助您与技术文档工程师合作。
之前参加过 Google 文档季、Google 编程之夏或其他活动：如果您或您的任何导师参加过 Google 编程之夏或类似计划，请在申请中提及这一点。说明您在该计划中的成就。说明此次体验可能会如何影响您在 Google 文档季中的工作方式。