技术文档撰写指南

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

本指南适用于有兴趣与 2021 年 Google 文档季计划中获批的组织合作的技术文档撰写人。

您应该加入“2021 文档季”计划吗？

这些问题可帮助您了解，您是否有兴趣在 2021 赛季的 Google 文档中与已获批准的组织合作。

  • 您是否具备技术写作技能和经验？《Google 文档赛季》并非旨在教授基本的技术写作技能。您是否能够积极主动地开展工作，并且工作有条不紊？
  • 在为期六个月的计划（2021 年 4 月至 11 月）中，您是否有时间参与？项目规模不尽相同，但在计划期间每周需要 5-30 小时。
  • 您是否有兴趣获取开源领域的工作经验？您是否愿意花时间学习项目的流程和社区规范？
  • 您是否愿意与组织管理员合作，优化他们的项目提案、制定时间表、评估和编制指标，并帮助整个组织了解技术写作的价值？

您还应符合该计划的资格要求，包括能够创建 Open Collective 帐号。请注意，您必须能够依法从您在居住地开展的工作获得收入。Season of Google 文档计划管理员无法提供税务建议或回答与您的工作资格有关的问题。

作为参加了《文档季》计划的资深技术文档作者，您将获得参与开源工作的经验，同时通过更好的文档帮助您的项目解决关键需求。

以技术文档作者身份参与“2021 文档季”计划

探索阶段

组织申请截止时间为世界协调时间 (UTC) 2021 年 3 月 26 日 18:00。我们建议技术文档工程师尽早探索可能的项目。不过，组织可能会在 2021 年 5 月 17 日 18:00（世界协调时间）之前随时选择与技术文档工程师合作。

  • 查找您感兴趣的项目
    • 请按照开源组织“文档季”计划页面上的说明直接联系，或查看 Season of Google 文档 GitHub 代码库，以查找有兴趣参与 Google 文档季的组织。您还可以在编写文档 Slack 的 #season-of-docs 频道中找到感兴趣的组织。
    • 下面是选择项目的一些方法：
      • 选择使用您熟悉或感兴趣的语言（例如 JavaScript 或 C）的项目。
      • 选择您感兴趣的技术或领域（例如机器学习、开放科学或机器人）中的项目。
      • 请根据社区的友好程度选择项目！访问他们的论坛，查看贡献者的社交媒体帐号（如果他们在那里谈论自己的项目），并查看他们的入职文档（如果有）。
      • 如果你希望参与的项目不在项目列表中，请与该项目联系，并请他们考虑申请！
  • 查看项目的提案页面
    • 有了 3-5 个可能的项目后，请查看每个项目的提案页面
    • 您应该使用项目列出的用于反馈和讨论的渠道提出问题、提供反馈和提出建议
  • 直接向组织提交意向声明。在意向说明书中，您将展示如何实现组织的项目提案中制定的目标。
    • 使用 Season of Google 文档意向调查表模板。越短越好！
    • 请按照组织“提示”页面上的说明提交您的意向说明。如果组织列出了任何特殊要求，请确保在声明中表明您满足这些要求。
    • 提交意向声明即表示您同意遵守本组织的行为准则和《文档季》行为准则。

应用阶段

  • 等待 Google 文档季公布已接受的组织：
    • 如果获批的组织想与您合作或进一步讨论您的意向声明，将直接与您联系。
    • 组织不仅限于与在组织申请截止日期之前提交了意向声明的技术文档工程师合作。在接受该协议后，他们可能会征求进一步的权益声明。组织必须在世界协调时间 2021 年 5 月 17 日 18:00 之前选择技术文档撰写人。
    • 对于失败的意向声明，组织无需提供反馈。

项目开发阶段

  • 与组织合作制定时间表，包括交付成果和截止时间。

最终评估和案例研究阶段

  • 与组织合作，提供最终评估和案例研究所需的信息。