当前阶段：
文档制作。请参阅时间表。
Season of Google 文档是由 Google 开源计划办公室管理的可持续发展计划。文档季的目标是：
- 为开源项目提供支持，以利用文档解决项目问题
- 为技术文档撰写人提供获得开源经验的机会
- 提高对开源、文档和技术写作的认知度
- 在开源文档中收集和分享有效指标的相关信息
如需详细了解《文档》季，请访问该计划的网站。
2022 年计划概览
Season of Google 文档的运作方式
在文档季中，组织通过提交项目提案进行申请。项目提案包括：
- 组织的相关信息
- 对项目所遇问题的说明
- 项目将如何利用文档来帮助解决他们的问题
- 项目如何衡量其文档的效果（指标）
- 工作时间表
- 项目预算
- 任何其他信息，例如组织参与类似计划的经验，或有助于文档季管理员了解其项目和问题的任何其他信息
一旦获准加入此计划，组织就会直接招聘和聘用自己的技术文档工程师。Season of Google 文档使用 Open Collective 为组织提供资金，而组织则通过 Open Collective 向技术文档撰写者支付费用。项目预算和付款公开透明；预算包含在 Season of Google 文档季网站上提供的组织项目提案中，而且付款可在 Season of Google 文档 Open Collective 帐号中查看。
提交案例研究报告的组织即视为已成功完成该计划。各组织还需要在计划期间完成每月评估，在项目完成后的一年内完成三次季度跟进调查。
2022 年亮点
“新文档发布后，Casbin 和 Casdoor 的每日访问量几乎翻了一番，跳出率降低了约 30%。”- Casbin
“这个项目的成功成果一直是 [我们的技术文档工程师] 成长为我们社区中的领导角色。现在，这两位贡献者都负责领导工作组和社区会议，并为项目的设计和维护工作贡献力量。”-moja-global
“[GSoD] 帮助我们招募了两位才华横溢的技术文档工程师，这在日常工作中非常困难，他们仍然是 OpenMined 的活跃操作系统贡献者，并且与我们合作的体验都很出色。”- OpenMined
“此外，对于计算质谱的新手而言，这份新手册要简单得多。举例说明：CZI 补助金还为历史上的贫困个人提供补助，一些获奖者使用新版 OpenMS 手册开始了为期六周的实习期，并且对新手册给予了正面评价。”—OpenMS
2022 年摘要数据
2022 年，“文档季”计划接受了 67 个申请中的 31 个项目，有 30 个项目成功完成了该计划。在接受的 31 个组织中，有 17 个组织是重复申请者。
入选的 31 个项目聘请了 58 名技术文档工程师。超过 190 名技术文档作者在“Season ofDocs”GitHub 代码库中添加他们的联系信息和作品集链接，表明他们有兴趣参与该计划。
对于 2022 年计划：
- 100% 的组织在申请流程方面都获得了积极的体验
- 100% 的组织曾在计划网站文档/内容方面都获得了积极的体验
- 93% 的组织曾体验过该计划
- 90% 的组织认为其文档项目取得了成功
组织简介
参与 2022 文档赛季的组织代表了各种各样的开源项目。2022 年的同类群组包括：
- 开发工具，例如 AsyncAPI 和 SpyderIDE
- 编程语言和框架，例如 Julia、LFortran、R 和 p5.js
- 科学项目，例如 CERN-HSF 和 SymPy
- 最终用户应用，例如 Mautic、Open Food Facts、Talawa 和 Ushahidi
- 硬件和机器人项目，例如 ExpressLRS 和 Open-RMF
- 数据项目，例如 GeomScale、GeomStats、OpenMined 和 Weaviate
- 云和基础架构项目，例如 cert-manager、NimbleEdge 和 Cilium
我们没有收集关于项目的任何元数据（例如，创立日期、贡献者的地理分布、贡献者数量或用户群规模）。
我们要求项目指明它们使用的开源许可。
文档项目简介
文档问题
组织希望通过 2022 年计划中的文档解决的主要问题包括：
请注意，组织可能会报告多个文档问题。如需了解详情，请参阅 2022 年 Google 文档赛季结果页面，其中提供了每个组织的原始项目提案和完整案例研究的链接。
创建的文档类型
HowTo 文档是 2022 年案例研究中最常提及的文档类型。
案例研究中提及的其他文件类型包括：
- 快速入门
- 术语库
- 常见问题解答
- 知识库
- 组件
- 博客/社交媒体内容
- 维护者指南
其中一些类别不明确，并且单个文档项目可能包含多种文档类型或功能。
如需了解详情，请参阅 2022 年 Google 文档赛季结果页面，其中提供了每个组织的原始项目提案和完整案例研究的链接。
预算
平均预算请求为 11,679 美元，中位数为 12,150 美元。有 5 个组织申请的赠与金额最高（1.5 万美元），其中三个组织申请了最低赞助金额（5,000 美元到 7,000 美元之间）。
指标
案例研究中介绍的项目是他们用来衡量文档项目成功与否的指标。
建议最多的指标包括：
建议的其他指标包括：
- 更多文档拉取请求/贡献
- 在文档页面上提供更直接的反馈
- 页面停留时间
- 引发的问题（作为使用的代理）
- 论坛的参与者
- 合作伙伴/志愿者/集成人数
- 跳出率降低
- 提升了在社区中的认知度。
由于从完成技术写作项目到提交案例研究之间的时间很短，因此大多数 2022 年的同类群组在提交案例研究时都无法收集足够的数据来确定其初始指标是否得到满足。
随着我们在 2023 年收到后续调查问卷的回答，我们将更新此报告，以添加相关信息，了解哪些项目已经达成指标或调整指标。
如需了解详情，请参阅 2022 年 Google 文档赛季结果页面，其中提供了每个组织的原始项目提案和完整案例研究的链接。
与技术文档工程师合作
在 Season of Google 文档计划中，项目应直接招募、面试、聘用技术文档工程师，并向其支付薪酬。技术撰稿人可以将自己添加到我们的 GitHub 代码库中由“文档季”维护的目录，但“文档季”的工作人员不会审查或推荐技术文档作者。
为开源项目聘请技术文档工程师的最佳实践
我们要求各个项目分享其在招聘、招聘和与技术文档工程师合作方面的最佳做法。最重要的建议是：
招聘
- 面试更少的候选人，进行现场练习，而不仅仅是查看简历
- 重视书面和口头沟通技巧，而不是项目语言或工具的熟练程度
- 直接询问技术文档工程师如何获得开展项目所需的任何领域知识
- 对项目使命充满热情且有着相同核心开源价值观的人更有可能在整个项目中保持动力
- 对来自世界各地的申请者开放，因为不同的观点和背景对你的项目有帮助
招聘人数
- 使用合同来清楚说明交付成果、付款时间安排和具体的承诺期限
- 如果您的项目有很多不明之处，除了文档创建之外，还应包含一个发现或研究里程碑。
协调与沟通
- 记录会议记录，让参与项目的所有人都能更轻松地了解背景信息和后续步骤
- 明确说明期望的沟通方式和频率，是每周通话、每日电子邮件，还是聊天频道的最新状态
- 积极回应并给出清晰明确的反馈，在反馈中应包括“为什么”而不只是“内容”
- 将技术文档工程师与更广泛的社区联系起来，为他们提供背景信息，并就其工作进行社交互动
进程和工具
- 创建文档流程，将持续到“文档”季节以外，并且整个社区都可以为
- 文档审核所需的时间至少与代码审核一样重要；请确保为其留出足够的时间
为清晰起见，部分建议已修改并精简。
与 2021 年计划一样，《2022 年文档季》的大多数技术文档撰写者直接向他们合作的组织申请职位。
与技术文档工程师合作时的常见问题
在 2022 年计划中，报告与技术文档工程师合作方面的问题的项目较少。由于生病、全职工作或无法按时完成任务，技术文档工程师无法完成此项目是最大的问题。
有一个项目报告说，他们的文档项目依赖于 Google 编程之夏期间完成的工作，并且这些依赖关系难以管理。另一个项目遇到困难，原因是他们的技术文档工程师需要记录的硬件在作家所在国家/地区的国防部没收且无法进口。
跟进调查问卷
我们将于 2023 年 5 月、8 月和 11 月向 2022 年的参与者发送三份跟进调查问卷。我们会根据收到的结果更新此部分。
后续问题
与往常一样，我们对开源文档了解得越多，就越想学习！
在接下来的赛季中，我们希望：
- 收集更多项目元数据，以查找项目存在时间、社区规模、语言和文档需求之间的相关性
- 分析文档项目，看看它们是否可以泛化为可共享的模板
- 制定一套评分准则，用于采访开源项目中的技术文档工程师
虽然我们希望调查许多问题，但我们也希望尊重参与 Google 文档季的开源项目管理员和维护人员的时间。该计划的首要任务是帮助项目使用文档解决他们的问题。