当前阶段:
公布结果的时间表。
一般措施
文档季是招聘计划吗?
不可以。如果您有兴趣在 Google 工作,请访问 Google 招聘信息网站。
当前的计划与 Google 文档(2019 年)和 2020 季之间有何不同?
当前的文档季计划与往年相比有重大变更,包括:
- 技术文档工程师不再通过 Google 申请与组织匹配
- 组织在申请过程中提交项目提案,包括预算和提议的指标
- 获准的组织会获得公益金,用于向技术文档撰写人员支付报酬
- 组织提交最终评估结果和案例研究
《文档季》为何要进行这些更改?
Google 的使命是整合全球信息,供大众使用,使人人受益。通过重新聚焦于《文档季》,着重学习开源领域的有效文档做法,我们希望从长远来看能够产生更大的影响。
我们组织想要加入文档季,但是我们不知道从何处入手!
查看我们的项目创意完整列表! 您还可以联系技术写作社区(尝试访问编写 Google 文档 Slack 中的 #season-of-docs 频道,或通过社交媒体渠道寻求帮助或提案)。
组织可以建议哪些类型的项目?
以下是一些建议:
在由技术文档编写者和开源组织决定的平台上构建文档网站,并在网站上发布一组初始基本文档。平台示例:
重构开源项目的现有文档,以提供改进的用户体验或更无障碍的信息架构。
撰写产品或功能的概念性概览或简介。 通常,团队会从下往上创建技术文档,结果涉及大量细节,但很难从整体上了解产品。技术文档工程师可以解决此问题。
为备受关注的用例创建教程。
针对特定任务创建一套有针对性的方法指南。
创建贡献者指南,其中包括有关作为开源项目贡献者入门的基本信息,以及关于许可协议、拉取请求和审核流程、项目构建等的任何规则。
文档剧季可以采用视频项目吗?
可以。确保视频要求的范围很明确,并且要注意,制作高质量的视频需要花费大量的时间和资源。
文档审核是否为文档季的合理项目?
文档审核是“文档季”的绝佳项目。请留意您已经拥有的文档数量;如果您有很多文档,则可能需要缩小范围(例如,仅审核教程内容)。如果您的文档很少或没有文档,您可能需要创建优先级最高的缺失文档,作为项目的一部分。
是否有文档模板可供组织和技术文档工程师使用?
Season of Google 文档提供 GitHub 代码库,其中包含用于执行文档审核的模板和核对清单。我们希望在创建时添加其他模板。
Good Docs 项目正致力于为开源创建一些最低限度的可行文档模板。
组织是否需要使用技术文档撰写者提供的文档?
不会。项目偶尔会无法按预期运行,或要求发生变化。 我们不要求组织使用提供的文档或其他材料,但我们希望在最终评估和案例研究中探讨文档未被使用的原因,以及项目如何决定不使用这些文档或其他材料。
文档季会在哪里发布?
Google 文档的剧季完全在线。此计划无需出差。
如何及时了解文档季的最新消息?
访问通知邮寄名单 (season-of-docs-announce),了解与 Google 文档季有关的最新动态和公告。加入该群组即可通过电子邮件接收最新动态。
我可以将 Google 文档赛季时间轴添加到我的日历中吗?
可以,您可以通过此链接添加。
我需要做些什么来宣传 Google 文档季?
您可以在 Twitter 上发布关于该计划的信息、撰写博文、发布视频,或者在您所在的地区举办聚会或信息会议。我们提供了一些示例内容和资源,可供您用来向您的社区(组织、作者小组和其他联系人)分发。
如何组织或举办“Google 文档季”信息会议或聚会?
我们欢迎您在自己方便的任何时间和地点预约见面!请查看计划规则并使用示例内容。
对于 2019 年和 2020 年的 Google 文档,可以分享一些统计信息吗?
可以。您可以点击此处查看 2019 年计划的 Google 文档季结果,也可以点击此处查看 2020 年计划的结果。
我会获得一季 Google 文档 T 恤吗?
不能,由于国际运输限制,我们将无法再向成功完成其“文档季”项目的参与者提供 T 恤。
如果我还有其他疑问,该怎么办?
如果您通读所有文档后仍然没有找到答案,请考虑在讨论列表上与 Season of Google 文档社区讨论您的问题。请参阅有关讨论渠道的信息以及如何与我们联系。
如何成为《文档季》的导师?
Google 文档季没有正式的导师角色。组织应指定如何加入和支持技术文档工程师,以及他们贡献的文档将如何在组织申请过程中得到审核和批准。如果您有兴趣在文档季中指导技术文档撰写者,我们建议您与组织管理员合作,自愿参加培训。
Google 文档季是否像 Google 编程之夏一样?
不是。《Google 文档季》是面向具有一些技术写作经验的人员,而不是像 Google 编程之夏 (Summer of Code) 那样的指导计划。
面向技术文档撰写人员
技术文档撰写人何时可以申请启用文档季?
《Google 文档季》没有正式的技术文档作者申请。 要以技术文档作者的身份参与使用《文档季》,请直接与开源组织联系,具体说明请参阅其“文档季”计划页面中的说明。您还可以将自己的信息添加到文档季技术文档作者目录中,以表达您的兴趣。如需了解详情,请参阅技术文档撰写指南。
要参加文档季,我应该知道哪些文档工具和框架?
您将使用的文档工具和框架取决于您打算使用的组织。“Season of Google”文档的部分目标是开发开源项目,帮助技术文档作者详细了解为开源产品编写文档所涉及的工具和框架。因此,在开始您的 Season of Google 文档项目之前,通常不要求您详细了解特定文档平台。
尽管如此,大多数开源组织都在其文档中使用某种形式的 Markdown 或其他标记语言。我们建议您了解所选组织使用的语言并熟悉语法。Markdown 是一个好的起点,因为 GitHub README 文件使用的是 Markdown 的变种。请参阅有关 Markdown 的 GitHub 指南。
了解您选择的组织是否已经将其文档托管在某个网站上,以及他们使用什么平台。该平台可以是静态网站生成器(例如 Jekyll、Sphinx 或 Hugo),也可能是组织在阅读文档或 GitHub 页面上托管其文档。确定组织使用的平台后,请探索和试验相关语言和框架。这可帮助您快速开始您的开源项目,并为您选择的开源项目提供合理的建议。
要参与 Google 文档季度项目,我应该掌握什么编程语言?
根据文档项目的性质,您可能需要熟悉编程语言。在选择和建议文档项目时请记住这一点,并咨询开源组织以了解所需的熟悉程度。
已经在从事某个开源项目的技术文档作者能否继续在 Google 文档季中继续进行相关工作?
可以,但组织应该在提案中注明技术文档工程师之前或持续与项目之间的关系。
参与该计划需满足哪些资格要求?
- 您必须居住在美国目前未实施禁运的国家/地区。请参阅计划规则以及美国财政部的制裁计划和国家/地区信息。
我需要拥有作为技术文档工程师的经验或培训吗?
优先考虑拥有技术写作经验或接受培训,但并非硬性要求。 向组织提交意向声明时,您可以采用技术文案来描述自己的体验和/或培训。您应该能够提供一些证据,证明您对技术文档或开源文档感兴趣,包括您编写的文档示例。开源组织将寻找具备该组织所需经验水平的技术文案,以确保成功完成其 Google 文档季项目。
参与“Google 文档季”后会获得收入吗?
可以。Google 将向获批的组织提供补助金,以聘用技术文档工程师。
优秀的技术文档撰写者意向陈述应包含哪些内容?
最棒的意向陈述来自技术文档工程师,他们会花时间与所选的开源组织互动并讨论他们的想法,然后在提交他们的声明之前。请参阅有关创建意向陈述的指南。
参加文档季度需要多长时间?
项目规模各不相同,但在计划期间每周的承诺量为 5-30 小时。但是,所需时间取决于您与组织达成一致的项目的性质。在提交之前,您应该评估项目,并与开源组织讨论估算时间。
我可以以个人身份提交为开源项目创建文档的组织申请吗?我想创作一系列有关如何使用某个开源项目或工具的博文、视频或其他资料,但我不是该项目的参与人员,也不是该项目的贡献者。
不可以,只有在您能够代表开源项目接收资金时,才应提交提案。我们建议您联系该项目,并就申请方案进行协作。
我是学生,我有资格使用文档季吗?《文档季》会教我成为技术文档工程师吗?
学生可以与被接受的组织合作,但《文档季》并非旨在教授技术写作技能。我们希望参与此计划的技术文档作者具备专业的技术文档撰写技能或同等的相关经验。希望参与的学生在联系感兴趣的组织和项目时,一定要着重介绍自己在写作和编辑方面的相关经验。
我能否同时担任《文档季》的技术文档工程师和 Google 编程之夏的学生?
虽然这目前并不违反规则,但我们强烈建议接受 Google 编程之夏的学生不要申请成为 Google 文档季的技术作家。学生应专注于 Google 编程之夏工作,而非申请《文档季》。
此外,《Google 文档季》不适合初学者,而是面向已经具备扎实甚至很强的技术写作技能和经验的人士。《Google 文档季》中的技术文档工程师没有接受指导,而是需要自主组织和积极制定计划,在组织管理员和其他社区成员的指导下完成组织项目。
作为技术文档撰写人,如果我有其他问题或疑虑,如何与 Google 文档季的 Google 计划管理员联系?
您可以向 season-of-docs@google.com 发送电子邮件,与 Google 文档季的 Google 计划管理员联系。
技术写作公司或咨询公司是否可以参与文档季?
是的,组织可以聘用公司来完成其提案中列出的工作。
如何在简历中引用文档季?
像其他自由职业工作一样列出该职位,例如“在 Google 文档季计划中担任过 [项目名称] 的技术文档工程师”。
你们是否提供参与文档赛季的结业证书?
我们无法向技术文档工程师发送项目参与证书或确认函。
面向开源组织管理员
开源组织有哪些资格要求?
如需以组织身份参与计划,您必须是运行活跃的免费/开源软件项目(例如 BRL-CAD)的团体。该项目不必是合法注册的实体。要参与该计划,组织必须已根据开源计划批准的许可制作和发布软件,并且至少有两名贡献者担任整个文档季计划的组织管理员。
另请参阅计划规则中所述的资格要求以及美国财政部的制裁计划和国家/地区信息。
“组织”等同于开源项目吗?
一个组织可以有一个或多个开源项目。某些组织(如基金会)可能有多个子组织,每个子组织都有一个或多个开源项目。如果您的组织具有独立的下级组织,请为每个子组织分别提交单独的应用和提案。
一个组织能否提交多个提案申请?
不可以。每个组织只能提交一份申请。如果您的组织有下级组织(例如,您的组织是拥有许多单独的开源项目的基础),那么即使补助资金将由伞形组织处理,每个项目也应提交自己的申请。
一组开源项目是否可以一起提交针对单个文档项目的提案?
一个组织应提交提案申请,并负责协调其他参与项目的工作和支持。(例如,如果有一组小型开源项目是某个大型项目的插件,而这些项目希望编写插件创建联合方法指南,则应选择一个组织来主导该项目。)
我的组织如何接收资金?
为了接收资金,您的组织必须有一个 Open Collective 帐号。
组织是否因参与 Google 文档季而获得任何收入?
组织可以将管理、指导或审查工作的资金作为其项目预算的一部分。
Google 是否承担付款手续费?
Google 不承担付款手续费,因为具体手续费因付款方式而异。不过,Open Collective 平台费用由 Google 承担,如果您决定使用 Open Collective 作为财务主机,该费用也包括在内。如需了解详情,请参阅受助公益金指南。
我的组织应该如何预算安排技术文档工程师的费用?
建议您参阅撰写 Google 文档工资调查问卷,并确定每小时费率。您还可以加入 Write TheDocs Slack,在 #season-of-docs 频道中邀请感兴趣的技术文档工程师出价。
我的组织可以使用《文档季》授权向当前贡献者付费吗?
可以。但是,项目提案必须针对新工作(包括维护工作、修订或现有文档升级)。您不得申请用于为已完成工作付费的补助金。
我的组织可以与学生技术文档工程师合作吗?
您可以选择让学生技术文档工程师完成您的项目。如果您选择与学生合作,我们强烈建议您仅限符合以下条件的学生参与:
- 年满 18 周岁
- 已报名参加技术写作或技术沟通课程
- 能够证明自己是通过相关课程或课程获得技术写作指导
我的组织可以与多个技术文档工程师合作吗?
您的组织可以选择多位技术文档工程师并向其支付薪酬,但与您的组织合作的所有技术文档作者都必须负责您提议的项目。与多名技术文档工程师合作会增加项目的复杂性,并需要更多的志愿者和管理时间。
我的组织可以聘请技术写作公司来参与我们的项目吗?
是的,你的组织可能会聘请技术写作公司来处理你的项目。请确保您聘用的公司能够通过 Open Collective 获得付款。
我们的技术文档工程师在计划结束前退出。我们是否仍有资格接收剩余资金?
我们强烈建议您在计划结束之前尝试寻找新的技术文档工程师来完成您的项目。不过,剩余资金的发放并非取决于项目完成情况,而是案例研究和最终评估的完成情况。
如果您的项目无法完成,我们希望您的案例研究能够对此进行调查。例如,您可能发现您的文档工具非常复杂,这成为了入职技术文档工程师的障碍,或者您的项目涉及测试和更新教程并且需要丰富的编码经验。根据您的经验,您会推荐其他项目有哪些? 请在案例研究中包含这些信息。
能否在提交截止日期之前审核组织申请?
很抱歉,我们无法就组织申请提供反馈。
组织应如何确定项目提案的范围?
在制定项目创意时,请尝试找到可为组织带来价值的最小项目(但如果时间允许,可以进行扩展)。越小越好。在创建项目提案时,我们建议您坚持创建较小、更详细的项目,而不是指定较少的较大项目。如果您的项目需要很多专业领域知识,请尽量包含一些可由无该背景的人处理的项目。
我能以组织管理员的身份参加 Google 文档季的竞赛和 Google 编程之夏的导师吗?
可以。Google 文档季和 Google 编程之夏是两个不同的计划。如果您有足够的带宽同时参加这两个计划,也没有关系。
我们组织参与了上一季度的 Google 文档计划。我们是否符合重新申请的条件?
可以,曾参与过上一季度 Google 文档计划的组织可以重新申请。
已归档数据
如何从文档季存档中删除我的信息?
请与我们联系以移除您的信息。