创建技术编写应用

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

本页为技术文档撰写人员提供提示,提示如何填写申请流程的关键部分,以便参与《文档季》计划。此信息有助于您了解开源组织在选择要在 Google 文档使用季期间指导的技术写作项目时可能会考虑哪些因素。

简介

以下指南通常适用于文档剧季。 每个单独的开源组织可能都有特定的评估标准。您可以在提交申请之前与任何参与的组织联系,讨论他们的要求并规划项目提案。请参阅技术文档撰写指南中介绍的技术文档作者探索阶段。

申请表

在技术文档撰写申请阶段,您可以在技术文档撰写指南中找到申请表单。

提交表单后,您可以继续更新表单上的信息,直到技术文档工程师申请阶段结束(2020 年 7 月 9 日)。

个人信息

申请表要求您提供以下个人信息:

  • 您的姓名:请提供您的全名。Season of Google 文档不与开源组织共用此名称,也不会在网站上发布此名称。

  • 您选择的显示名称:请提供您在参与文档季期间用作公开标识符的名称。我们强烈建议您不要使用真实的全名作为显示名称。Season of Google 文档将会与您在申请表单中指定的开源组织共享您的显示名称。Season of Google 文档会将您的显示名称发布在网站上接受的技术写作项目列表中。

  • 您的电子邮件地址:提供与您的 Google 帐号关联的电子邮件地址。(您需要有 Google 帐号才能参与 Google 文档季。您可以在 Google 帐号中使用非 Gmail 电子邮件地址。 请参阅这篇帮助文章。) Season of Google 文档使用您的电子邮件地址与您沟通以及向您提供网站资源。Season of Google 文档会将此电子邮件地址与您在申请表单中指定的开源组织共享。Season of Google 文档不会在网站上发布此电子邮件地址。

请参阅下文,简要了解 Season of Google 文档如何使用申请表中的信息。

有关您的技术写作经验的信息

当开源导师和组织管理员查看项目提案时,他们对您的技术撰写体验感兴趣。您可以在此表单上提供以下详细信息:

  • 近期的技术写作经验:最多包含三个条目,您可以在其中列出您最近的技术写作角色或工作经验。如果您有开源文档相关经验,也请在此处添加。总结您的角色、角色的职责以及您完成的工作。您可以提供相关日期。

  • 指向您的简历或履历的链接(选填)您的简历或简历 (CV) 的可公开访问版本的网址。

  • 工作示例链接(可选)可公开访问的编写示例组合的网址,或指向您的作品示例的各个链接。

  • 你还想添加的其他任何内容(可选)要添加此应用的任何信息。例如,您对技术文档的兴趣、为何想要参加文档季或其他相关体验。

项目提案

项目提案是您希望在文档季期间与所选的开源组织合作时完成的文档工作的摘要。

您最多可以提交三个项目提案。所有项目提案都必须在同一份申请表上。

花时间制定项目提案,并牢记以下准则。

准备工作:

  • 查看参与的开源组织的列表,并选择您感兴趣的一个或多个组织。查看您选择的每个开源组织提出的项目创意。

    参与该计划的开源组织

  • 如果感兴趣的组织尚未建议任何创意,您可以查看项目创意总体列表,并基于其中某个创意提出您的创意。您还可以选择提出自己的想法,无论组织是否发布了想法。

  • 与一个或多个参与组织联系,讨论项目创意。如需联系,请使用参与组织列表中显示的组织电子邮件地址。及早讨论有助于拟定出优秀的项目提案。

申请表上的项目提案:

  • Open source organization name:输入您希望在 Google 文档使用季期间合作的开源组织的名称。该组织必须是“文档季”网站上显示的参与组织之一。

    参与该计划的开源组织

  • 开源项目名称:这是您要在 Google 文档季期间使用的开源项目的名称。项目必须属于“文档季”网站上显示的参与组织之一。对于某些组织,组织名称和项目名称可能相同。

  • 您提议的技术写作项目的名称。提供一个简短的描述性标题,总结您提出的工作的主要目标。

  • 详细说明。在说明中尽可能详细地描述您提议的技术编写项目。您可以在说明字段中输入多个段落。以下是关于应添加内容的一些建议:

    • 提供有关您提议创建/更新的文档的详细信息。 如果您计划更新现有文档或网站,请添加链接并描述建议的更新。如果要推荐新文档或新网站,请说明内容和受众。
    • 说明您提出新文档或更新建议的原因。
    • 如果您已与开源组织中的某人讨论过该项目,请附上这些讨论的结果摘要。
    • 注意提案的语言和风格。开源组织可能会将这些因素作为评估提案的因素。
    • 请勿提供项目说明的链接。说明中应包含项目的所有明确具体信息。开源组织必须能够根据申请表的内容(而不是在其他地方保留的内容)进行选择。如果您需要链接至对说明进行补充的其他内容,可以,但请注意,只有申请表单的内容会被用于选择项目。

申请表上的其他重要字段

以下是您应该在申请表中提供的其他关键信息的准则:

  • 选择标准长度项目或长时间运行的项目:《文档季》的文档开发阶段的标准期限为 3 个月。如果您的项目需要更长的时间,您必须在与您选择的开源组织进行咨询后,在申请表单中注明这一点。请参阅长时间运行的项目的说明。

  • 接受 Google 文档季补助金:Season of Google 文档会向成功完成其项目的技术文档撰写者支付一笔资金,前提是技术文档作者想要接受资助。请参阅有关技术作家资助的信息。补助金是可选的。如果您不想获得助学金,请在申请表中指明您的选择。

Season of Google 文档如何使用您在申请表单中提供的信息

本部分总结了 Season of Google 文档如何使用申请表中的信息。本页面前面的部分详细介绍了关键字段。

此表格列出了关键字段。对于每个字段,该表都会指明文档季是否:

  • 将信息传递给您在申请表单中指定的开源组织。
  • 在文档季网站上接受的技术写作项目列表中发布信息。
表单上的信息 是否与开源组织共享? 是否显示在 Google 文档剧季网站上?
全名
显示名称
电子邮件地址
近期有技术写作经验
指向简历或 CV 的链接
指向工作示例的链接
你还想补充的任何其他信息
开源组织/项目名称
技术写作项目的名称和说明
长时间运行的项目或标准长度项目
接受资助

上表中使用的符号的关键:

符号 符号的含义

备注

以下是几点其他注意事项:

  • 提交多个项目提案:您可以提交多个项目提案,但《文档季》只能接受每位技术文案的一个项目提案。您只能提交一份申请表单。此表单最多允许三个项目提案。

  • 程序中的技术写作项目的总数:Google 文档季只能接受特定的最大技术写作项目总数。了解槽分配的工作原理。

  • 请查看导师提示,了解如何评估技术文档工程师的提案。了解导师的选择标准有助于您制定更有可能成功的提案。

  • 如需了解何时以及如何提交《文档季》应用的过程信息,请参阅技术文档撰写指南