当前阶段：
文档制作。请参阅时间表。
借助此示例，您可以创建自己的案例研究报告。
PicklePlus：记录 GloriousPickle 贡献工具
组织或项目：点击链接，点击此处可找到贵组织或项目的主网站
组织说明：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 的五名成员都投了 +1 票，决定提交提案和申请，并且 @VinegarViv 同意帮助创建 Open Collective 帐号，参与该计划并监督付款情况。
预算
在预算中添加一个简短的部分。您是如何估算完成工作的？是否存在任何意外费用？您最后的支出是否少于奖励金？您是否正确分配了资金，或者您是否为某些项目设置了更多/更少/不必要的预算？除了 Google 文档季之外，您还有其他可以使用的资金吗？
GloriousPickle PickleDocs SIG 的两名成员曾担任技术文档工程师（一位在欧洲，一位在阿根廷）。他们通过比较之前完成的提案草稿工作，帮助我们估算了工作，找到了相似的项目预算。我们还将 2019 年 PicklePals 大会上分配给项目的无限制赞助资金，剩余 1,000 美元。
我们的技术文档工程师在受野火影响的区域因家中失去了互联网访问权限而支付了一笔意外费用，帮助他们租借了一个 Wi-Fi 热点。最终，我们向参与者发放的 T 恤数量比计划要少，因此两者均衡。
此外，我们还决定为 GloriousPickle 贡献者 @Piccalily 提供报酬，她曾在非 Pickle 生活中曾经是一位专业的文案编辑，以帮助进行文案编辑和校对技术文档撰写人创建的文档。
参与者
此项目的工作人员（如果参与者要求，请使用用户名）？您是如何找到并聘请技术文档工程师的？您是如何找到其他志愿者或付费参与者的？他们担任了哪些角色？有人中途离开了吗？您对招聘、沟通和项目管理学到了什么？
参与此项目的核心团队是：
- @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 时区并熟悉原料添加流程的 Picklers 发送了电话信息。@BBChips 已自愿为 Sam 回答问题，并在必要时帮助他们寻找其他专家。@GloriousPicklePat 也志愿帮助 Sam 了解该工具的底层架构以及 API 可能产生的错误消息，并提供了 GitHub 和 Git 帮助。
遗憾的是，在参与计划的中途，@VinegarViv 出于个人原因不得不退出项目。GPPSC 成员 @GherKen 主动处理管理和付款问题。
在一些遗漏的问题（GloriousPickle 使用免费的 Slack 实例，有时，由于滚动归档限制，讨论进展太快，以至于我们因滚动归档限制而丢失对话）后，我们了解到应该将正在运行的问题列表保存在共享文档中（我们使用共享的 Google 文档）。PickleDocs SIG 成员在每次会议前都进行了检查，并确保在会议结束前获得解答。Sam 可以就紧急问题直接联系 @BBChips。
我们非常高兴地与 Sam 和 Sam 合作，除了更新 GloriousPickle 文档，他们自己也成为了狂热的选择器。
时间轴
简要介绍项目的时间表（如果项目仍在进行，请注明预计结束日期或中间里程碑）。
在我们等待 Google 文档季计划公布参与组织期间，PickleDocs SIG 成员搜索了我们认为对 Sam 有用的所有以往作品。在一个月内，我们发现了之前在更新停滞不前的文档时提供的一些备注，我们还研究了 Google Opendocs 代码库中的文档成熟度审核材料的部分内容。
我们获选参加 Google 文档赛季后，Sam 和 PickleDocs SIG 会面，并制定了一份粗略的日程安排：
| 阶段 | 完成者 |
|---|---|
| 查看文档审核日志 | 5 月 7 日 |
| 摩擦日志 3 用例 | 5 月 14 日 |
| 使用 @GloriousPicklePat 和 @BBChips 审核摩擦日志，解答查询 | 5 月 28 日 |
| 更新后的文档用例 1 的第一个草稿 | 6 月 25 日 |
| 由 @GloriousPicklePat 和 @KimChiCook 审核用例 1 草稿 | 7 月 2 日 |
| 更新后的文档用例 2 的第一个草稿 | 7 月 2 日 |
| 由 @GloriousPicklePat 和 @Dillicious 审核用例 2 草稿 | 7 月 9 日 |
| 更新后的文档用例 3 的第一个草稿 | 7 月 9 日 |
| 由 @Dillicious 和 @KimChiCook 审核的用例 3 草稿 | 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 项目网站上。
我们在项目 Wiki 中添加了关于更新这些用户方法指南的说明。
我们曾为 GitHub 新用户创建备忘单，帮助他们使用我们的流程和工具，但在查看可用资源后，我们就可以复制另一个项目的备忘单。
指标
您选择了哪些指标来衡量项目成效？您能否收集这些指标？指标与项目预期成效的相关程度是好是差？自提案推出以来，您的指标是否发生了变化？
在我们的方案中，我们提出了两个指标：
- 与食材相关的拉取请求数量
- 来自新贡献者的拉取请求数量
在 9 月份（自草稿文档发布第一个整月）中，与原料相关的拉取请求增加了 5%（从 8 月 20 日到 9 月 21 日），有 3 位新贡献者总共发出了 4 个拉取请求（有 2 位新贡献者在 8 月份发出了 2 次拉取请求）。我们计划每月跟踪这些指标。
从 1 月 1 日开始，我们还将跟踪总体贡献超过三项的贡献者数量，从文档发布后的每季度开始。
有趣的是，我们相信这个新文档让新的贡献者能够向 GloriousPickle 食材数据库中添加内容，从而发挥了重要作用。他们的 PR 评论中提到，一位新贡献者曾经尝试过，但由于不了解流程而未完成更新。
分析
哪些方面表现较好？有什么意外情况？您遇到了什么困难或挫折？您是否认为自己的项目成功？为什么？（如果现在说还为时过早，请说明您预计何时能够判断项目成功与否。）
我们对“Google 文档季”项目的成果非常满意，并认为该项目取得了成功。新文档清晰明了且很有帮助，并且我们已经看到与原料相关的拉取请求数量和来自新贡献者的拉取请求数量有所增长。
此外，通过针对原始提案提供反馈并测试草稿形式的新文档，几乎整个 GloriousPickle 社区都积极参与其中，我们也感到非常高兴。
我们确实遇到了一些意想不到的障碍 — 我们很庆幸 Sam 所在州的野火没有比互联网服务中断更严重！此外，对于从项目中失去 @VinegarViv 的资格，我们深表遗憾；祝她和她的家人一切顺利，希望很快能再次见到她。
在 Sam 开始编写文档之前，我们没有意识到，在没有匹克背景的情况下，进入我们的项目的人会不熟悉有多少与泡菜相关的术语和首字母缩写词。不过，Sam 重点列出每个不熟悉的术语，并通过自己的研究和请社区成员进行解释和引用来对它们进行定义。这份 Pickle 术语库对于未来欢迎更多人加入 Pickle 社区有很大帮助。
摘要
用 2-4 个段落总结您的项目经验。重点强调您学到的知识，以及您日后会选择改变哪些做法。对于试图利用文档解决类似问题的其他项目，您有什么建议？
简而言之，我们的经历太难了！我们实现了文档交付，并且各项指标似乎符合我们的目标。
这个项目之所以取得成功，很大程度上是因为我们能够与技术文档工程师 Sam Scribe 合作，这让我们十分幸运。[我没有写这封 - Sam] 虽然 Sam 没有匹克开发背景或 GitHub 相关经验，但作为一名经验丰富的技术文档撰写人，他们能够游刃有余地深入了解新学科、提出问题和开展研究。Sam 很快学会了我们的项目工具（我们用看板来跟踪工作进展），还学到了我们的泡菜笑话！我们非常高兴 Sam 捕获了这种腌菜，而且我们已经在社区中将它们“装入瓶装”。
我们建议其他项目执行以下操作：
- 提案内容要简短且易于管理。（我们最初希望在提案中添加关于将估算器与工业批量腌制机械结合使用的文档，但之所以没这么做，是因为在计划期间，我们有一位深入参与开源匹克机械的社区成员正撰写她的博士论文。）我们工作量过大，让 Sam 忙得停不下来！
- 寻找技术文档工程师时，充分利用您的人脉网络。向社群中的所有人寻求建议。尽管我们通过 Google 文档 GitHub 季找到 Sam，但我们仍然对与他们合作充满信心，因为我们在申请期间与多位用户进行了交流。
- 欢迎技术文档工程师加入您的社区！Sam 告诉我们，GloriousPicklers 非常热情，大家很容易提问。
- 帮助您的技术文档工程师掌握开源技能。Sam 以前从未使用过 Git，但在学习了几个教程后，他们很快就上手了。起初，Sam 担心他们可能会从社区得到多少反馈以及如何吸收这些反馈，但通过我们社区的“粗略共识”模型（所有问题都得到解决，即可达成共识），让 Sam 信心十足地利用自己的技术专长来解决批评问题。
附录
如果您想要链接其他材料（例如，如果您针对与技术文档撰写人员合作而创建了合同，并愿意分享该合同、文档项目的模板或其他开放的文档资源，可以在此处列出并链接到这些资源）。您同样可以在附录中列出您使用过的任何文档工具或资源的链接，或者添加可能不适用于上述各节的致谢或致谢的位置。
致谢
我们的团队衷心感谢以下人员和物品：
- @Dillicious 想要感谢她的伴侣和低保真嘻哈音乐电台
- @KimChiCook 感谢他教会了泡菜
- @Piccalily 想感谢 Chicago Manual of Style Online 的著作
- @GherKen 想感谢他的三个孩子吃了他做的所有泡菜
- @VinegarViv 感谢团队其他成员对她退休的积极配合
- @BBChips 致敬 Tunnock's Caramel Wafers，不吃美味披萨
- @GloriousPicklePat 衷心感谢 PickleDocs SIG 参与此项目
- Sam Scribe 想要感谢整个 GloriousPickle 社区，特别是在 2021 年夏季罐头短缺期间给他们寄送罐头的选择器，让他们开始品尝美味的泡菜！