选择技术写作项目

当前阶段
2019 年 Google 文档季计划已于 2020 年 3 月 6 日结束。请参阅时间轴

本页面包含面向开源组织的指南,介绍了如何在《文档季》中评估技术写作项目提案以及如何选择他们想要指导的项目。

简介

技术文档工程师提交他们的文档季提案,以与所选的开源组织一起处理一个项目。Google 计划管理员会将提案转发给开源组织,由其进行评估和选择项目。如需详细了解所涉及的步骤,请参阅组织管理员指南

评估技术文档工程师提案

技术写作技能和经验

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

  • 重点培养语言和沟通能力。 从这个角度评估技术文档工程师的提案。最重要的是:您能否理解对方所写的内容?作为导师,您的角色是帮助技术文档编写人员了解开源流程、工具和代码,而且您也不需要查看最终文档的文本内容。如果要深入审核提案的语言,请注意标点符号和短语的一致性、拼写正确和语言清晰。表述要简单还是复杂?这些句子是短句话还是一直延续到难以理解为止?

  • 注意文档设计和布局。在方案中,技术文档工程师有机会提供他们编写的文档的示例。请检查文档示例的整体布局。设计是否合乎逻辑?您能轻松找到文档或文档集吗?是否存在重复的内容?或者是否存在明显的空缺?

提案

  • 检查提案是否符合您的要求。 此提案是否与您在今年为“文档季”提交的项目创意有关?如果技术文档工程师提出了新想法,请检查该提议是否符合您的开源项目的需求,以及您是否有合适的人员来帮助技术文档工程师实现提议的项目目标。

  • 探寻热情和体贴。 方案是否能够证明技术文档工程师对该项目感兴趣?考虑他们是否对提案进行过思考和工作,比如在探索阶段与您的组织咨询,或者添加自己对如何实现项目目标的想法。

FAQ

我们如何确定要提交的项目数量?

专注于一两个项目。如果您的组织有能力提供更多的指导,那么您可以提交更多指导。对于每个技术文档工程师项目,您至少需要一位导师(最好是两位)致力于仅指导该项目。

阅读相关信息,了解文档季槽分配的工作原理。

如何选择要接受的技术文案提案?

确保您从收到的技术文档工程师方案中选出最优质的一项。也就是说,选择最符合您的要求且最符合上述评估指南的提案。

在哪里可以提交所选提案?

请参阅组织管理员指南