当前阶段：
案例研究已发布。请参阅时间轴。
文档季由 Google 开源计划办公室管理，是一项可持续发展计划。文档季的目标是：
- 为开源项目提供支持，通过文档解决项目问题
- 让技术文档撰写者有机会积累开源经验
- 提高对开源、文档和技术写作的认识
- 在开源文档中收集和分享有关有效指标的信息
如需详细了解“文档季”，请访问该计划的网站。
2022 年计划概览
文档季的运作方式
在文档季期间，组织可以通过提交项目提案来申请。项目提案包括：
- 组织的相关信息
- 对项目所面临问题的说明
- 该项目将如何使用文档来帮助解决问题
- 项目将如何衡量文档的有效性（指标）
- 工作时间表
- 项目预算
- 任何其他信息，例如组织在类似计划中的经验，或任何其他有助于文档季节管理员了解其项目和问题的信息
加入该计划后，组织可以直接招聘和聘用自己的技术文档撰写人员。Season of Docs 使用 Open Collective 为组织提供资金，组织则通过 Open Collective 向技术文档撰写者支付费用。项目预算和付款信息公开透明；预算包含在“公文季”网站上提供的组织项目提案中，付款信息则显示在 “公文季”Open Collective 账号中。
组织在提交案例研究报告后，即视为已成功完成该计划。组织还需要在该计划实施期间每月完成一次评估，并在完成该计划后的一年内完成三次季度跟进调查问卷。
2022 年亮点
“新文档发布后，Casbin 和 Casdoor 的每日访问量几乎翻了一番，而跳出率下降了约 30%。”- Casbin
“这项计划的令人欣喜的成果之一就是，我们看到 [我们的技术文档撰写者] 在社区中成长为领导者。这两位贡献者现在负责主持工作组会议和社区会议，并参与项目的设计和维护。”-moja-global
“[GSoD] 帮助我们招募了两位才华横溢的技术文案撰写者，这在常规设置下非常困难。他们一直是 OpenMined 的活跃操作系统贡献者，与他们共事是一次愉快的经历。”- OpenMined
“此外，新手更容易通过新手册了解计算质谱。举个例子：CZI 基金还为长期处于弱势的个人提供津贴，部分获奖者使用了新版 OpenMS 手册来开启为期 6 周的实习期，并对新手册给予了积极评价。”- OpenMS
2022 年摘要数据
2022 年，在 67 个申请中，有 31 个项目获得了“文档季”计划的资助，其中 30 个项目成功完成了该计划。在 31 个获批的组织中，有 17 个组织是重复申请者。
31 个已获批准的项目共聘用了 58 名技术文档撰写者。超过 190 位技术文档撰写者在 Docs Season 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 年文档季结果页面，其中包含指向每个组织的原始项目提案和完整案例研究的链接。
创建的文档类型
2022 年案例研究中提及最多的文档类型是操作方法文档。
案例研究中提及的其他文档类型包括：
- 快速入门
- 术语库
- 常见问题解答
- 知识库
- 组件
- 博客/社交媒体内容
- 维护者指南
其中一些类别比较模糊，一个文档项目可以包含多种文档类型或功能。
如需了解更多详情，请访问 2022 年文档季结果页面，其中包含指向每个组织的原始项目提案和完整案例研究的链接。
预算
平均预算请求金额为 11,679 美元，中位数为 12,150 美元。五家组织申请并获得了最高金额的补助（15,000 美元），三家组织申请并获得了最低金额的补助（5,000 美元至 7,000 美元）。
指标
在案例中列出的项目中，他们介绍了用来衡量文档项目成效的指标。
建议的热门指标包括：
其他建议的指标包括：
- 更多文档拉取请求/贡献
- 在文档页面上提供更直接的反馈
- 网页停留时间
- 提出的问题（作为使用情况的代理）
- 论坛参与者
- 合作伙伴/志愿者/集成数量
- 降低跳出率
- 提高社区的认知度。
由于完成技术写作项目和提交案例研究的时间间隔较短，2022 年同届学员中的大多数人在提交案例研究时收集的数据不足，无法确定自己是否达到了最初的指标要求。
在 2023 年收到跟进调查问卷的回答后，我们会更新此报告，在其中添加哪些项目已达到其指标或修改了其指标的信息。
如需了解更多详情，请访问 2022 年文档季结果页面，其中包含指向每个组织的原始项目提案和完整案例研究的链接。
与技术文档作者合作
在文档季活动中，项目需要直接招聘、面试、聘用和支付技术文档撰写者的薪酬。技术文档撰写者可以将自己添加到我们的 GitHub 代码库中由 Season of Docs 维护的目录中，但 Season of Docs 工作人员不会审核或推荐技术文档撰写者。
为开源项目招聘技术文档撰写者的最佳实践
我们要求项目分享在招募、聘用和与技术文档撰写者合作方面的最佳实践。热门建议包括：
招聘
- 减少面试候选人，并使用现场练习会，而不是仅查看简历
- 注重书面和口头沟通能力，而不是项目所用语言或工具的熟练程度
- 直接询问技术文档撰写者将如何获取处理您的项目所需的所有领域知识
- 对项目使命充满热情并认同核心开源价值的贡献者更有可能在整个项目中保持积极性
- 欢迎来自世界各地的申请者，因为多元化的观点和背景有助于您的项目取得成功。不过，请注意，如果有太多处于不同时区的编剧和导师，您可能需要付出额外的努力来保持良好的沟通
招聘人数
- 使用合同明确说明交付成果、付款时间表和具体时间承诺
- 如果您的项目有很多未知因素，请在文档创建之外添加一个发现或研究里程碑
协调和沟通
- 保留会议记录来记录决策，以便项目中的所有人更轻松地了解背景信息和后续步骤
- 明确预计的沟通方式和频率，例如每周通话、每天发送电子邮件，还是在聊天渠道中更新状态
- 及时回复，并提供清晰的反馈，不仅说明“是什么”，还要说明“为什么”
- 将技术文档撰写者与更广泛的社区联系起来，为他们提供背景信息，并让他们的工作为人所知
流程和工具
- 创建一个在文档季活动结束后仍可持续的文档编写流程，并让整个社区都能参与其中
- 文档审核至少需要与代码审核一样长的时间，并且同样需要投入大量精力；请务必留出足够的时间
为清晰起见，我们对部分建议进行了编辑和浓缩。
与 2021 年计划一样，2022 年文档季的大多数技术文档撰写者都是直接向其合作过的组织提出申请。
与技术文档撰写者合作时常见的问题
在 2022 年计划中，报告与技术文档工程师合作时遇到问题的项目数量有所减少。技术文档撰写者无法完成该计划是最大的问题，原因包括生病、从事全职工作或无法满足时间承诺。
一个项目报告说，其文档项目依赖于 Google 夏季编程活动中的工作，并且这些依赖项难以管理。另一个项目遇到了困难，因为技术文档撰写者需要记录的硬件被该文档撰写者所在国家/地区的军方没收，无法进口。
跟进调查问卷
我们将于 2023 年 5 月、8 月和 11 月向 2022 年参与者发送三份跟进调查问卷。我们会在收到结果后，及时更新此部分。
未来问题
一如既往，我们越是深入了解开源文档，就越想了解更多！
在未来的赛季中，我们希望：
- 收集更多项目元数据，以便找出项目年龄、社区规模或语言与文档需求之间的相关性
- 分析文档项目，看看它们能否归纳为可共享的模板
- 制定面向开源项目技术文档作者的面试评分标准
虽然我们有很多问题想要调查，但也希望尊重参与文档季的开源项目管理员和维护人员的时间。该计划的首要任务是帮助项目解决文档问题。