当前阶段:
“2021 文档季”计划已于 2021 年 12 月 14 日结束。请参阅时间表。
以下是一些有助于开源组织与技术文档工程师高效协作的指南。
向开源世界和您的社区介绍开源技术文档工程师
- 为技术文档工程师提供您社区的“导览”。他们可以在哪里提问?他们应该参加哪些定期会议?应该加入哪些邮寄名单?他们需要哪些账号(GitHub、Discord、Slack)?确保他们了解项目的行为准则,知道如何报告任何问题。确保您的技术文档工程师了解您的项目许可,并遵守其他雇主在签署 CLA、DPO 或其他协议方面的要求。
- 如果可能的话,可以向他们介绍几个时区不同的人,以便他们能够快速回答关于社区或项目的问题。
- 如果可以,请给他们一些项目纪念品!
帮助技术文档工程师使用为项目做贡献所涉及的工具和流程
- 如果您的流程没有详尽记录,请安排一个时间,引导技术文档工程师完成第一个贡献、问题或拉取请求。他们应使用什么模板或标记?哪些人需要审核他们贡献的内容?他们应该如何以及何时跟进审核?如果他们的工作包含代码示例,如何测试它们?他们需要了解关于您的 CI/CD 流程或版本的哪些信息?
帮助技术文档工程师了解您的项目及其用户
- 详细解释您的项目,以便技术文档工程师对产品有明确的概念性了解。这有助于技术文档工程师对项目更有信心,更具权威性。
- 说明项目人员的需求。尽可能具体,不只是“开发者”“创建网站的开发者”和“开发者为工业机器人编程”。
- 让技术文档工程师与必要的主题专家联系。也就是说,文档将涵盖您项目的各个方面的开发者或其他项目贡献者。
- 确保技术文案能够从主题专家和任何其他社区成员处获得所需的时间和资源。
尽情提问!
- 您的社区或项目之前可能未与技术文档撰写者或文档贡献者合作过。请抓住这次学习机会,分享自己掌握的知识!请对方就流程和工具提供反馈,您的技术文档工程师可能会提供一些改进建议。