简介

欢迎来到文档季!

Google 文档季图标

促进与技术文档工程师的开源协作

当前阶段
2019 年 Google 文档季计划已于 2020 年 3 月 6 日结束。请参阅时间轴

Season of Google 文档旨在为技术文档写手和开源项目提供一个框架,让大家能够协同合作,共同实现改进开源项目文档这一共同目标。对于刚开始接触开源技术的技术文档,可以通过该计划获得为开源项目做贡献的经验。对于已经在从事开源工作的技术文档编写人员,该计划提供了一种潜在的全新协作方式。《Google 文档季》还为开源项目提供了与更多技术写作社区互动交流的机会。

在该计划期间,技术文档工程师将花几个月时间与开源社区密切合作。他们将自己的技术编写专业知识加入到项目的文档中,同时了解该开源项目和新技术。

开源项目与技术文档工程师合作,改进项目的文档和流程。他们可以共同选择构建新的文档集,或重新设计现有文档,或者改进和记录开源社区的贡献程序和新手入门体验。

我们共同努力提高公众对开源文档、技术写作以及我们如何共同造福全球开源社区的认识。

运作方式

以下是“文档季”计划的简要工作流程:

  • 开源组织可以申请成为今年的文档季中的导师组织。他们可以针对自己的应用提交文档项目创意列表。

  • 技术文档工程师浏览参与组织的列表,并选择他们感兴趣的项目。技术文档工程师可以与相关组织联系,讨论他们的想法。然后,技术文档工程师撰写项目提案,并将其提交到“文档季”。

  • 组织确认他们想要指导的技术写作项目。

  • 被入选的技术文档工程师会花几个月与开源组织的导师合作来完成他们的项目。

  • 在计划结束时,Google 计划管理员会宣布成功完成的项目。

时间轴会显示所涉及的步骤的详细信息和关键日期。

参与者和角色

下面列出了参与文档赛季的主要用户群体以及每个群体在该计划中扮演的角色:

  • 组织管理员是参与计划的开源组织的成员,他们是该组织中的 Google 文档季主要联系人。组织管理员提交组织参与文档季的申请、管理组织内的导师、确保技术写作项目不偏离正轨、处理文书以及管理导师奖金的分配。请参阅管理员指南责任

  • 开源导师是指参与该计划的开源组织的成员,他们被接受为今年 Google 文档季的导师。导师与技术文档工程师密切合作,帮助确保项目成功。请参阅导师指南责任

  • 技术文档撰写者是全球获准参与今年的文档季节的技术文档撰写者。申请人应能提交角色说明和工作示例,以证明自己有技术撰写经验。请参阅技术文档撰写者指南职责

  • Google 计划管理员是 Google 内部负责执行文档季计划的项目管理员。

后续步骤