与技术文档工程师合作

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

下面这些准则有助于开源组织与技术文档工程师高效合作。

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

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

帮助技术文档工程师采用为项目做贡献所涉及的工具和流程

  • 如果您的流程没有详尽记录,请安排时间在技术文档工程师的帮助下完成其第一个贡献、问题或拉取请求。他们应使用哪些模板或代码?哪些人需要审核他们的贡献?他们应该如何以及何时跟进审核?如果他们的工作包含代码示例,如何对其进行测试?关于您的 CI/CD 流程或版本,他们需要了解哪些信息?

帮助技术文档工程师了解您的项目及其用户

  • 详细解释您的项目,以便技术文档工程师能够对产品有一个明确的概念性了解。这可以帮助技术文档撰写人在撰写项目时更加自信,更具权威性。
  • 说明项目人员的需求。尽可能具体,不仅仅是“开发者”,“创建网站的开发者”和“开发者为工业机器人编程”。
  • 让技术文档工程师与必要的主题专家联系。也就是文档将涵盖的项目的各个方面由开发者或其他项目贡献者负责。
  • 确保技术文档工程师能够从主题专家和任何其他社区成员那里获得所需的时间和资源。

尽情提问!

  • 您的社区或项目之前可能没有与技术文档撰写者或文档贡献者合作过。抓住这个机会学习您的知识,同时分享您的知识!征求客户对流程和工具的反馈,您的技术文档工程师可能会提供一些改进建议。