选择技术文档工程师

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

本页面包含面向开源组织的提示,可帮助开源组织为其 Google 文档季项目提案评估和选择合适的技术文档编写者。

简介

开源组织必须聘请技术文档工程师来处理他们提议的项目。组织必须找自己的技术文档工程师。如果技术文档作者有意与参与 Google 文档季的组织合作,可参阅 Google 文档季 GitHub 代码库和“编写文档 Slack”的 #season-of-docs 频道

开始流程

如果您认为自己可能想要参与 Google 文档季,建议您尽快开始寻找技术文档撰写者。

评估技术文档工程师

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

技术写作技能和经验

  • 审视技术文档工程师之前的经验。 理想情况下,技术文档工程师应该事先拥有编写软件行业技术文档的经验。Google 文档季的目标之一是让技术文档撰写者有机会参与以开发者为中心的产品。因此,即使您的项目主要面向开发者群体,开发者也不一定要有 API、SDK 或其他开发者平台方面的经验。

  • 重点培养语言和沟通能力。 从这个角度评估技术文档工程师之前的工作成果。最重要的是:您能否理解对方所写的内容?如果您希望对技术文档撰写语言进行深入审核,请查看标点符号和措辞的一致性、拼写正确以及语言清晰。措辞是简单还是复杂?这些句子是短句话还是一直延续到难以理解为止?

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

聘请技术文档工程师

组织必须聘请技术文档工程师,并在 2023 年 5 月 10 日 18:00(世界协调时间)之前填写下方链接的《技术文档工程师招聘表单》。

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

在招聘之前,请务必与技术文档工程师讨论薪酬付款时间安排。我们建议组织根据项目里程碑与技术文档工程师一起制定付款时间表,包括项目启动时的付款。请注意付款日期(在整个计划期间只会出现两次)以及金额(在创建付款时间安排时)。

注意:如果组织未在世界协调时间 (UTC) 2023 年 5 月 10 日 18:00 之前聘用技术文档作者并提交了《技术文档作者招聘表单》,则无法在首次付款日收到资金。