组织管理员指南

当前阶段：
公布结果的时间表。

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

您的组织应该加入“文档季”计划吗？

这些问题可帮助您了解您的开源项目或组织是否应该加入 Season of Google 文档。

您的组织或项目是否：

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

贵组织还应符合计划资格要求，包括能够创建 Open Collective 帐号。

组织申请流程

探索阶段

尽管文档季的申请将于 2022 年 2 月 23 日开放申请，但我们强烈建议各组织在提交申请之前，先花些时间完成探索阶段的步骤。

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

应用阶段

  • 从提案页面中选择最具潜力的参考提示。每个组织只能提交一个提案。您需要考虑以下几点：
    • 技术文档工程师对以下哪个想法最感兴趣？
    • 以下哪个想法有助于解决项目最大的问题？如果某个文档项目更有可能完成，但不会对项目产生重大影响，请选择一个风险更高的建议，该建议会产生更大的影响。
    • 这一想法是否必须有社区中的特定成员参与？他们有时间参加调查吗？

  • 使用提案模板创建提案。 确保您了解并包括：

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

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

  • 请在申请截止日期（世界协调时间 2022 年 3 月 25 日 18:00）之前提交申请。 已接受的提案将于 2022 年 4 月 14 日公布。

项目开发和报告

项目启动

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

授权付款

  • 自 2022 年 6 月 9 日起，Google 文档季将在组织聘用技术文档工程师后，将 40% 的捐赠资金存入每个组织的 Open Collective 帐号。我们建议组织根据项目里程碑与技术文档工程师一起制定付款时间表，包括项目启动时的付款。
  • 自 2022 年 12 月 14 日起，剩余 60% 将存入完成并提交最终评估和案例研究的组织所属的 Open Collective 帐号。请注意，无论项目完成时间如何（例如 3 个月与 6 个月的项目），所有成功的项目都将从 2022 年 12 月 14 日开始收到最后一笔付款
  • 如需详细了解如何创建 Open Collective 帐号，请参阅付款指南。

项目状态报告

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

项目最终评估和案例研究

各组织必须在 2022 年 11 月 30 日 18:00（世界协调时间）之前完成并提交项目最终评估和案例研究，才能获得剩余的公益金。

最终评估

最终评估表单将在 2022 年 11 月 30 日 18:00（世界协调时间）之前一个月内提供给组织管理员。

案例研究

您的组织参与 Google 文档赛季后，可通过主要成果实现文档季度案例研究。每周记录一次项目更新日志将有助于您创建案例研究。记录每周的项目进度（包括在有用的情况下，指向拉取请求、问题或对话的链接）、表现良好（或不好）的地方、学到的东西以及提出的问题。

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

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

我们要求组织至少参与三项后续调查，以帮助我们跟踪 Google 文档季项目的成效随时间的变化情况。

表单

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

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

 2022 年 3 月 25 日 18:00（世界协调时间）
组织付款信息

此表单尚不可用。

 2022 年 5 月 12 日 18:00（世界协调时间）
招聘技术文档工程师的证明文件

技术文档工程师招聘阶段已完成。

 2022 年 5 月 16 日 18:00（世界协调时间）
每月评估

每月评估阶段已结束。

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

项目评估阶段已结束。

 2022 年 11 月 30 日 18:00（世界协调时间）
跟进调查问卷

可在跟进调查问卷阶段（2023 年 5 月 2 日）使用表单。

 请参阅时间表