当前阶段：
2021 年“文档之季”计划已于 2021 年 12 月 14 日结束。请参阅时间轴。
文档季简介
文档季由 Google 开源计划办公室管理，是一项可持续发展计划。文档季的目标如下：
- 为开源项目提供支持，通过文档解决项目问题
- 让技术文档撰写者有机会积累开源经验
- 提高对开源、文档和技术写作的认识
- 在开源文档中收集和分享有关有效指标的信息
如需详细了解“文档季”，请访问该计划的网站。
2021 年计划概览
2021 年计划变更
在 2019 年和 2020 年，组织和技术文档撰写者分别申请了文档季活动，文档季活动管理员将技术文档撰写者与组织进行了匹配。组织为技术文档撰写者提供了导师，他们会根据自己的工作地点获得津贴。该计划衡量了技术文档撰写者、导师和组织管理员对参与该计划的满意度，但未衡量文档成果。
2021 年，文档季团队对该计划进行了重大更改，将重点转向衡量文档成效，并为组织和技术文档撰写者提供更大的灵活性。
- 提交了项目提案（包括预算和拟议指标）的组织
- 技术文档工程师不再通过 Google 申请与组织匹配，而是直接向已接受申请的组织申请
- 获批的组织通过 Open Collective 获得了补助，并将其用于支付技术文档撰写者的费用
- 技术文档作者的薪酬由组织决定
- 组织提交了最终评估和案例研究，并回答了跟进调查问卷
2021 年一般性调查结果
组织
- 2021 年计划的变化导致申请的组织数量减少（与 2020 年相比，2021 年申请的组织数量减少了 30%），但 2021 年的组织管理员对该计划的满意度略高于 2020 年的管理员（93% 对 91%）
问题、文档类型和指标
- 大多数项目都专注于创建文档，以减轻维护者的负担（通过减少问题/疑问）和/或提高项目参与度（项目用户或贡献者）。
- 50% 的获批组织创作了教程或操作方法内容。
- 超过 50% 的已获批准的组织认为，其当前的文件资料不够充分、混乱或过时。
- 项目通常希望通过互动来衡量文档的有效性，尤其是减少提出的问题数量，以及增加文档访问者数量和项目参与人数。
- 截至 2022 年 11 月，30 个项目中有 25 个项目回复了调查问卷：
- 18 个项目表示已达到其原始指标
- 5 个项目符合修订后的指标
- 2 个项目表示还为时过早
参与计划
- 组织管理员认为，招募、聘用和支付技术文档撰写者的费用是该计划中最难的部分。
- 截至 2022 年 11 月，30 家受访组织中有 24 家表示：
- 18 家组织仍在与其文档季技术编写者合作（作为持续贡献者或解答问题的资源）
- 4 家组织与其文档季技术编写者以付费身份合作
- 18 家组织仍在与其文档季技术编写者合作（作为持续贡献者或解答问题的资源）
2021 年亮点
- 多个项目表示，他们的技术文档工程师打算在文档季结束后继续参与他们的项目
- Metanorma 收到了许多符合条件的技术文档撰写者申请，因此他们找到了匹配资金，以便在该计划期间再聘请一名文档撰写者，与受 Docs Season 支持的文档撰写者一起工作
- Moja Global 发现社区对文档非常感兴趣，因此成立了新的文档工作组，让更多贡献者参与项目文档的编写
2021 年摘要数据
2021 年，共有 82 家组织提出了申请，其中 30 家开源组织加入了该计划。（如需了解选择标准，请参阅“创建应用”指南。）您可以在 Document Season 网站上找到参与计划的组织的完整列表。所有 30 家获批组织都提交了最终的案例研究报告，完成了 2021 年计划的参与。
组织简介
参与 2021 年文档季的组织代表了各种各样的开源项目。2021 年同类群组包括：
- 大型语言项目，例如 Julia、Perl 和 R
- 教育、气候、金融科技、医疗保健、图书馆服务、机器学习、质谱、公共合同和机器人领域的项目
- 面向开发者的项目，包括混沌工程工具、模糊测试工具、聊天机器人 SDK、软件组合分析流水线、性能监控工具和可视化编程工具
- 文档工具（例如 Redocly 和 Metanorma）的文档项目
Python 生态系统项目是最大的子类别。2021 年同类群组包括 ArviZ、NumPy、MicroPython、PyMC3、PyTorch-Ignite 和 SymPy。
我们未收集有关这些项目的任何元数据（例如成立日期、贡献者的地理分布、贡献者数量或用户群规模）。
我们确实要求项目指明其使用的开源许可。
2021 年组织列出的文档问题在开源项目和一般技术文档中都很常见。
组织希望在 2021 年计划中解决的主要问题包括：
请注意，组织可以报告多个文档问题。如需了解更多详情，请访问 2021 年“文档季”结果页面，其中包含指向每个组织的完整案例研究的链接。
创建的文档类型
在 2021 年的案例研究中，教程是最常被提及的文档类型。
案例研究中提及的其他文档类型包括文档即代码流水线、图表、术语表、样式指南、常见问题解答、国际化、Codelab、内容模型、模块、概念文档、错误消息、用户研究、自述文件、知识库。
其中一些类别比较模糊，一个文档项目可以包含多种文档类型或功能。
多个项目明确提及了使用 Diátaxis 框架作为规划文档类型的指南。
如需了解更多详情，请访问 2021 年“文档季”结果页面，其中包含指向每个组织的完整案例研究的链接。
预算
2021 年，平均预算请求金额为 10,200 美元，中位数为 10,000 美元。只有 3 家组织申请并获得了最高金额的资助（15,000 美元），另有 3 家组织申请并获得了最低金额的资助（5,000 美元）。
指标
在案例中，他们列出了用于衡量文档项目成效的指标。
建议的首要指标包括：
其他建议的指标包括 GitHub 星数、网页浏览时长、邮寄名单转化次数、定性用户测试、论坛参与人数、合作伙伴/志愿者/集成数量。
由于完成技术写作项目和提交案例研究的时间间隔较短，2021 年同类群组的大多数学员都无法收集足够的数据来确定他们是否达到了最初的指标。
如需了解更多详情，请访问 2021 年“文档季”结果页面，其中包含指向每个组织的完整案例研究的链接。
与技术文档撰写者合作
2021 年文档季的最大变化与项目与技术文档撰写者之间的合作方式有关。在早期版本中，技术文案撰写者直接向 Google 申请，由项目管理员为其匹配项目，并由 Google 直接向其支付固定津贴。
2021 年，技术文档撰写者直接申请加入项目，项目会为技术文档撰写者设置薪酬预算，并通过文档季“Open Collective”基金进行付款。
参与 2021 年计划的大多数项目在招聘技术文档撰写者方面经验不足或没有经验，许多项目都指出，该流程的这一部分需要更多支持。针对这些反馈，文档季团队在计划指南中添加了有关创建技术文案作者协议的文档。
招聘建议
我们要求这些项目为有意参与文档季的其他项目提供推荐。主要的招聘建议包括：
- 尽早分享面向技术文档撰写者的招聘材料，即使您尚未被该计划录取也可以这样做。让社区推荐可能的候选人。
- 在项目渠道之外广泛分享。使用包容性语言，并直接鼓励来自代表性不足背景的候选人申请。
- 了解哪些工具对文档创建流程至关重要，并招募有使用这些工具经验的技术文档撰写者。
- 向技术文档撰写者明确说明交付成果和里程碑、沟通渠道和签收流程，以及付款流程和时间安排。
- 考虑利用文档季技术文档编写者提供指导和培训，从而投资于社区成员，帮助他们成为技术文档编写者。
- 在计划中预留比预期更多的时间来引导技术文档撰写者，并在整个计划期间回答问题和提供支持，尤其是在技术文档撰写者没有项目领域的相关经验时。
- 记录招聘、聘用和新员工入职流程，以便在日后开展项目时使用。
（注意：案例研究中并未指明他们在哪些项目中招募了技术文档撰写者候选人。）
与技术文档撰写者合作时常见的问题
由于新冠或其他疾病，或者因新冠相关的家庭责任，一些项目的技术文档撰写者不得不退出。一些项目报告了涉及时区不一致或互联网连接问题的通信问题。
项目发现，他们低估了加入社区或设置项目文档工具链的难度。
由于 Open Collective 存在银行问题，或者技术编写者所在的国家/地区存在付款限制，因此部分项目的技术编写者延迟收到了付款。
关于 Open Collective 费用的计划文档不明确：Google 会承担将资金初始转移到项目的 Open Collective 交易费用，但不承担某些其他付款渠道收取的交易费用（例如货币换算费用）。我们会在日后推出的计划的文档中更明确地说明这一点。
跟进调查问卷
在参与“文档季”计划期间，项目需要参与后续调查问卷。我们分别于 2022 年 5 月、8 月和 11 月发送了三份调查问卷。
在跟进调查问卷中，我们要求项目确认其提案和案例研究链接是否仍有效。该调查问卷还包含有关项目成效（根据案例研究中设定的指标确定）以及项目技术文档撰写人员的持续参与度和薪酬水平的问题：
- 您是否仍在与您的 Google 文档季节技术编写者合作？
- 如果您的技术文档撰写者仍在参与您的项目，他们是否会获得任何形式的补偿？
- 到目前为止，您是否认为文档项目取得了成功？
未来问题
一如既往，我们越是深入了解开源文档，就越想了解更多！在未来的季节中，我们希望了解：
- 项目网域是否与文档类型选择或指标选择相关
- 哪些技术文档撰写者招聘和新手入门做法最有助于项目完成和技术文档撰写者留存
- 衡量文档有效性合理的时间表
虽然我们有很多问题想要调查，但也希望尊重参与文档季的开源项目管理员和维护人员的时间。该计划的首要任务是帮助项目解决文档问题。