技术文档撰写指南

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

本指南适用于有兴趣与 Google 文档季计划中获批组织合作的技术文档工程师。

您是否应该参加 Google 文档季计划？

通过这些问题，您可以了解您是否有兴趣与参与 Google Season of Document 计划、已获批准的组织合作。

  • 您是否具备技术文档写作技能和经验？Google 文档季旨在提升技术文档写作能力，但不教授基本技术写作技能。你是否有上进心，并且有条理？
  • 您是否有时间在该计划的 6 个月内参与？ 项目规模各不相同，但在整个计划期间，每周的投入时间在 5-30 小时之间。
  • 您是否有兴趣积累开放源代码方面的工作经验？您是否愿意花时间了解项目的流程和社区规范？
  • 您是否愿意与组织管理员合作，优化其项目提案、制定时间表、评估和汇总指标，并帮助整个组织了解技术文档的价值？

您还应满足计划的资格要求，包括能够创建 Open Collective 账号。您必须能够合法接收在您的居住地所从事的工作的资金。Google 文档季管理员无法提供税务建议或回答与您的工作资格相关的问题。

作为参与 Google 文档季的熟练技术文档撰写者，您将获得报酬，同时获得在开源领域工作方面的经验，并帮助您的项目通过更优质的文档解决关键需求。

以技术文档撰写者的身份参与 Google 文档季活动

探索阶段

组织申请的截止日期为世界协调时间 (UTC) 2024 年 4 月 2 日 18:00。我们建议技术文档人员尽早开始探索可能的项目。但是，组织可以在世界协调时间 (UTC) 2024 年 5 月 22 日 18:00 之前随时选择技术文档工程师进行合作。

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

应用阶段

  • 等待 Google 文档季公布已获批准的组织：
    • 如果通过审核的组织想要与您合作或进一步讨论您的意向声明，会直接与您联系。
    • 组织不限于仅与在组织申请截止日期之前提交意向声明的技术文案撰写者合作。他们可能会在接受后征求进一步的利益声明。组织必须在世界协调时间 (UTC) 2024 年 5 月 22 日 18:00 之前选择技术文档工程师。
    • 组织无需针对未能成功提交的意向声明提供反馈。

项目开发阶段

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

最终评估和案例研究阶段

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