当前阶段：
2019 年 Google 文档季计划已于 2020 年 3 月 6 日结束。请参阅时间轴。
本页面包含面向参与文档季的技术文档撰写者的指南。
简介
欢迎来到文档季！本指南将简单介绍您参与“Google 文档季”计划的情况，并帮助您完成在该计划的每个阶段应该开展的活动。
参与文档季的资格要求
要以技术文档作者的身份参与使用《文档季》，您必须：
- 注册时年满 18 周岁。
- 能够通过提交角色说明和工作示例来展示之前的技术编写经验。
- 在计划期间，有资格在他们居住的国家/地区工作。
- 当前未受美国禁运的国家/地区的居民。 请参阅美国财政部的制裁计划和国家/地区信息。
查看完整的技术文档撰写者条款。
您的开源导师
一季 Google 文档导师不一定是技术文档作者，并且他们可能在技术沟通方面几乎没有什么经验。他们是开源组织的成员，他们了解优秀文档的价值，并且在开源流程和工具方面具有丰富的经验。
您和导师之间的关系是一种协作。为开源组织提供文档经验和技能；您的导师将贡献他们关于开源和代码的知识。您可以共同开发技术文档并改进开源项目的流程。
计划公告和组织申请阶段
文档季的公告日期为 2019 年 3 月 11 日。 感兴趣的开源组织可以申请在 2019 年 4 月 2 日至 2019 年 4 月 23 日期间参与文档季。Google 计划管理员于 2019 年 4 月 30 日发布了成功组织的名单。
从计划公告到其参与的开源组织发布期间，您应密切关注相关新闻。 您可以返回到此网站，也可以观看博文或其他网络上的新闻。即使在组织应用阶段，一些开源组织也可能会分享他们的想法。
我们还邀请您宣传“Google 文档季”以及您对该计划感兴趣的原因。查看宣传材料，了解图形和创意。
技术文档工程师探索阶段
技术文档作者探索阶段从 2019 年 4 月 30 日持续到 5 月 28 日。在此期间，您可以浏览参与组织的列表及其项目创意。
当您找到一个或多个感兴趣的项目时，应直接与相关的开源组织联系，以讨论项目创意。
| 您在此阶段担任技术文档工程师的任务 | |
|---|---|
|
浏览参与该计划的开源组织及其项目创意的列表。 |
检查该列表，找到您要使用的开源组织。查看各组织建议的技术写作项目，并决定适合您的项目。您可以申请多个组织。在文档季的这一阶段，最好探索多个选项。在最终评选过程中，每个技术文档工程师只能接受一个项目。 |
|
与开源组织讨论项目创意。 |
您可以与任何参与计划的组织讨论项目创意。如需联系，请使用参与组织列表中显示的组织电子邮件地址。尽早讨论有助于您在技术文档撰写者申请阶段拟定优秀的项目提案，将其提交给 Google 计划管理员。最初的项目创意可能来自组织提出的创意列表。您也可以提出自己的想法。 |
技术文档工程师申请阶段
技术写入器应用阶段从 2019 年 5 月 29 日持续到 2019 年 6 月 28 日。在此期间，您可以申请参加文档季。Google 计划管理员会将相关详细信息从您的应用转发给您选择的开源组织。然后，开源组织管理员和导师选择想要指导的项目。
| 您在此阶段应担任技术文档工程师的任务 | |
|---|---|
|
提交参加“Google 文档季”的申请。 |
请在 2019 年 6 月 28 日之前提交“文档季”申请。 2019 赛季 Google 文档技术文档撰写服务申请现已截止。 |
社区凝聚阶段
社区凝聚阶段从 2019 年 8 月 7 日持续到 9 月 1 日。在此期间，开源导师会帮助您熟悉开源项目和社区。
| 您在此阶段担任技术文档工程师的任务 | |
|---|---|
|
建立沟通渠道。 |
与您选择的开源组织中的导师联系。确保您能通过可靠的方式直接与导师和组织管理员沟通。导师和组织管理员是开源组织的成员，是其组织“文档季”的主要联系人。 |
|
参与开源项目和社区。 |
向您的导师询问有关开源组织使用的工具和流程的问题。通过开源社区的邮寄名单、聊天、Slack 频道和任何其他共享沟通渠道介绍自己。 |
|
从整体上了解产品。 |
请导师对你将要记录的产品进行说明（尤其是在概念上）。详细讨论本文档的受众群体。 |
|
设定目标和预期。 |
与您的导师合作，优化您的技术写作项目的目标，并在双方设定预期。现在就设定这些目标和预期是确保项目成功的一个好方法。 |
文档开发阶段
文档开发阶段从 2019 年 9 月 2 日持续到 2019 年 11 月 22 日。（长时间运行的项目的结束日期不同。）在此期间，您要与导师密切协商，共同完成项目。
| 您在此阶段担任技术文档工程师的任务 | |
|---|---|
|
与导师一起完成项目。 |
请与导师密切合作来完成您的项目。按照开源社区的流程，请求审核生成的文档，并提交对开源代码库的更新。例如，GitHub 上托管的开源项目通过创建供审核和提交的拉取请求来添加或更新文件。 |
|
向组织管理员提出任何问题。 |
如果您对与导师的沟通有任何疑问，或者遇到可能会影响项目成功完成的任何其他问题，请告知开源组织管理员。 |
|
完成 Google 计划管理员发布的任何调查问卷。 |
Google 计划管理员可以在项目期间发送调查问卷来评估进度。完成调查问卷，然后按照调查问卷文档中的说明将回答提交给 Google 计划管理员。 |
项目敲定和评估阶段
项目敲定阶段的时间范围为 2019 年 11 月 25 日至 29 日，评估阶段的时间范围为 2019 年 11 月 25 日至 12 月 6 日。（长时间运行的项目的日期有所不同。）在项目敲定期间，您需要提交项目报告（也称为最终工作产品）。在评估阶段，您需要对导师和您作为文档季参与者的体验进行评估。
| 您在此阶段担任技术文档工程师的任务 | |
|---|---|
|
编写项目报告。 |
编写项目报告（有时称为工作产品）。项目报告包含您在文档季中所做的工作的说明以及所有相关链接。 2019 赛季 Google 文档项目收尾阶段已结束。 |
|
请导师查看项目报告。 |
对于如何描述您的成就，您的导师可能有着宝贵的见解。此外，在您的导师将项目标记为已成功完成或未成功完成之前，在此阶段对项目状态达成共识会非常有用。 |
|
完成项目报告。 |
请于世界协调时间 (UTC) 2020 年 2 月 28 日 18:00 之前完成项目报告。此表单可修改，但您必须在指定日期之前提交最终版本。 2019 赛季 Google 文档项目收尾阶段已结束。 |
|
撰写并提交您对导师的评估以及您对《文档季》的 体验的评价。 |
请在世界协调时间 (UTC) 2020 年 2 月 28 日 18:00 之前完成并提交您的评估。 2019 赛季 Google 文档项目收尾阶段已结束。 |
长时间运行的项目
对于文档季中的标准长度技术写作项目，文档开发阶段从 2019 年 9 月 2 日持续到 2019 年 11 月 22 日。但是，一些技术文档工程师可能会在与开源组织协商的情况下申请长时间运行的项目。对于长时间运行的项目，文档开发阶段从 2019 年 9 月 2 日持续到 2020 年 2 月 21 日。
长时间运行的项目的最终确定和评估期为 2020 年 2 月 24 日至 28 日。
对于标准期限技术编写项目，您的任务和职责与本页上所述相同，只是项目敲定和评估的日期更晚。
相关信息
- 查看文档季节时间轴。
- 如需详细了解您与所选开源组织的关系，请参阅组织管理员和导师的职责以及关于与技术文档工程师合作的导师准则。