选择技术文档工程师

当前阶段
2021 年度 Google 文档计划已于 2021 年 12 月 14 日结束。请参阅时间轴

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

简介

开源组织必须聘请技术文档撰写人员来负责其提议的项目。组织必须自行提供技术文档撰写者。如果技术撰稿人有兴趣与参与 Google 文档季的组织合作,可以在 Google 文档季的 GitHub 代码库中找到相关资源,也可以访问“撰写文档 Slack”中的 #season-of-docs 频道

评估技术文档作者

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

技术写作技能和经验

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

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

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