技术文档撰写指南

当前阶段：
公布的结果。请参阅时间轴。

本指南的目标读者是有兴趣与 Google 文档季计划中获批的组织合作的技术文档作者。

是否应加入 Google 文档季计划？

通过回答这些问题，您可以了解您是否有兴趣与 Google 文档季计划中被认可的组织合作。

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

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

作为参与 Google 文档季的经验丰富的技术文档撰写者，您将获得报酬，获得从事开源工作的经验，同时通过更好的文档帮助您的项目解决关键需求。

以技术文档人的身份参与 Google 文档季

探索阶段

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

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

应用阶段

  • 等待 Google 文档季公布已接受的组织：
    • 如果获批组织想与您合作或进一步讨论您的意向说明，将直接与您联系。
    • 组织不仅限于与在组织申请截止日期之前提交了意向声明的技术文档进行合作。在对方接受后，他们还可以进一步征求利益声明。组织必须在 2023 年 5 月 10 日 18:00（世界协调时间）之前选择技术文档作者。
    • 对于不成功的意向陈述，组织无需提供反馈。

项目开发阶段

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

最终评估和案例研究阶段

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