常见问题解答 (FAQ)

当前阶段
文档开发。请参阅时间轴

常规

Google 文档季是一项招聘计划吗?

不可以。如果您有意加入 Google 团队,请访问 Google 招聘网站

我们组织想参与 Google 文档季活动,但不知道该从哪里着手

请查看我们的完整项目创意列表! 您还可以与技术写作社区联系(请尝试在 Write the Docs Slack 中的 #season-of-docs 频道或社交媒体渠道中寻求帮助或建议)。

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

以下是一些建议:

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

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

  • 撰写产品或功能的概念性概览或简介。 通常,团队会自下而上创建技术文档,结果是,文档中包含大量细节,但很难全面了解产品。技术文档工程师可以解决此问题。

  • 为重要用例创建教程。

  • 为特定任务创建一组专注的操作指南。

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

视频可以用于 Google 文档季吗?

可以。确保有明确的视频要求,并且要注意,制作高品质视频需要花费大量的时间和资源。

文档审核是 Google 文档季的合理项目吗?

文档审核是 Google 文档季的绝佳项目。请注意您已经有多少文档;如果数量很多,您可能需要缩小范围(例如,仅审核教程内容)。如果您没有或几乎没有文档,不妨在项目中添加创建缺失的优先级最高文档的任务。

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

Google 文档季提供了一个 GitHub 代码库,其中包含用于执行文档审核的模板和核对清单。随着其他模板的创建,我们也会相应地进行添加。

The Good Docs Project 正在努力为开源项目创建一些最低限度可行文档模板。

组织是否必须使用技术文案撰写者制作的文档?

不可以。项目有时会出现意外情况,或者要求会发生变化。我们不要求组织使用所生成的文档或其他材料,但我们希望最终评估和案例研究中包含有关未使用文档的原因以及项目如何决定不使用文档或其他材料的讨论。

“Google 文档季”在哪里举行?

Google 文档季完全在线举行。这项计划没有要求您出差。

如何随时了解 Google 文档季的最新动态?

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

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

使用 http://goo.gle/2NeZVew 订阅 Google 文档季节日历。

我可以做些什么来宣传 Google 文档季?

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

如何组织或举办 Google 文档季信息研讨会或聚会?

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

关于 2019 和 2020 年计划,有什么统计信息可以分享吗?

可以,您可以访问 Google 开源博客(2019 年2020 年)查看 2019 年 Google 文档季搜索结果。

我能否获得 Google 文档季节 T 恤?

不能,由于国际配送限制,Google 文档季无法再向成功完成 Google 文档季项目的参与者提供 T 恤衫。

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

请参阅组织管理员指南技术文档撰写者指南

如果您在阅读完所有文档后仍没有答案,请考虑与讨论列表中的 Google 文档季社区讨论您的问题。查看有关讨论渠道和如何与我们联系的信息。

如何成为 Google 文档季的导师?

Google 文档季没有正式的导师角色。在组织申请过程中,组织应指定如何引入和支持技术文档撰写者,以及如何审核和批准他们贡献的文档。如果您有兴趣在 Google 文档季期间指导技术文档工程师,请与您的组织管理员联系,以加入志愿者。

Google 文档季如 Google 编程之夏一样吗?

不可以。Google 文档季面向具有一定技术写作经验的人员,而非像 Google 编程夏令营那样提供指导。

面向技术文档作者

技术文档工程师何时可以申请参加 Google 文档季?

Google 文档季没有正式的技术文档撰写者申请表单。要以技术文档作者的身份参与 Google 文档季参与活动,请按照开源组织 Google 文档季计划页面上的说明直接与开源组织联系。您也可以将自己加入 Google 文档技术文档工程师目录,表达自己的兴趣。如需了解详情,请参阅技术文档编写者指南

参加 Google 文档季活动需要了解哪些文档工具和框架?

您将使用的文档工具和框架取决于您感兴趣的组织。Google 文档季的目标之一是通过开源项目帮助技术文档撰写者进一步了解编写开源产品文档所涉及的工具和框架。因此,在开始 Google 文档季项目之前,您通常不需要详细了解特定文档平台。

不过,大多数开源组织都会使用某种 Markdown 或其他标记语言来编写文档。我们建议您了解所选组织使用的语言,并熟悉相应语法。Markdown 是一个不错的起点,因为 GitHub README 文件使用的是 Markdown 的一种变体。请参阅 GitHub 的 Markdown 指南

了解您选择的组织是否已在网站上托管其文档,如果是,请了解他们使用的平台。该平台可能是静态网站生成器,例如 JekyllSphinxHugo,组织也可能在阅读文档GitHub 页面上托管其文档。确定组织使用的平台后,探索相关语言和框架并进行实验。这有助于您快速上手开源项目,并为您提供良好的条件,以便为您选择的开源项目提供切实的建议。

我需要掌握哪些编程语言才能参与 Google 文档季项目?

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

已经在某个开源项目中工作的技术文档撰写者是否可以在 Google 文档季继续参与该项目?

是的,但组织应在其提案中注明技术文档编写者之前或持续与项目的关系。

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

我需要具备技术文档撰写方面的先前经验或培训吗?

具有技术写作经验或接受过相关培训是理想人选,但不是必需条件。 在向某个组织提交意向声明时,您可以描述自己的经验或接受过的任何技术文档写作培训。您应能够提供一些证据来证明您对技术文档或开源文档感兴趣,包括您撰写的文档示例。开源组织将寻找具有组织所需经验水平的技术文档撰写者,以确保成功完成 Google 文档季项目。

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

可以。Google 将向获批的组织提供资助,以便其聘用技术文档撰写人员。

优秀的技术文档写作员应具备哪些能力?

技术文档撰写者在提交兴趣声明之前,最好先花些时间与所选的开源组织互动并讨论自己的想法。请参阅有关创建意向调查表的指南。

参与 Google 文档季需要多长时间?

项目规模各不相同,但在整个计划期间,每周的投入时间在 5-30 小时之间。不过,您需要花费的时间取决于您与贵组织商定的项目性质。在提交之前,您应评估项目并与开源组织讨论预计时间。

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

不可以,只有能够代表开源项目接收资金的人员才能提交提案。如果您有兴趣参与某个项目,请与该项目联系,共同制定应用提案。

我是一名学生,有资格参加 Google 文档季吗?Google 文档季会教我如何成为技术文档撰写者吗?

学生可以与已获批准的组织合作,但 Google 文档季并非旨在教授技术写作技能。参与的技术文案撰写者应具备专业的技术文案撰写技能或同等相关经验。有意参与的学生在申请时应务必突出自己的相关写作和编辑经验。

我可以同时以技术文档撰写者的身份参与 Google 文档季,并以学生的身份参与 Google 编程之夏吗?

我们不鼓励新贡献者或被 Google 编程之夏录取的学生申请成为 Google 文档之季技术文案撰写者。

Google 文档季不适合初学者,而是面向那些已经具备出色的技术写作技能和经验的人士。Google 文档季的技术文案撰写者不会获得指导,而是需要自行组织并积极主动,在组织管理员和其他社区成员的最低限度指导下,制定处理组织项目的计划。

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

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

技术文档编写公司或咨询公司可以参与 Google 文档季活动吗?

是的,组织可以聘请公司来完成其提案中概述的工作。

如何在简历中提及 Google 文档季?

像列出任何其他自由职业工作一样列出此项目:例如,“在 Google 文档季活动中,担任 [项目名称] 的技术文案撰写者”。

参加 Google 文档季活动是否能获得结业证书?

Google 文档季无法向技术文档撰写者发送项目参与证书或确认。

对于开源组织管理员

开源组织需要满足哪些资格要求?

若要以组织身份参与该计划,您必须是运营着活跃的免费或开源软件项目(例如 BRL-CAD)的团队。该项目不必是合法注册的实体。组织必须根据开放源代码促进会批准的许可制作和发布软件,并且至少有两位贡献者可在整个 Google 文档季活动期间担任组织管理员,才能参与该活动。

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

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

一个组织可以有一个或多个开源项目。某些组织(例如基金会)可能有多个子组织,而每个子组织又有一个或多个开源项目。如果贵组织有独立的子组织,请为每个子组织分别提交申请和提案。

一个组织可以提交多个提案申请吗?

不可以。每个组织只能提交一份申请。如果贵组织有子组织(例如,贵组织是一个拥有许多单独开源项目的基金会),则每个项目都应提交自己的申请,即使最终由总组织来处理补助资金也是如此。

一组开源项目是否可以一起提交提案,共同处理同一个文档项目?

一个组织应提交提案申请,并负责协调其他参与项目的工作和支持。(例如,如果一组小型开源项目都是某个大型项目的插件,并且希望共同编写有关创建插件的操作指南,则应选择一个组织来负责该项目。)

我的组织将如何收到款项?

为了接收款项,您的组织必须拥有 Open Collective 账号。

参与 Google 文档季的组织是否会获得任何金钱?

组织可以在项目预算中包含用于管理、指导或审核工作的资金。

Google 是否会承担付款处理费?

Google 不承担付款处理费用,因为这些费用通常因付款方式而异。不过,Google 会承担 Open Collective 平台费用,如果您决定使用 Open Collective 作为财务托管方,我们也会承担相应费用。如需了解详情,请参阅接收资助指南

我的组织应如何预算技术文档撰写者的费用?

我们建议您查看 Write the Google 文档工资调查问卷,并制定出每小时费率。您还可以加入 Write The Docs Slack 群组,并在 #season-of-docs 频道中发帖,邀请有兴趣的技术文档撰写者参与竞价。

我所在的组织可以使用 Google 文档季节性资助来支付现有贡献者的费用吗?

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

我的组织可以与技术文档撰写学生合作吗?

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

  • 年满 18 周岁
  • 正在攻读技术写作或技术沟通课程
  • 能够通过其计划或课程获得技术写作指导

我的组织可以有多个技术文档撰写者吗?

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

我的组织可以聘请技术文档编写公司来处理我们的项目吗?

可以,贵组织可以聘请技术写作公司来处理您的项目。请确保您聘请的公司能够通过 Open Collective 接收付款。

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

我们强烈建议项目在项目结束之前尝试找到新的技术文档工程师来完成您的项目。不过,剩余资金的拨款并非基于项目的完成情况,而是根据案例研究和最终评估的完成情况进行。

如果您的项目无法完成,案例研究应探讨原因。例如,您可能发现文档工具非常复杂,给新手技术文档撰写者带来了障碍;或者您的项目涉及测试和更新教程,需要丰富的编码经验。根据您的经验,您会向其他项目推荐哪些建议?请在案例中添加这些信息。

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

很抱歉,Google 文档季无法就组织申请提供反馈。

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

在制定项目构想时,请尽量找出能够为组织带来价值的最小项目(但如果时间允许,可以扩展)。越小越好。在创建项目提案时,我们建议您选择规模较小、更详细的项目,而不是规模较大、不太具体说明的项目。如果您的项目需要具备大量领域专业知识,请尝试添加可由没有相关背景的人员处理的项目。

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

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

我们组织参加了之前的 Google 文档季计划。我们的组织可以再次申请吗?

可以,参与过之前 Google 文档季活动的组织可以再次申请。

已归档数据

如何从 Google 文件季归档中移除我的信息?

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