选择技术文档工程师

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

本页面包含面向开源组织的提示，介绍了如何评估和选择合适的技术文档撰写者来撰写 Google 文档季项目提案。

简介

开源组织必须聘请技术文档撰写人员来负责其提议的项目。组织必须自行提供技术文档撰写者。如有技术文案撰写者有意与参与 Google 文档季的组织合作，请访问 Google 文档季 GitHub 代码库，并加入 Write the Docs Slack 中的 #season-of-docs 频道。

开始流程

建议您在考虑参与 Google 文档季活动时，立即开始寻找技术文档撰写者。

评估技术文档工程师

建议您向考虑聘用的技术文档撰写者索要之前开发的文档示例，以便评估他们的技术文档撰写技能和经验。

技术写作技能和经验

  • 了解技术文档撰写者的过往经验。 理想情况下，技术文档撰写者应具备为软件行业撰写技术文档的相关经验。Google 文档季的目标之一是让技术文档撰写者有机会参与开发者专用产品的相关工作。因此，即使您的项目以开发者受众群体为目标，撰稿人也不一定要有 API、SDK 或其他开发者平台方面的经验。

  • 着重培养语言和沟通能力。 从这个角度评估技术文档撰写者的过往工作。最重要的是：您能否理解对方写的内容？如果您想深入审核技术文档编写者的文稿语言，请检查标点符号和措辞是否一致、拼写是否正确以及语言是否清晰。措辞简单还是复杂？句子是简短的，还是会一直说下去，直到听众难以跟上？

  • 注意文档设计和布局。 检查文档示例的整体布局。设计是否合理？您能否轻松浏览文档或文档集？内容是否重复，或者是否存在明显的空白？

聘请技术文档工程师

组织必须在 2024 年 5 月 22 日 18:00（世界协调时间）之前聘用技术文档撰写人员，并填写下方链接的技术文档撰写人员聘用证明表单。

技术文档工程师招聘阶段已完成。

在聘用技术文档撰写者之前，请务必与对方讨论薪酬和付款时间表。我们建议组织根据项目里程碑（包括项目启动时的付款）与技术文案撰写者一起制定付款时间表。在创建付款时间表时，请注意付款日期（整个计划中只有两次付款）和金额。

注意：如果贵组织未在 2024 年 5 月 22 日凌晨 1:00（世界协调时间）之前聘用技术文档撰写者并提交“技术文档撰写者聘用证明”表单，则不会在首次发放款项的日期收到款项。