当前阶段：
结果已公布。请参阅时间轴。
您可以参考此示例来创建自己的案例研究报告。
PicklePlus：记录 GloriousPickle 贡献工具
组织或项目：Glorious Pickle 点击此处，链接到贵组织或项目的主网站
组织说明：GloriousPickle（当前版本为 1.2.3，首次发布于 2009 年）是一个 MIT 许可库，可轻松计算适用于所有可能的腌菜蔬菜的盐、糖、醋和香料的完美比例，数量从单个小黄瓜到装满集装箱的萝卜不等。
作者：可选：列出案例研究的作者；如有要求，请使用用户名
问题陈述/提案摘要
您尝试通过新文档或改进后的文档解决了什么问题？请提供指向项目网站上提案页面的链接（如果可能）。
向 GloriousPickle 工具的成分数据库添加成分既耗时又复杂，而且该工具没有提供完善的文档。许多有意成为贡献者的用户都没有使用 git 或发出拉取请求的经验。这意味着 GloriousPickle 的成分数据存在严重缺口，导致我们的工具的使用价值降低。通过改进有关添加新食材的文档，我们希望鼓励新贡献者参与并制作更多酸菜！
项目说明
创建提案
您是如何构思 Google 文档季提案的？贵组织是如何确定方案的？您是如何征求和采纳反馈的？
GloriousPickle PickleDocs SIG 通过 Google 开源计划办公室的一条推文了解到了 Google 文档季活动。SIG 在每两周一次的会议中讨论了该计划，并同意制定一份提案。SIG 的两位成员（@KimChiCook 和 @Dillicious）自愿负责起草提案，以便在下次会议中进行审核。
PickleDocs SIG 就提案草稿达成一致后，便向更广泛的项目发送了一封电子邮件，征求反馈。共有 14 位社区成员提供了反馈，其中包括添加食材 API 的维护者 @GloriousPicklePat。@GloriousPicklePat 自愿成为该计划期间的资源提供者。
在讨论并纳入收到的反馈后，该提案已发送给 GloriousPickle 项目指导委员会进行投票。GPPSC 的所有五位成员都投了“赞成”票，同意提交提案和申请，并且 @VinegarViv 同意帮助创建参与该计划和监督付款所需的 Open Collective 账号。
预算
在简介中添加一个简短的预算部分。您是如何估算工作的？是否有意外支出？您最终的支出是否低于补助金额？您是否合理分配了资金？您是否为某些项目预算过多/过少/不必要？您是否有 Google 文档季节以外的其他资金可以使用？
GloriousPickle PickleDocs SIG 中有两位成员曾担任技术文档工程师（一位在欧洲，一位在阿根廷）。他们帮助我们估算工作量并找到类似的项目预算，方法是比较他们之前完成的提案草稿工作。我们还将 2019 年 PicklePals 大会的 1,000 美元无限制赞助金分配给了该项目。
由于我们的技术文案撰写者所在地区受到野火影响，家中断网，因此我们为其支付了租用 Wi-Fi 热点的意外支出。最终，我们向参与者发放的 T 恤数量也比计划少，因此总体上是平衡的。
此外，我们决定向 GloriousPickle 贡献者 @Piccalily 支付补偿，请她帮助技术文档撰写者校对文档。Piccalily 曾是一名专业的校对员。
参与者
谁参与了此项目（如果参与者要求，请使用用户名）？您是如何找到并聘请技术文档撰写者的？您是如何找到其他志愿者或付费参与者的？他们担任着什么角色？有人退出吗？您在招聘、沟通和项目管理方面学到了什么？
负责此项目的核心团队如下：
- @Dillicious、@KimChiCook（PickleDocs SIG）
- @Piccalily（校对）
- @GherKen、@VinegarViv（管理员帮助，GPPSC）
- @BBChips、@GloriousPicklePat（主题专家）
- Sam Scribe（技术文档工程师）
我们通过 Google 文档季 GitHub 代码库列表找到了 Sam Scribe。我们认为他们的经验（Sam 曾在烹饪杂志社工作，也曾为网站撰写文档）与我们的项目非常契合。Sam 加入了 PickleDocs SIG 每两周一次的通话，与我们一起讨论了该项目，并提出了一些非常有价值的建议，我们将这些建议纳入了提案中。我们还通过 SIG 成员的网络联系了另外两位我们认识的技术文档撰写者，但他们在该计划的实施期间都无法提供帮助。
由于 Sam 所在的时区与 PickleDocs SIG 的大多数成员所在的时区只有几个小时的重叠时间，因此我们在讨论论坛中发出了号召，希望在 Sam 所在的时区且熟悉添加成分流程的 Pickler 提供帮助。@BBChips 自愿为 Sam 解答问题，并根据需要帮助他们寻找其他专家。@GloriousPicklePat 还自愿帮助 Sam 了解该工具的底层架构以及 API 可能返回的错误消息，并提供了 GitHub 和 git 方面的帮助。
很遗憾，在该计划进行到一半时，@VinegarViv 因个人原因而不得不退出该项目。GPPSC 成员 @GherKen 挺身而出，负责处理行政和付款问题。
由于 GloriousPickle 使用的是免费的 Slack 实例，有时讨论会非常快，以至于我们会因为滚动归档限制而错过对话，因此我们了解到，应在共享文档（我们使用的是共享 Google 文档）中保留当前问题的列表。PickleDocs SIG 成员会在每次会议前查看该列表，并确保在会议结束前获得答案。Sam 能够直接向 @BBChips 发送消息，询问紧急问题。
我们非常高兴能与 Sam 合作，除了更新 GloriousPickle 文档之外，Sam 自己也成为了一名热衷于使用 pickle 的开发者！
时间轴
简要概述项目的时间表（如果项目正在进行，请指明预计结束日期或中间里程碑）。
在等待 Google 文档季活动公布参与组织期间，PickleDocs SIG 成员搜索了我们认为对 Sam 有用的所有过往工作。在过去一个月里，我们找到了之前更新文档时遗留下的一些备注，还处理了 Google OpenDocs 代码库中部分文档成熟度审核材料。
得知我们入选 Google 文档季的喜讯后，Sam 和 PickleDocs SIG 团队召开了会议，制定了粗略的时间表：
| 阶段 | 完成者 |
|---|---|
| 查看文档审核 | 5 月 7 日 |
| 摩擦日志 3 个用例 | 5 月 14 日 |
| 与 @GloriousPicklePat 和 @BBChips 一起查看摩擦日志，回答查询 | 5 月 28 日 |
| 更新后的文档用例 1 的初稿 | 6 月 25 日 |
| 应用场景 1 草稿已由 @GloriousPicklePat 和 @KimChiCook 审核 | 7 月 2 日 |
| 更新后的文档用例 2 的初稿 | 7 月 2 日 |
| 应用场景 2 草稿已由 @GloriousPicklePat 和 @Dillicious 审核 | 7 月 9 日 |
| 更新后的文档用例 3 的初稿 | 7 月 9 日 |
| 应用场景 3 草稿已由 @Dillicious 和 @KimChiCook 审核 | 7 月 16 日 |
| 针对所有使用情形回答的所有查询 | 7 月 30 日 |
| PickleDocs SIG 的大多数成员于 8 月 1 日至 20 日休假 | -- |
| 开始在社区中测试新文档（文档以草稿的形式发布在 GloriousPickle 网站上） | 8 月 21 日 |
| 纳入了测试反馈 | 9 月 10 日 |
| 新文档的校对和校阅 | 9 月 17 日 |
| 移除了文档的草稿状态，文档正式发布 | 9 月 28 日 |
| 更新创建的文档的流程 | 11 月 1 日 |
| 此案例研究创建 | 11 月 8 日 |
| 已提交案例研究 | 11 月 16 日 |
在提案预算中，我们估算技术文案撰写人员每周会花 10-15 小时来处理我们的项目。Sam 记录了所花时间，平均每周 11.5 小时。
结果
创建、更新或以其他方式更改了哪些内容？添加指向已发布文档的链接（如果有）。提案中是否有任何交付项未创建？也请列出这些。
我们记录了三个主要用例，并提供了完整的用户操作方法指南：
如何向 GloriousPickle 添加新成分
如何向 GloriousPickle 添加变体成分
如何更新或更正 GloriousPickle 中的食材
这些指南还包含新的拉取请求模板，以便更轻松地贡献代码。
此外，在项目期间，Sam 还创建了一个包含他们学到的术语的小型 Pickle 术语表，并将其发布在 GloriousPickle 项目网站上。
我们在项目维基中添加了更新这些用户操作指南的说明。
我们曾考虑为刚开始使用 GitHub 的贡献者创建备忘单，帮助他们使用我们的流程和工具，但在查看可用资源后，我们决定改为分叉其他项目的备忘单。
指标
您选择了哪些指标来衡量项目的成效？您能收集这些指标吗？这些指标与您希望实现的项目成效之间相关性如何？自您提交方案以来，您的指标是否发生了变化？
在我们的提案中，我们提出了两个指标：
- 与成分相关的拉取请求数量
- 新贡献者提交的拉取请求数量
9 月份（自草稿文档发布后的第一个完整月），与成分相关的拉取请求增加了 5%（从 8 月的 20 个增加到 9 月的 21 个），并且有 3 位新贡献者总共发出了 4 个拉取请求（相比之下，8 月份有 2 位新贡献者发出了 2 个拉取请求）。我们计划每月跟踪这些指标。
自 1 月 1 日起，我们还将跟踪总贡献次数超过 3 次的贡献者的数量，并从文档发布后开始按季度统计。
顺便提一下，我们认为，这份新文档有助于新贡献者向 GloriousPickle 成分数据库添加成分。一位新贡献者在其 PR 的评论中提到，他们之前曾尝试过，但由于不了解流程，未能完成更新。
分析
哪些方面做得好？哪些情况出乎意料？您遇到了哪些障碍或挫折？您认为自己的项目取得了成功吗？为什么？（如果还为时过早，请说明您预计何时能够判断项目的成败。）
我们对 Google 文档季项目的成果非常满意，并认为该项目取得了圆满成功。新文档清晰且实用，我们已经看到与成分相关的拉取请求数量和来自新贡献者的拉取请求数量有所增加。
我们还很高兴，几乎整个 GloriousPickle 社区都参与了此次活动，他们对原始提案提供了反馈，并测试了草稿形式的新文档。
我们确实遇到了一些意料之外的障碍，很庆幸 Sam 所在州的野火除了导致互联网中断外，没有造成任何其他损失！此外，我们很遗憾 @VinegarViv 无法继续参与此项目；我们衷心祝福她和她的家人，并希望她能早日康复。
在 Sam 开始编写文档之前，我们没有意识到，对于没有任何与 Pickle 相关背景的新手来说，有许多与 Pickle 相关的术语和缩写词会让他们感到陌生。不过，Sam 特意列出了所有不熟悉的术语，并通过自行研究以及向社区成员寻求解释和参考资料来对这些术语进行定义。未来，这份泡菜术语表将对吸引更多人加入泡菜社区大有帮助。
摘要
在 2-4 段中，总结您的项目体验。重点说明您学到了什么，以及您日后会选择采取哪些不同的做法。对于其他尝试通过文档解决类似问题的项目，您有什么建议？
总而言之，我们的体验非常棒！我们已完成文档交付成果，我们的指标似乎符合我们的目标。
这项项目之所以取得如此大的成功，很大程度上得益于我们有幸与技术文档撰写人 Sam Scribe 合作。[这不是我写的 - Sam] 虽然 Sam 没有任何关于 pickling 的背景知识，也从未使用过 GitHub，但作为一名经验丰富的技术文档撰写者，他们很乐意深入研究新领域、提出问题并进行研究。Sam 不仅很快就掌握了我们的项目工具（我们使用 Kanban 板来跟踪工作），还学会了我们的酸黄瓜笑话！我们很高兴 Sam 发现了这个问题，并在社区中“封装”了它。
我们建议其他项目：
- 提案应尽量简短，以便于管理。（我们原本想在提案中添加有关将估算器与工业批量腌制机械搭配使用的文档，但由于我们的一位社区成员深度参与了开源腌制机械项目，并要在该计划期间撰写博士论文，因此我们最终未在提案中添加该文档。）最后，我们给 Sam 安排了足够多的工作，让他忙得不可开交！
- 在寻找技术文案撰写者时，善用您的人际网络。向社区中的所有人寻求建议。虽然我们是通过 Google 文档季 GitHub 找到 Sam，但由于在申请期间与多位申请者进行了沟通，因此我们对与 Sam 合作充满信心。
- 欢迎技术文档撰写者加入您的社区！Sam 告诉我们，GloriousPicklers 团队的热情周到让她能够轻松提问。
- 帮助技术文档撰写者掌握开源技术。Sam 以前从未使用过 git，但在看了几个教程后，他们很快就上手了。起初，Sam 担心自己能从社区获得多少反馈，以及如何采纳这些反馈，但我们的社区采用“大致共识”模型（“当所有问题都得到解决时，就达成了共识，但不一定能满足所有人”），这让 Sam 有信心利用其技术写作专业知识来回应批评。
附录
如果您有其他要链接的材料（例如，您创建了一份与技术文案撰写者合作的合同，想要分享，或者您有文档项目的模板或其他公开文档资源，可以在此处列出并链接到它们）。您还可以在附录中列出您使用的所有文档工具或资源的链接，或者添加可能不适合放在上述部分的感谢或致谢。
致谢
我们的团队谨在此感谢以下人员和事项：
- @Dillicious 想感谢她的伴侣，以及低保真嘻哈电台
- @KimChiCook 想感谢他的 할머니 教他如何腌制泡菜
- @Piccalily 想感谢 Chicago Manual of Style Online
- @GherKen 想感谢他的三个孩子，因为他们吃光了他做的所有酸菜
- @VinegarViv 想感谢团队的其他成员对其退出团队的理解
- @BBChips 想感谢最好的非泡菜食品，Tunnock 的焦糖威化饼
- @GloriousPicklePat 想感谢 PickleDocs SIG 团队接手此项目
- Sam Scribe 想感谢整个 GloriousPickle 社区，尤其是在 2021 年夏天罐子短缺期间向他们寄送罐子的 Pickler，让他们得以制作出许多美味的酸菜！