常见问题解答 (FAQ)

当前阶段
“2021 文档季”计划已于 2021 年 12 月 14 日结束。请参阅时间表

常规

《文档季》是招聘计划吗?

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

2021 赛季 Google 文档有哪些变化?

与往年相比,2021 年文档的赛季发生了重大变化,包括:

  • 技术文档工程师不再通过 Google 申请与组织匹配
  • 组织在申请过程中提交项目提案,包括预算和提议的指标
  • 被接受的组织会收到公益金,用于支付技术文档撰写费用
  • 组织提交最终评估和案例研究

为什么《文档季》进行了这些更改?

Google 的使命是整合全球信息,供大众使用,使人人受益。通过重新聚焦于《文档季》,强调学习开源方面的有效文档实践,我们希望长期取得更大的影响。

我们组织想参与 2021 年 Google 文档赛季,但不知道从何处入手!

查看我们的项目创意完整列表! 您还可以与技术写作社区联系(尝试访问编写 Google 文档 Slack 中的 #season-of-docs 频道,或通过社交媒体渠道寻求帮助或提案。

组织可以提出哪些类型的项目?

以下是一些建议:

  • 在由技术文案和开源组织决定的平台上构建文档网站,并在网站上发布一组初始基本文档。平台示例包括:

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

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

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

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

  • 创建贡献者指南,其中包含有关以开源项目贡献者的身份开始的基本信息,以及有关许可协议、拉取请求和审核流程、项目构建等方面的所有规则。

视频季是否可用于文档季?

是的。确保视频要求范围明确,并要注意制作高质量的视频需要大量的时间和资源。

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

文档审核是针对文档季开展的绝佳项目。请留意您已经拥有的文档量;如果您有大量文档,则可能需要缩小范围(例如,仅审核教程内容)。如果您的文档很少或没有文档,您可能需要在项目中添加优先级最高的缺失文档。

是否有文档模板可供组织和技术文档撰写人员使用?

《文档季》提供了一个 GitHub 代码库,其中包含用于执行文档审核的模板和核对清单。我们希望可以在创建其他模板时添加这些模板。

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

组织是否需要使用技术文档撰写人员生成的文档?

不会。有时候,项目的效果与预期不符,或要求发生了变化。我们不要求组织使用提供的文档或其他材料,但希望最终评估和案例研究中会讨论文档未被使用的原因,以及项目如何决定不使用本文档或其他材料。

文档季在什么地方出现?

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

如何随时了解文档季的相关信息?

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

我可以将 Google 文档季的时间轴添加到我的日历吗?

可以,您可以通过此链接进行添加。

我该做些什么来帮助宣传 Google 文档季?

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

如何组织或主持“文档季”信息会议或聚会?

欢迎您在方便的任何时间和地点安排聚会!请查看计划规则并使用示例内容

关于 2019 年和 2020 年的 Google 文档,可以分享一些统计信息吗?

可以。您可以点击此处查看 2019 年计划的 Google 文档季成绩,也可以点击此处查看 2020 年的计划结果。

我能获得一季文档 T 恤吗?

不能,由于国际运输限制,我们无法再向成功完成其“文档季”项目的参与者提供 T 恤。

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

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

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

如何成为文档季的导师?

2021 赛季没有正式的导师角色。组织应指定如何入职和支持技术文档工程师,以及他们的文档贡献将如何在组织申请过程中得到审核和批准。如果您有兴趣通过文档季指导技术文档作者,我们建议您与组织管理员合作,自愿提供指导。

文档季是否像 Google 编程之夏一样?

不是。Google 文档季面向具备一些技术写作经验的人员,而不是像 Google 编程之夏 (Summer of Code) 这样的指导计划。

面向技术文档撰写人员

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

2021 赛季还没有正式的技术文档撰写申请。 若要以技术文档作者的身份参与 2021 年 Google 文档赛季计划,请按照开源组织的说明,直接与开源组织联系。您也可以将自己的信息添加到《文档季技术文档》季中,以表达您的兴趣。如需了解详情,请参阅技术文档撰写指南

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

您要使用的文档工具和框架取决于您感兴趣的组织。《文档季》的一部分内容是针对开源项目,以帮助技术文档作者详细了解为开源产品编写文档时所涉及的工具和框架。因此,在开始您的季度项目之前,通常不要求您具备特定文档平台的详细知识。

也就是说,大多数开源组织都会在其文档中使用某种形式的 Markdown 或其他标记语言。我们建议您了解所选组织使用的语言并熟悉语法。Markdown 是一个良好的开端,因为 GitHub README 文件使用的是 Markdown 风格。请参阅 GitHub 中的 Markdown 指南

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

要参与文档季项目,我应该了解什么编程语言?

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

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

可以,但组织应该在其提案中注明技术文档工程师之前或持续与项目的关系。

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

我是否需要拥有技术文档工程师的相关经验或培训?

最好有技术写作经验或接受过培训,但并非必须如此。 向组织提交意向声明时,您可以描述自己的技术写作经验和/或培训。您应该能够提供一些证据,证明您对技术文档或开源文档感兴趣,包括您编写的文档示例。开源组织将寻找具有组织所需经验水平的技术文档撰写者,以确保成功完成其文档季项目。

参与 Season of Google 文档能获得报酬吗?

是的。Google 将向被接受的组织提供补助金,用于雇用技术撰稿人。

适合的技术文档撰写者意向陈述应是什么样的?

最佳意向声明来自于技术文档作者,他们会花时间与所选的开源组织互动并讨论他们的想法,然后在提交他们的声明之前。请参阅有关创建兴趣对账单的指南。

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

项目规模不尽相同,但在计划期间每周需要 5-30 小时。但是,您花费的时间取决于您与组织达成一致的项目的性质。在提交之前,您应该评估项目并与开源组织讨论估算时间。

我是否可以以个人身份提交组织申请,以便为开源项目创建文档?我想创建一系列关于如何使用某个开源项目或工具的博文、视频或其他资料,但我不是该项目的参与人员,也不是该项目的贡献者。

不可以,只有当您能够代表开源项目接收资金时,才应提交提案。我们建议您与该项目联系,就应用提案进行协作。

我是一名学生,是否有资格参加 2021 文档季?《文档季》会教我成为一名技术文档作者吗?

学生可以与被接受的组织合作,但《文档季》并不旨在教授技术写作技能。我们希望参与该计划的技术文档撰写者具备专业的技术写作技能或同等的相关经验。希望参与调查的学生在联系感兴趣的组织和项目时,一定要着重介绍他们的相关写作和编辑经验。

我可以同时参加 Google 文档季的技术撰稿人和 Google 编程之夏学生吗?

虽然这目前并未违反规定,但我们强烈建议接受 Google 编程之夏的学生不要申请成为 Google 文档季技术文档作者。学生应该专注于 Google 编程之夏作业,而不是申请文档季。

此外,Season of Google 文档不适用于初学者,而是面向已具备扎实到优秀的技术写作技能和经验的人士。《文档季》中的技术文档作者没有受过指导,而是需要有条不紊地开展工作,并积极主动地在组织管理员和其他社区成员的指导极少的情况下,制定计划处理组织项目。

作为技术撰稿人,如果我有其他问题或疑虑,如何与 Google 文档季的 Google 计划管理员联系?

您可以向 Google 计划管理员 season-of-docs@google.com 发送电子邮件,与 Google 文档季的管理员联系。

技术写作公司或咨询公司可以参加 Google 文档季吗?

是的,组织可以聘用公司来执行其提案中列出的工作。

如何在简历中引用文档季?

像在任何其他自由职业工作中一样列示工作内容,例如“在文档季计划中担任过 [项目名称] 的技术文档工程师。”

你们是否提供参加文档季的结业证书?

我们无法向技术文档撰写人发送项目参与证明或确认函。

面向开源组织管理员

开源组织有哪些资格要求?

若要有资格以组织身份参与该计划,您必须是运行有效的免费/开源软件项目(例如 BRL-CAD)的团体。该项目不一定是合法成立的实体。要参与该计划,组织必须根据开放源代码促进会批准的许可制作和发布软件,并且至少有两名贡献者担任整个“文档季”计划的组织管理员。

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

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

一个组织可以有一个或多个开源项目。某些组织(如基础组织)可能有多个子组织,而每个子组织都有一个或多个开源项目。如果贵组织有独立的下级组织,请为每个下级组织提交单独的应用和提案。

一个组织能否提交多个提案申请?

不可以。每个组织只能提交一份申请。如果您的组织有下级组织(例如,您的组织是拥有许多单独开源项目的基础),那么即使拨款资金将由伞形组织处理,每个项目也应提交自己的申请。

一组开源项目能否一起提交处理单个文档项目的提案?

一个组织应提交提案申请,并负责协调其他参与项目的工作和支持。(例如,如果有一组小型开源项目,这些项目全部是大型项目的插件,而他们希望编写用于创建插件的联合方法指南,则应选择一个组织来主导该项目。)

我的组织如何接收资金?

为了接收资金,您的组织必须有一个 Open Collective 帐号。

组织是否会因参与 Season of Google 文档而获得收入?

组织可以将管理、指导或评估工作的资金纳入其项目预算中。

我的组织应如何预算安排技术文档撰写人员的费用?

建议您查看撰写 Google 文档工资调查问卷,并确定每小时费率。您还可以加入编写文档 Slack 计划,在 #season-of-docs 频道中邀请感兴趣的技术文档作者出价。

我的组织可以使用“文档季”补助支付当前贡献者的费用吗?

是的。但是,项目提案必须针对新工作(包括维护工作、修订或升级现有文档)。您不得申请用于为已完成工作付费的补助金。

我的组织可以与学生技术文档工程师合作吗?

您可以选择让学生技术文档工程师完成您的项目。如果您选择与学生合作,我们强烈建议您仅限符合以下条件的学生参与:

  • 年满 18 周岁
  • 已报名参加技术写作或技术通信计划或课程
  • 能够亲身体验过技术写作指导(通过课程或课程)

我的组织可以与多个技术文档工程师合作吗?

您的组织可能会选择多位技术文档撰写者并向其支付薪酬,但与您的组织合作的所有技术文档作者都必须参与您提议的项目。与多位技术文档工程师合作会增加项目的复杂性,并需要更多的志愿者和管理时间。

我的组织可以聘请技术写作公司来完成我们的项目吗?

是的,您的组织可能会聘请技术文案公司来完成您的项目。请确保您聘用的公司能够通过 Open Collective 获得付款。

我们的技术文档工程师在计划结束前退出了。我们是否仍有资格接收剩余资金?

我们强烈建议您在计划结束之前尝试寻找新的技术文档工程师来完成您的项目。但是,剩余资金的支付并非基于项目完成,而是基于案例研究和最终评估的完成。

如果您的项目无法完成,我们希望您的案例研究能够查明原因。例如,您可能会发现,您的文档工具非常复杂,这成为了入职技术文档工程师的障碍,或者您的项目涉及测试和更新教程,并且需要丰富的编码经验。根据您的经验,您会向其他项目推荐哪些项目? 请在案例研究中包含这些信息。

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

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

组织应如何确定项目提案的范围?

在制定项目创意时,请尝试寻找能够为组织提供价值的最小项目(但如果时间允许,还可以将项目扩展)。越小越好。创建项目提案时,我们建议您坚持使用较小、更详细的项目,而不是指定较少的较大项目。如果您的项目需要大量的领域专业知识,请尝试添加可由没有该背景的人员处理的项目。

我能以组织管理员的身份参加 Google 文档季计划,并以导师的身份参加 Google 编程之夏计划吗?

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

我们的组织参与了上一季的 Google 文档计划。我们符合再次申请的条件吗?

可以,参与过上一季 Google 文档计划的组织可以再次申请。

已归档的数据

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

如需移除您的信息,请与我们联系