与技术文档工程师合作

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

以下是一些指南,可帮助开源组织与技术文档撰写者高效合作。

向开源世界和社区介绍技术文档工程师

  • 为技术文档撰写者提供社区的“导览”。他们可以在哪里提问?他们应该参加哪些定期会议?或者加入什么邮寄名单?他们需要哪些账号(GitHub、Discord、Slack)?确保他们了解项目的行为准则,并知道如何报告任何问题。确保您的技术文档工程师了解项目许可,并遵守其他雇主在签署 CLA、DCO 或其他协议方面的任何要求。
  • 如果可能,请向他们介绍几个位于重叠时区的人员,这些人员可以快速回复有关社区或项目的问题。
  • 如果可以,请向他们寄送一些项目周边商品!

帮助技术文档工程师使用为您的项目做贡献所需的工具和流程

  • 如果您的流程未得到充分记录,请安排时间,引导技术文档撰写者完成其首次贡献、问题或拉取请求。他们应该使用哪些模板或代码?谁需要审核他们的贡献?他们应如何以及何时跟进审核?如果他们的工作包含代码示例,该如何进行测试?关于您的 CI/CD 流程或版本,他们需要了解哪些信息?

帮助技术文档撰写者了解您的项目及其用户

  • 详细说明您的项目,以便技术文案撰写者对产品有坚实的概念理解。这有助于技术文档撰写者在撰写项目文档时更有信心,更具权威性。
  • 描述使用该项目的用户的需求。描述时应尽可能具体,不只是“开发者”,还包括“创建网站的开发者”和“对工业机器人编程的开发者”。
  • 让技术撰稿人与必要的主题专家联系。也就是说,负责文档将涵盖的项目方面的开发者或其他项目贡献者。
  • 确保技术文档撰写者从主题专家和任何其他社区成员那里获得所需的时间和资源。

提问!

  • 您的社区或项目之前可能未与技术文档工程师或文档贡献者合作过。抓住机会,在分享所知的同时学习新知识!请就流程和工具征求反馈,您的技术文档撰写人员可能会提出一些改进建议。