常见问题解答 (FAQ)

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

一般措施

文档季是招聘计划吗?

不可以。如果您有兴趣在 Google 工作,请访问 Google 招聘信息网站

《文档季》是否属于实习、工作或任何形式的雇佣关系?

不是。“文档季”是技术文档撰写者作为独立的技术文档撰写者进行的活动,可获得报酬。技术文档工程师可以选择不接收助学金。

为什么我要参加文档季?

Season of Google 文档的目标是促进开源组织与技术文档撰写者之间的协作。我们认为这项计划将会:

  • 让技术文档工程师有机会获得为开源项目做贡献的经验,并学习开源代码。
  • 让开源项目有机会与技术写作社区互动,从而改进其开源文档。
  • 提高对开源文档和技术写作的认识。

为开源组织带来的益处:

  • 拥有与技术文档工程师合作的经验。
  • 改进了文档。
  • 在文档季结束之后,仍有机会与技术文档工程师进行持续协作。
  • 改进了项目文档记录流程。
  • 提升了技术写作社区中对开源文档的认识。

给技术文档工程师带来的好处:

  • 拥有为开源项目做贡献的经验。
  • 拥有使用面向开发者的文档和代码的经验。
  • 所做工作的信用和认可。
  • 可添加到简历中的内容。
  • 在 Google 文档销售季结束后,与开源项目进行持续协作的可能性
  • 在开源社区中提升对技术文档工程师可以带来的价值的认知。

技术文档工程师可以完成哪些类型的项目?

以下是一些建议:

  • 在一个平台上构建文档网站,由技术文档撰写者和开源导师决定,并在网站上发布一组初始基本文档。平台示例:

  • 重构开源项目的现有文档,以提供改进的用户体验或更无障碍的信息架构。

  • 撰写产品或功能的概念性概览或简介。 通常,团队会从下往上创建技术文档,结果涉及大量细节,但很难从整体上了解产品。技术文档工程师可以解决此问题。

  • 为备受关注的用例创建教程。

  • 针对特定任务创建一套有针对性的方法指南。

  • 创建贡献者指南,其中包括有关作为开源项目贡献者入门的基本信息,以及关于许可协议、拉取请求和审核流程、项目构建等的任何规则。

文档剧季可以采用视频项目吗?

可以。开源组织负责发布项目创意以及选择由技术文档撰写者提交的项目提案。如果视频符合开源组织的要求,那么您可以将视频剧季提交为文档剧季,前提是该视频是技术说明视频。确保视频要求的范围是广泛的,并且要注意,制作高质量的视频需要时间和资源。

指导组织是否需要使用技术文档撰写者撰写的文档?

不需要。尽管我们希望此计划中的所有文档和代码都能找到一个安家,但我们不要求组织使用技术文档撰写者的文档或代码。

文档季会在哪里发布?

Google 文档的剧季完全在线。此计划无需出差。

如何及时了解文档季的最新消息?

访问通知邮寄名单 (season-of-docs-announce),了解与 Google 文档季有关的最新动态和公告。加入该群组即可通过电子邮件接收最新动态。

我需要做些什么来宣传 Google 文档季?

您可以在 Twitter 上发布关于该计划的信息、撰写博文、发布视频,或者在您所在的地区举办聚会或信息会议。我们提供了一些示例内容和资源,可供您用来向您的社区(组织、作者小组和其他联系人)分发。

如何组织或举办“Google 文档季”信息会议或聚会?

我们欢迎您在自己方便的任何时间和地点预约见面!请查看计划规则并使用示例内容

我可以以导师和技术文档作者的身份参与“Google 文档季”吗?

不会。我们希望确保每个项目和技术文档工程师都得到足够的关注,我们认为这可能会给参与人员带来糟糕的体验。请选择作为导师还是技术文档工程师对自己更有吸引力,并相应地制定计划。

关于 2019 年 Google 文档季,有没有可以分享的统计信息?

可以。您可以点击此处查看 2019 年计划的 Google 文档季成效。

我会获得一季 Google 文档 T 恤吗?

是的!已完成项目的技术写作家和导师将收到一个季度的 Google 文档 T 恤。

我的 T 恤什么时候能到?

我们估计您在 2021 年初会收到 T 恤。Google 聘请了一家供应商来生产 T 恤,并负责处理在全球范围内运输的物流事宜。在长期项目结果公布后,Google 计划管理员将通过电子邮件向您发送唯一的访问代码,用于选择您的 T 恤样式/尺寸,并输入配送详细信息。生产和配送 T 恤通常需要几周。

如果我还有其他疑问,该怎么办?

查看技术文档撰写指南导师指南组织管理员指南

如果您通读所有文档后仍然没有找到答案,请考虑在 Slack 或讨论列表中与 Season of Google 文档社区讨论您的问题。请参阅有关讨论渠道的信息以及如何与我们联系

面向技术文档撰写人员

技术文档撰写人何时可以申请启用文档季?

技术写入者应用阶段从 2020 年 6 月 9 日持续到 2020 年 7 月 9 日。请参阅计划时间表技术文档撰写指南

要参加文档季,我应该知道哪些文档工具和框架?

您将使用的文档工具和框架取决于您打算使用的组织。Season of Google 文档的部分目标在于开源项目,帮助技术文档作者详细了解为开源产品编写文档所涉及的工具和框架。因此,在开始您的 Season of Google 文档项目之前,我们通常不要求您详细了解特定文档平台。

尽管如此,大多数开源组织都在其文档中使用某种形式的 Markdown 或其他标记语言。我们建议您了解所选组织使用的语言并熟悉语法。Markdown 是一个好的起点,因为 GitHub README 文件使用的是 Markdown 的变种。请参阅有关 Markdown 的 GitHub 指南

了解您选择的组织是否已经将其文档托管在某个网站上,以及他们使用什么平台。该平台可以是静态网站生成器(例如 JekyllSphinxHugo),也可能是组织在阅读文档GitHub 页面上托管其文档。确定组织使用的平台后,请探索和试验相关语言和框架。这可帮助您快速开始您的开源项目,并为您选择的开源项目提供合理的建议。

要使用文档季,我应该掌握什么编程语言?

根据文档项目的性质,您可能需要熟悉编程语言。在选择和建议文档项目时请记住这一点,并咨询开源组织以了解所需的熟悉程度。

我可以提交多个项目提案吗?

可以,但每位技术文档工程师只能接受一个项目提案。请参阅创建应用指南。

已经在从事某个开源项目的技术文档作者能否继续在 Google 文档季中继续进行相关工作?

可以,但您应该注明您之前与提案中项目的关系。

群组成员能否共同提交一份提案以处理单个项目?

不可以,一个项目只能由个人完成。

在向 Season of Google 文档提交提案之前,我可以直接与指导组织联系吗?

可以。在提交“文档季”申请之前,您可以直接与有意合作的开源组织沟通。开源导师可以帮助您完善项目构思。

参与该计划需满足哪些资格要求?

  • 注册时必须年满 18 周岁。
  • 在该计划期间,您必须符合在将要居住的国家/地区工作的条件。
  • 您必须居住在美国目前未实施禁运的国家/地区。请参阅计划规则以及美国财政部的制裁计划和国家/地区信息

你们会在资格要求上破例吗?

不会。如果您不符合资格要求,我们不能破例,无论您的才华或兴趣如何。让你破例不对其他申请参与文档季的技术写手不公平。

我需要提供哪些表单?

获批的参与者需要提供相应的纳税表单

我需要拥有作为技术文档工程师的经验或培训吗?

优先考虑拥有技术写作经验或接受培训,但并非硬性要求。 提交项目提案时,您可以用技术文案来描述您的经验和/或培训内容。您应该能够提供一些证据,证明您对技术文档或开源文档感兴趣,包括您编写的文档示例。“文档季”计划旨在与经验丰富或正在接受培训的技术文档作者和开源导师合作,以便每个人都可以相互学习。开源组织将寻找具备该组织所需经验水平的技术文案,以确保成功完成其“Google 文档季”项目。

参与“Google 文档季”后会获得收入吗?

可以。Google 将为成功完成该项目的技术文案提供资助。您可以选择不接收资助。请参阅技术文档撰写助学金的详细信息。

即使相关组织不使用我的文档或代码,我也会获得报酬吗?

可以,前提是您的项目通过了开源导师的最终评估。开源项目是否使用生成的文档或代码不会影响技术文档撰写者奖金的支付。

优秀的技术文档工程师应该具备什么样的提案?

最佳方案来自于技术文档工程师,他们会花时间与所选的开源组织进行互动并讨论他们的想法,然后再提交其“Google 文档”季应用。请参阅创建应用指南。

参加文档季度需要多长时间?

所需时间取决于您与导师组织达成的项目的性质。对小时数的要求特意调整了,以便支持不同类型的项目和不同的工作风格。平均而言,技术文档工程师每周要投入 20-30 个小时的时间。

在提交项目提案之前,您应该评估项目并与开源组织讨论估算时间。如果您由于其他承诺而无法花费约定的时间,则可以选择在更长的时间内完成项目,并且仍然可以获得已完成的工作的补助和确认。当您提交 Google 文档季应用时,请为长时间运行的项目指定选项。

我主修技术传播,但还没有任何工作经验。我还可以参加吗?

可以。提交项目提案时,请在此部分列出您所属大学或学院的课程,以便您先了解相关工作经验。

我是持有 F1 签证的美国境内录取学生。如何获得授权?

如需了解详情,请与您学校的国际学生事务处联系。Google 无法为您提供任何类型的 CPT 或 OPT 授权。

所有被录用的参与者都会收到一封确认邮件,确认他们接受了会议。我们不提供自定义字母。

Season of Google 文档如何使用我的申请表中的信息?

Google 计划管理员会将您应用中的一些信息传递给您选择的开源组织的管理员,以便该组织可以评估您的项目提案。

如果您的项目获准加入该计划,《文档季》会将项目详细信息发布到该网站上。

请参阅技术文档撰写申请表单指南,了解数据使用方式的说明。

我能否同时担任《文档季》的技术文档工程师和 Google 编程之夏的学生?

虽然这目前并不违反规则,但我们强烈建议获准参加 Google 编程之夏的学生不要申请参加 Google 文档季技术文档撰写者名额。学生应全心投入 Google 编程之夏,而非申请“Google 文档季”。

面向开源导师和组织管理员

我想详细了解如何以导师身份使用 Season of Google 文档。在哪里可以找到更多信息?

如需详细了解如何成为一个季度的 Google 文档导师,请阅读导师指南计划规则

指导组织有哪些资格要求?

如需有资格以指导组织的身份参与计划,您必须是运行活跃免费/开源软件项目(例如 BRL-CAD)的团体。该项目不必是合法注册的实体。要参与该计划,指导组织必须已经根据开源计划批准的许可制作和发布软件,并且至少有两名贡献者担任整个 Google 文档季计划的组织管理员和/或导师。

另请参阅计划规则中所述的资格要求以及美国财政部的制裁计划和国家/地区信息

“组织”等同于开源项目吗?

一个组织可以有一个或多个开源项目。某些组织(如基金会)可能有多个下级组织,而每个下级组织又有一个或多个开源项目。如果贵组织有独立的下级组织,请在申请中明确说明。例如,编程语言“Foo”可应用于整个语言以及使用该语言使用的任何插件、库或模块的文档。

组织是否因参与 Google 文档季而获得任何收入?

在计划结束时,信誉良好的组织将为每个被认可的技术文档作者提供津贴。这与技术文档工程师的项目成功与否无关。组织可以自由使用这些资金。

Google 计划管理员如何为技术编写项目分配名额?

“文档季”的 2020 赛季总共最多包含 50 个技术撰写项目。

作为准则,我们预计每个组织最多接受 2 个项目,以避免最终接受的项目过多。但是,如果免费选择过程无法填满所有槽位,Google 计划管理员可以为某些组织分配额外的槽。

因此,在发送您选择的技术编写项目时,您可以选择 2 个以上的项目。请务必按优先级顺序列出您的选择,并将优先级最高的置于列表顶部。

在与技术文档工程师沟通时,您应明确说明:在 Google 计划管理员在计划网站上发布已接受项目的列表之前,项目不会被接受。

能否在提交截止日期之前审核组织申请?

很抱歉,我们无法就组织申请提供反馈。

组织应该如何确定项目创意的范围?

许多项目会随着项目进度而改变。作为导师,您应了解项目发生的任何变化,并尽量减少范围扩散,并在适当的情况下缩小范围。在构思项目创意时,尽量找到能为组织带来价值的最小项目(但如果时间允许,还可以进行扩展)。越小越好。在评估技术文档工程师的提案时,我们建议您优先选择较小、更详细的提案,而不是具体说明较少的大型项目。如果您的项目需要大量的领域专业知识,请尽量添加可由无该背景的人处理的项目。

文档审核是否为文档季的合理项目?

文档审核是“文档季”的绝佳项目。请注意您已掌握的文档数量;如果您有很多文档,可能需要缩小范围(例如,仅审核教程内容)。如果您的文档很少或根本没有文档,您可能需要创建优先级最高的缺失文档,作为项目的一部分。

是否有文档模板可供组织和技术文档工程师使用?

Good Docs Project 正致力于为开源创建一些最低限度的可行文档模板。

我能以组织管理员和导师身份参与文档赛季计划吗?

可以。组织管理员还可以是导师。您无需另外填写导师表单。在填写组织申请表单或备用管理员表单时,您应该使用此表单上的选项来表明您也是导师。

我可以以组织管理员或导师的身份参与 Google 文档季和 Google 编程之夏计划吗?

可以。Google 文档季和 Google 编程之夏是两个不同的计划。如果您有足够的带宽同时参加这两个计划,也没有关系。

我可以以组织管理员或导师的身份参与季节性文档和 Google Code-in 吗?

可以。Google 文档季和 Google Code-in 是两个不同的计划。如果您有足够的带宽同时参加这两个计划,也没有关系。

已归档数据

如何从文档季存档中删除我的信息?

与我们联系以移除您的信息。