常见问题解答 (FAQ)

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

常规

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

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

目前的计划与 Google 文档 2019 和 2020 季有何不同？

与往年相比，当前的 Google 文档季活动发生了重大变化，包括：

  • 技术文档工程师不再通过 Google 申请与组织匹配
  • 组织在申请中提交项目提案，其中包括预算和拟议指标
  • 获批的组织会获得补助，可用于支付技术文档撰写者的薪酬
  • 组织提交最终评估和案例研究

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 文档季的时间表添加到日历中吗？

可以，您可以通过此链接添加它。

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

您可以通过推文宣传该计划、撰写博文、发布视频，或在您所在地区举办 Meetup 活动或信息会议。我们提供了一些示例内容和资源，供您分发给社区（组织、作者群组和其他联系人）。

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

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

您能否分享一下 2019 年和 2020 年文档季的统计数据？

可以。您可以点击此处查看 2019 年 Google 文档季活动的结果，也可以点击此处查看 2020 年活动的结果。

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

不可以。由于国际配送限制，我们将无法再向成功完成 Google 文档季项目的参与者提供 T 恤。

如果我还有其他疑问，该怎么办？

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

如果您在阅读所有文档后仍未找到答案，不妨考虑在讨论列表中与 Google 文档季社区讨论您的问题。请参阅有关讨论渠道和如何与我们联系的信息。

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

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

Google 文档季与 Google 夏季编程活动有何不同？

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

面向技术文档作者

技术文档撰写者何时可以申请参加 Google 文档季活动？

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

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

您将使用的文档工具和框架取决于您有意与之合作的组织。Google 文档季的目标之一是，通过开源项目帮助技术文档撰写者进一步了解编写开源产品文档所涉及的工具和框架。因此，您通常不要求您对特定文档平台具有详细的了解，然后再启动 Google Season of Document 项目。

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

了解您选择的组织是否已在网站上托管其文档，如果是，请了解他们使用的平台。该平台可以是静态网站生成器，例如 Jekyll、Sphinx 或 Hugo；或者，组织也可以在 Read the Docs 或 GitHub Pages 上托管其文档。了解组织使用的平台后，探索并试用相关语言和框架。这可以帮助您快速启动您的开源项目，并且使您能够很好地为您选择的开源项目提供合理建议。

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

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

已在从事开源项目的技术文档工程师可以继续在 Google 文档季继续编写该项目吗？

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

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

作为技术文档工程师，我是否需要拥有相关经验或接受过培训？

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

参与 Google 文档季能给我带来收入吗？

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

一份好的技术文档工程师兴趣陈述应该是什么样的？

最好的兴趣陈述是来自技术文档撰写人员的，他们在提交陈述之前会花时间与所选的开源组织进行互动并讨论他们的想法。请参阅创建利益声明的指南。

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

项目规模各有不同，但在计划期间，项目规模从每周 5-30 小时不等。但是，您花费的时间取决于您与组织约定的项目性质。在提交之前，您应该评估项目，并与开源组织讨论预计所需的时间。

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

不可以，只有能够代表开源项目接收资金的人员才能提交提案。我们鼓励您联系项目并围绕申请方案展开协作。

我是一名学生，可以参与 Google 文档季活动吗？Google 文档季会教我成为技术文档工程师吗？

学生可以与已获批准的组织合作，但 Google 文档季并非旨在教授技术写作技能。我们希望参与该项目的技术文档工程师应具备专业技术编程技能或同等相关经验。有意参与研究的学生在联系感兴趣的组织和项目时，应确保突出自己的相关写作和编辑经验。

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

虽然这目前并不违反相关规定，但我们强烈建议被 Google 夏季编程活动录取的学生不要申请成为 Google 文档季技术文案撰写者。学生应专注于 Google 编程之夏的工作，而不是申请参加 Google 文档之季。

此外，Google 文档季不适合新手，而是面向已经拥有扎实到出色的技术写作技能和经验的人士。Google 文档季的技术文档撰写者不会获得指导，而是需要自觉自愿，在组织管理员和其他社区成员的最低限度指导下，制定处理组织项目的计划。

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

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

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

可以，组织可以聘请公司来完成其提案中列出的工作。

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

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

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

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

面向开源组织管理员

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

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

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

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

一个组织可以有一个或多个开源项目。某些组织（例如基金会）可能拥有多个子组织，每个子组织都有一个或多个开源项目。如果贵组织有独立的子组织，请为每个子组织分别提交申请和提案。

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

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

一组开源项目能否联合提交一份提案，共同参与一个文档项目？

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

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

为了接收资金，贵组织必须拥有 Open Collective 账号。

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

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

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

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

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

我们建议您查看 Write the Docs 薪资调查，并计算出每小时费率。您还可以加入 Write The Docs Slack，并在 #season-of-docs 频道中发帖，邀请有兴趣的技术文案撰写者出价。

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

可以。不过，项目提案必须针对新工作（包括对现有文档的维护工作、修订或升级）。您不得申请用于支付已完成工作的资助。

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

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

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

我的组织能否与多位技术文档工程师合作？

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

我的组织可以聘请技术文档撰写公司来完成我们的项目吗？

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

我们的技术文档工程师在该计划结束前退出了。我们是否仍有资格收到剩余款项？

我们强烈建议您在计划结束之前尝试寻找新的技术文档工程师来完成您的项目。不过，剩余资金的拨付不是根据项目完成情况，而是根据案例研究和最终评估的完成情况。

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

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

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

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

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

我能以组织管理员的身份参与 Google 文档季，以及 Google 编程之夏的导师吗？

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

我们的组织曾参与过之前的 Google 文档季活动。我们是否有资格再次申请？

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

已归档的数据

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

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