与技术文档工程师合作

当前阶段：
案例研究已发布。请参阅时间轴。

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

向技术文档作者介绍开源世界和您的社区

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

帮助技术文档撰写者使用为项目贡献内容所涉及的工具和流程

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

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

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

提问！

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