选择技术文档工程师

当前阶段
“2021 文档季”计划已于 2021 年 12 月 14 日结束。请参阅时间表

本页面包含面向开源组织的提示,介绍了如何为他们的 Season of Google 文档项目提案评估和选择合适的技术文档作者。

简介

开源组织必须聘请一名技术文档工程师来完成他们提议的项目。组织必须寻找自己的技术文档工程师。如果技术文档作者有意与参与 Season of Google 文档的组织合作,可以在 Season of Google 文档 GitHub 代码库中找到,也可以在“Write theDocs Slack”的 #season-of-docs 频道中找到他们。

评估技术文档工程师

建议您向正在考虑的技术撰稿人索要以前编写的文档的示例,以便集中精力评估他们的技术写作技能和经验。

技术写作技能和经验

  • 了解技术文档工程师之前的经验。 理想情况下,技术文档工程师应该有一些为软件行业编写技术文档的经验。《文档季》的目标之一是让技术文档作者有机会参与以开发者为中心的产品。因此,即使您的项目专注于开发者群体,编写者也不必具备 API、SDK 或其他开发者平台方面的经验。

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

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