组织管理员指南

当前阶段
文档制作。请参阅时间表

本指南适用于申请或参与 Google 文档季计划的组织管理员。

您的组织应该加入 Google 文档季计划吗?

使用这些问题可帮助您了解您的开源项目或组织是否应参与 Google 文档季。

您的组织或项目是否:

  • 认为新增或更新文档有助于实现目标或解决项目或社区中的问题?
  • 对如何衡量文档项目是否成功有初步了解或有相关假设?
  • 是否有社区成员愿意帮助招聘、评估和入职技术文档工程师;还有谁愿意在项目期间(6-8 个月,包括申请期)回答问题并提供其他支持?
  • 是否有社区成员愿意担任组织管理员,并协调创建申请、回复计划管理员的问题并提交每月评估、最终评估和案例研究?完成 Google 文档季计划后,组织管理员还应愿意回答后续调查。

您的组织还应满足计划资格要求,包括能够创建 Open Collective 帐号。

组织申请流程

探索阶段

虽然“Google 文档季”申请将于 2024 年 2 月 22 日开放申请,但我们强烈建议组织在提交申请之前花些时间完成“探索”阶段中的步骤。

  • “创建项目提案”页面。提案页面列出了关键需求、目标或问题、可能的文档解决方案以及可能的指标。此页面应该是公开的,并可供社区成员贡献和讨论。包含希望参与该计划的技术文档撰写者的信息 - 他们应该在哪里提问、表达兴趣或详细了解您的项目?我们建议您添加一个电子邮件地址,以便就 Google 文档季的事宜与您的开源组织联系。但是,我们强烈建议您不要将个人电子邮件地址用作联系您的开源组织的电子邮件地址。(请参阅项目创意列表,查看相关示例。)
  • 在社区渠道中公开您的提案页面,并将您的组织添加到 Google Season ofDocs GitHub 代码库中感兴趣的组织列表中。您可能还想在编写 Google 文档 Slack 的 #season-of-docs 频道中分享您的链接。宣传和新闻页面包含您在谈论 Google 文档季时可以使用的徽标和其他内容。
  • 对于每个文档创意,请考虑技术文档工程师需要具备哪些经验和资历,才能与您的社区和组织成功合作。您的社区能够帮助技术文档工程师开发哪些技能(例如,使用 GitHub 或您的文档工具链)?(请参阅与技术文档工程师合作的指南
  • 询问感兴趣的技术文档工程师,请他们自告奋勇回答问题。
  • 开始查看对您的项目感兴趣的技术文档工程师,他们已提交的所有意向声明。

应用阶段

  • 从提案页面选择最具潜力的参考提示。每个组织只能提交一个提案。需要考虑的一些事项:
    • 哪种创意最受技术文档工程师的兴趣?
    • 下面哪一项创意有助于解决您的项目最大的问题?对于更有可能完成但对项目没有显著影响的文档项目,最好选择一个风险更大、影响更大的建议。
    • 这个想法是否需要社区的特定成员参与?请问他们有时间参加吗?
  • 使用提案模板创建提案。 确保您了解并包括:

    • 您想要解决的问题
    • 您要改进或创建的文档范围
    • 如何衡量文档成功与否

    您的提案还必须包含预算。 无法考虑不完整的提案。

  • 请在申请截止日期(世界协调时间 2024 年 4 月 2 日 18:00)之前提交申请。已接受的提案将于 2024 年 4 月 10 日公布。

项目开发和报告

项目启动

  • 如果贵组织已经为项目选择了一名或多名技术文档工程师,请与技术文档工程师召开启动会议。您应该与技术文档工程师合作,制定工作时间表和定期检查。
  • 如果您收到了多个感兴趣的技术文档工程师发表的多份意向说明,请公开声明您选定的技术文档工程师,或以其他方式告知申请者您的决定。

授权付款

  • 自 2024 年 6 月 11 日起,Google Season of Google 文档将在组织聘用技术文档工程师后,将 40% 的公益金存入每个组织的 Open Collective 帐号。我们建议组织根据项目里程碑(包括项目开始时的付款)与技术文档工程师一起制定付款时间表。
  • 自 2024 年 12 月 13 日起,其余 60% 的组织将存入已完成并提交最终评估和案例研究的组织对应的 Open Collective 帐号。自 2024 年 12 月 13 日起,所有成功的项目都将收到最后一笔付款
  • 如需详细了解如何创建 Open Collective 帐号,请参阅付款指南

项目状态报告

  • 组织管理员应在收到状态报告表单的链接后的一周内填写每月状态报告(链接将通过电子邮件发送,因此,如果您未看到此链接,请查看您的“垃圾邮件”文件夹)。

项目最终评估和案例研究

各组织必须在 2024 年 12 月 10 日 18:00(世界协调时间)之前完成并提交项目最终评估和案例研究,才能获得剩余的资助资金。

最终评估

最终评估表单将在世界协调时间 (UTC) 2024 年 12 月 10 日 18:00 之前至少一个月内提供给组织管理员。

案例

“Google 文档季”案例研究是贵组织使用 Google 文档季的关键成果。每周记录一次项目更新日志将有助于您创建案例研究。记录每周的项目进度(包括指向有用处的拉取请求、问题或对话的链接)、表现良好(或不好)的方面、学到的知识以及提出的问题。

如需了解详情,请阅读创建案例研究,并务必按照我们的案例研究模板来创建您的案例研究。您将在最终评估表单中以链接的形式提交您的案例研究。

您的案例研究将发布在 Google 文档季网站上,因此在添加项目信息时,请务必注意这一点。

被接受的组织需要参与至少三次后续问卷调查,以帮助跟踪 Google 文档季项目在一段时间内的成效。

表单

表单 链接 最后期限
组织申请

组织申请现已关闭。您可以加入 season-of-docs-announce 通知邮寄名单,及时了解最新信息。

世界协调时间 2024 年 4 月 2 日 18:00
组织付款信息

组织付款信息表单

世界协调时间 2024 年 5 月 14 日 18:00
招聘技术文档工程师的证明

技术文案招聘表单

世界协调时间 2024 年 5 月 22 日 18:00
每月评估

项目评估阶段(2024 年 6 月 5 日)可填写该表单。

请参阅时间表
最终项目评估和案例研究

在最终项目评估和案例研究阶段(2024 年 11 月 22 日 - 2024 年 12 月 10 日)可填写该表单。

世界协调时间 2024 年 12 月 10 日 18:00
跟进调查问卷

可在跟进调查问卷阶段(2025 年 5 月 1 日)填写表单。

请参阅时间表