选择技术文档工程师

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

本页面包含面向开源组织的提示,有助于其评估 Google 文档季项目提案并挑选合适的技术文档工程师。

简介

开源组织必须聘请一名技术文档工程师来编写他们提出的项目。组织必须自行提供技术文档撰写者。如果技术文档作者有兴趣与参与 Google 文档季的组织合作,可以在 Google 文档季 GitHub 代码库以及“编写文档 Slack”中的 #season-of-docs 频道中找到。

开始流程

我们建议您在认为自己可能需要参加 Google 文档季时,立即开始寻找技术文档工程师。

评估技术文档工程师

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

技术写作技能和经验

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

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

  • 注意文档的设计和布局。 检查文档示例的整体布局。设计是否合乎逻辑?您能否轻松找到文档或文档集?内容是否重复,或者是否存在明显的空白?

聘请技术文档工程师

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

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

在招聘之前,请务必与技术文案撰写者讨论薪酬付款时间表。我们建议组织根据项目里程碑(包括项目启动时的付款)与技术文案撰写者一起制定付款时间表。请注意付款日期(整个计划期间只会发生两次)和金额,以便创建付款时间表。

注意:如果贵组织尚未聘用技术文档撰写者,并且未在 2023 年 5 月 10 日凌晨 1:00(世界协调时间)之前提交“技术文档撰写者聘用证明”表单,则不会在首次发放款项时收到款项。