与技术文档工程师合作

当前阶段
2020 季 Google 文档计划已于 2021 年 3 月 15 日结束。请参阅时间轴

以下是一些面向开源组织的准则,介绍了如何与受您指导的《文档季》的技术作者合作:

  • 向技术文档工程师介绍开源世界和您的社区。
  • 帮助技术文档工程师使用为您的项目贡献内容所需的工具和流程。
  • 详细解释您的产品,以便技术文档工程师对产品有一个明确的概念性了解。这可以帮助技术文档撰写者在撰写项目时更加自信,更具权威性。
  • 描述您的受众群体的需求,即使用您产品的开发者和/或其他使用该产品的群体的需求。
  • 与技术文档工程师讨论重要用例,帮助他们设计所需的文档。
  • 当技术文档工程师需要在编写文档之前了解代码时,请浏览代码。
  • 让技术文档工程师与必要的主题专家联系。 也就是说,负责本文档将涵盖的产品各个方面的开发者或其他项目贡献者。
  • 确保技术文档工程师从主题专家和任何其他社区成员那里获得所需的时间和资源。
  • 与技术文档工程师合作,在相关文档中添加有意义的代码示例。

注意事项

《Google 文档》季中的开源导师不一定是技术文档撰写者。导师无需具备文档相关技能。 技术文档工程师会在项目中运用这些技能并建立指导关系。

相反,导师会运用他们对开源社区、产品以及开源项目所用流程和工具的知识。

指导关系的一个重要成果是,技术文档撰写者在今年的 Google 文档季能够获得丰厚而成功的经历。良好的体验可以提高技术文档编写者在今年文档季结束后继续为开源项目做贡献的可能性,同时让其他技术文档作者对从事开源工作的热情也更高。