组织管理员指南

当前阶段
2021 年“文档季”活动已于 2021 年 12 月 14 日结束。请参阅时间轴

本指南面向申请或参与 2021 年 Google 文档季活动的组织管理员。

贵组织是否应参与 2021 年 Google 文档季活动?

通过以下问题,您可以了解自己的开源项目或组织是否应参与 Google 文档季活动。

您的组织或项目是否:

  • 您认为新文档或更新后的文档有助于实现项目或社区中的目标或解决问题吗?
  • 是否对如何衡量文档项目的成效有了初步了解或假设?
  • 社区中有没有愿意帮助招募、评估和引导技术文案撰写者的成员?他们是否可以在项目期间(6-8 个月,包括申请期)回答问题并提供其他支持?
  • 是否有社区成员愿意担任组织管理员,协调创建申请表单、回复计划管理员提出的问题,以及提交每月评估、最终评估和案例研究?组织管理员还应愿意在 2021 年 Google 文档季结束后回答跟进调查问卷。

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

组织申请流程

探索阶段

虽然 2021 年 Google 文档季申请活动的申请时间为 2021 年 2 月 9 日,但我们强烈建议组织在提交申请之前,先花些时间完成探索阶段的步骤。

  • 创建项目提案页面。提案页面包含一系列关键需求、目标或问题、可能的文档解决方案和可能的指标。此页面应设为公开,并允许社区贡献内容和进行讨论。为希望参与的技术文档撰写者提供相关信息,他们应该去哪里提问、表达兴趣或详细了解您的项目?(如需查看示例,请参阅项目创意列表。)
  • 在社区渠道中公开您的提案页面,并将贵组织添加到 Google 文档季 GitHub 代码库中感兴趣的组织列表中。您还可以在 Write The Docs Slack 的 #season-of-docs 频道中分享链接。宣传和媒体页面包含徽标和其他内容,可供您在宣传 Google 文档季活动时使用。
  • 对于每个文档想法,请考虑技术文档工程师需要具备哪些经验和资质,才能与您的社区和组织成功合作。您的社区可以帮助技术文档工程师掌握哪些技能(例如使用 GitHub 或文档工具链)?(请参阅与技术文档撰写人员合作的指南。)
  • 请志愿者帮助回答感兴趣的技术文档撰写者提出的问题。
  • 开始审核有意参与您的项目的技术文档撰写者提交的任何意向声明。

申请阶段

  • 从提案页面中选择最有前景的想法。每个组织只能提交一份提案。需要注意的一些事项:
    • 哪个想法最受技术文档撰写者的欢迎?
    • 哪个想法有助于解决项目的最大问题?与选择更有可能完成但对项目影响不大的文档项目想法相比,选择风险更高但影响更大的想法更好。
    • 该想法是否需要社区中的特定成员参与?他们是否有时间参与?
  • 使用提案模板创建提案。请务必了解并提供以下信息:

    • 您要解决的问题
    • 您要改进或创建的文档的范围
    • 您将如何衡量文档的成效

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

  • 请在 2021 年 3 月 26 日世界协调时间 (UTC) 18:00 之前提交申请表单。 我们将于 2021 年 4 月 16 日公布已接受的提案。

项目开发和报告

项目启动

  • 如果贵组织已为您的项目选择了技术文档撰写者,请与技术文档撰写者召开启动会议。您应与技术文档撰写者合作,制定工作时间表和定期核对时间表。
  • 如果您收到了多位感兴趣的技术文档撰写者表达的兴趣声明,请公开宣布您选择的技术文档撰写者,或以其他方式告知申请者您的决定。

补助金发放

  • 自 2021 年 6 月 10 日起,Google 文档季将在每个组织聘请技术文案撰写人后,将 40% 的补助资金存入其 Open Collective 账号。我们建议组织根据项目里程碑与技术文案撰写者一起制定付款时间表,包括在项目启动时支付一笔款项。
  • 其余 60% 的资金将于 2021 年 12 月 14 日开始,存入完成并提交最终评估和案例研究的组织的 Open Collective 账号。
  • 如需详细了解如何创建 Open Collective 账号,请参阅付款指南

项目状态报告

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

项目最终评估和案例研究

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

最终评估

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

案例研究

Google 文档季案例研究是贵组织参与 2021 年 Google 文档季的主要成果。每周记录项目更新有助于您撰写案例研究。每周记录项目进度(包括拉取请求、问题或对话的链接,如果有用的话)、进展顺利(或不顺利)的情况、您学到的东西以及提出的问题。

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

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

我们要求组织至少参与三次跟进调查,以便我们跟踪 Google 文档季项目在一段时间内的成效。

表单

表单 链接 截止日期
组织申请

组织申请通道现已关闭。请访问 season-of-docs-announce 加入公告邮寄名单,及时了解最新资讯。

2021 年 3 月 26 日 18:00(世界协调时间)
组织付款信息

组织付款信息阶段已完成。如果您需要更改贵组织的付款信息,请与“文档季”管理员联系。

2021 年 5 月 12 日 18:00(世界协调时间)
技术文档工程师聘用证明

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

2021 年 5 月 17 日 18:00(世界协调时间)
每月评估

每月评估阶段已结束。

查看时间轴
最终项目评估和案例研究

计划评估表单

2021 年 11 月 30 日 18:00(世界协调时间)
跟进调查问卷

此表单将在跟进调查问卷阶段(2025 年 5 月 1 日)提供。

查看时间轴