当前阶段:
文档制作。请参阅时间表。
在 Google 文档季计划中,组织直接与技术文档工程师合作,以创建、改进和更新文档。组织会直接选择技术文档工程师。有兴趣与组织合作的技术文档工程师应使用组织的提案页面上指定的渠道提交意向声明。
意向调查表应包含您的联系信息、技术写作经验的相关信息,以及您将在该组织担任的工作大纲。还应该强调您如何满足组织对技术文档工程师的任何特定要求。请仔细阅读组织的项目创意页面,确保您已提供他们需要的所有信息。
此模板是一个大纲,可帮助您创建自己的意向说明。
个人信息
- 附上您的姓名和电子邮件地址。如果您不希望自己的名字出现在公开的最终案例研究报告中,请在您的提案中提供用户名。
专业信息
- 指向可公开访问的写作示例作品集的链接,或指向您的作品示例的单个链接。
- 近期技术写作经验概述:列出您最近从事的技术写作角色或工作经验。如果您有开源文档方面的经验,也请在此处添加。总结您的角色、职责以及您完成的工作。提供相关日期。
- 指向您的简历或简历 (CV) 的链接。
- 如果组织为项目制定了特定的要求,请用一两句话说明您如何满足这些要求,例如:“作为技术文档撰写人,我参与了超过六个文档修复程序,并在 2018 年、2019 年和 2020 年为 XYZ Industries 团队领导了三个文档修复程序。”
- (可选)您要添加的任何其他信息。例如,您对技术文档感兴趣、想要参与 Google 文档季或其他相关体验的原因。
项目声明
- 项目名称。如果组织的项目页面列出了多个可能的项目,请确保意向说明书标题反映了您想开展的项目。如果您要向某个组织提交意向说明书,该组织尚未确定可以开展的项目,则您的标题应总结您提议的工作。例如,“创建 Interactive ProjectX API 文档”比“ProjectX 的文档”标题效果更好。
- 详细说明。
- 说明您将如何处理该组织在其项目提案页面上列出的项目。
- 说明您的提议如何解决相应问题或实现组织在其项目提案页面上制定的目标。
- 附上您与组织成员就项目进行的所有讨论的摘要。
- 注意提案的语言和风格。开源组织在评估您的提案时可能会参考这些因素。
- 建议的时间表
- 概述项目时间表和各个阶段。例如,您可以指定 2 周的信息收集时间、4 周的时间撰写、2 周的审核和更改预算,以及 1 周的发布时间。
- 说明对项目成员的参与和反馈的明确预期。例如,您可以声明您的时间轴取决于能否在三天内收到对查询的回复。
- 建议的预算
- 我们建议技术文档工程师为整个项目制定预算建议,而不是每小时费率。
- 如果可能,请提供用于缩小或扩大范围的选项。例如,您可以提供不同的预算选项,用于记录两个、四个或六个平台的部署说明。