导师指南

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

本指南面向的是开源导师,即参与过 Google 文档季的开源组织成员(作为技术文档撰写者的导师)。

简介

本指南可帮助您执行您在文档季的各个阶段负责的任务。

作为导师,您的一个目标就是确保技术文档撰写者在今年的 Google 文档季获得丰厚的成功体验。这将提高技术文档撰写者在今年的文档季结束后继续为您的开源项目做贡献的可能性,同时让其他技术文档作者对从事开源工作充满热情。

组织申请阶段

组织应用阶段从 2019 年 4 月 2 日持续到 2019 年 4 月 23 日。在此期间,您的组织管理员可以为组织提交申请,体验文档季。Google 计划管理员于 2019 年 4 月 30 日发布了成功组织的名单。

您作为导师在此阶段需要完成的任务

创建创意列表。

请与您的组织管理员合作创建项目创意列表。该列表应包含您希望技术文档撰写者在今年的 Google 文档季期间处理的一个或多个文档项目。

技术写作项目的创意

注册“Google 文档季”。

请尽快注册“Google 文档”季。

2019 年 Google 文档赛季现已结束报名。

谈谈文档季。

宣传贵组织正在参与文档季的 消息!即使您的组织今年未能入围最终入选组织名单,也很高兴您参与了此评选过程。

宣传材料

技术文档工程师探索阶段

技术文档作者探索阶段从 2019 年 4 月 30 日持续到 5 月 28 日。在此期间,技术文档工程师会浏览参与组织的列表和这些组织的项目创意。技术文档工程师可以直接与一个或多个组织联系以讨论项目创意。

您作为导师在此阶段需要完成的任务

与感兴趣的技术文档工程师讨论项目创意。

您可以与直接与您的组织接触的任何技术文档工程师讨论项目创意,帮助技术文档工程师拟定优秀的项目提案,将其提交给 Google 计划管理员。项目创意可能来自组织和技术文档工程师提出的其他创意。

技术写作项目的创意

评估技术文档工程师提案

技术文档工程师申请阶段

技术写入器应用阶段从 2019 年 5 月 29 日持续到 2019 年 6 月 28 日。在此期间,技术文档撰写者申请参加文档季,组织可以选择他们想要指导的项目。

您作为导师在此阶段需要完成的任务

评估技术文档工程师的提案。

与您的组织管理员合作,评估技术文档撰写者提案,并选择您的组织希望在今年的 Google 文档季期间指导的技术写作项目。

评估技术文档工程师提案

社区凝聚阶段

社区凝聚阶段从 2019 年 8 月 7 日持续到 9 月 1 日。在此期间,导师帮助获得认可的技术文档工程师熟悉开源项目。

您作为导师在此阶段需要完成的任务

向开源项目和社区介绍技术文档工程师。

向开源组织介绍技术文档工程师,并帮助技术文档工程师熟悉您使用的工具和流程。

与技术文档工程师合作

您的责任

向技术文档工程师解释您的产品。

花时间解释产品(尤其是在概念上),并确保技术文档工程师了解文档的受众群体。

与技术文档工程师合作

建立沟通渠道。

鼓励技术文档工程师通过社区邮寄名单、聊天、Slack 频道和任何其他共享沟通渠道介绍自己。确保技术文档工程师能以可靠的方式直接与您沟通。

您的责任

设定目标和预期。

与技术文档工程师合作,优化其技术编写项目的目标,并在双方设定预期。目的是确保项目成功。

您的责任

文档开发阶段

文档开发阶段从 2019 年 9 月 2 日持续到 2019 年 11 月 22 日。在此期间,技术文档工程师需要与导师密切咨询,在他们的项目下工作。

您作为导师在此阶段需要完成的任务

为技术文档工程师提供建议并鼓励他们。

与技术文档工程师密切合作,确保项目成功完成。

与技术文档工程师合作

您的责任

完成 Google 计划管理员发布的任何调查问卷。

Google 计划管理员可以在项目期间发送调查问卷来评估进度。完成调查问卷,然后按照调查问卷文档中的说明将回答提交给 Google 计划管理员。

项目敲定和评估阶段

项目最终确定阶段从 2019 年 11 月 25 日至 12 月 6 日。(长时间运行的项目的日期有所不同。)在此期间,技术文档工程师提交最终工作产品和导师评估。

导师评估阶段从 2019 年 12 月 2 日 - 2019 年 12 月 6 日 18:00(世界协调时间)开始。在此期间,导师将提交他们对技术编写项目成功与与技术文档协作的经验的评估结果。

您作为导师在此阶段需要完成的任务

撰写并提交您对技术写作项目的评估结果。

请在世界协调时间 (UTC) 2020 年 2 月 28 日 18:00 之前完成并提交您的评估。

评估技术写作项目

2019 赛季 Google 文档项目收尾阶段已结束。

长时间运行的项目

对于文档季中的标准长度技术写作项目,文档开发阶段从 2019 年 9 月 2 日持续到 2019 年 11 月 22 日。但是,一些技术文档工程师可能会在与开源组织协商的情况下申请长时间运行的项目。对于长时间运行的项目,文档开发阶段从 2019 年 9 月 2 日持续到 2020 年 2 月 21 日。

长时间运行的项目的最终确定和评估期为 2020 年 2 月 24 日至 28 日。在此期间,技术文档工程师提交最终工作产品和评估,导师提交评估结果。

长期项目导师的任务

为技术文档工程师提供建议,并提交您的项目评估。

对于标准长度的技术编写项目,您的任务和职责与本页上所述相同,只不过项目敲定和评估的日期更晚了。