创建意向调查表

当前阶段
公布结果的时间表

在“文档季”计划中,组织直接与技术文档工程师合作,以创建、改进和更新文档。组织会直接选择技术文档工程师。有兴趣与组织合作的技术文档工程师应使用组织提案页面上指定的渠道提交意向声明。

您的意向说明书应包含您的联系信息、您的技术写作经验信息,以及您在组织中应从事的工作。还应重点说明您如何满足组织对技术文档工程师的要求。请仔细阅读贵组织的项目创意页面,确保您已提供他们需要的所有信息。

此模板是一个大纲,可帮助您创建自己的意向说明。

个人信息

  • 请附上您的姓名和电子邮件地址。如果您不希望自己的名字出现在最终的公开案例报告中,请在您的提案中注明,并提供相应的用户名。

专业信息

  • 指向可公开访问的写作示例的链接,或指向您的作品示例的单独链接。
  • 您最近的技术写作经验概述:请列出您最近从事技术写作的角色或相关工作经验。如果您有开源文档相关经验,也请在此处添加。总结您的角色、职责以及您完成的工作。视情况提供日期。
  • 指向您的简历或履历 (CV) 的链接。
  • 如果组织已为项目设定了某些要求,请用一两句话说明您如何满足这些要求,例如“我作为技术文档撰写者参与了超过六项文档修复,并在 2018 年、2019 年和 2020 年为我的团队为 XYZ Industries 团队领导了三份文档修复。”
  • (可选)您要添加的任何其他信息。例如,您对技术文档感兴趣、您为何想使用剧季功能或其他相关体验。

项目声明

  • 项目名称。如果组织的项目页面列出了多个可能的项目,请确保意向说明书标题与您开展的项目相符。如果您要向尚未确定可能的项目的组织提交意向说明书,则您的标题中应概述您提出的计划。例如,相比“ProjectX 的文档”,“Create Interactive ProjectX API 文档”是更好的标题。
  • 详细说明。
    • 说明您将如何处理该组织在其项目提案页面上提出的项目。
    • 说明您的提议将如何解决问题或实现组织在项目提案页面上设定的目标。
    • 附上您与组织成员就项目展开的所有讨论的摘要。
    • 注意提案的语言和风格。开源组织在评估您的提案时可能会参考这些因素。
  • 拟定时间表
    • 概述项目的各个时间安排和阶段。例如,您可以用 2 周的时间收集信息、4 周用于撰写内容、2 周用于审核和更改,以及 1 周用于发布。
    • 说明对项目成员的参与和反馈的明确预期。例如,您可以声明时间表依赖于在三天内收到对查询的回复。
  • 建议预算
    • 我们建议技术文档工程师为整个项目制定预算,而不是每小时费率。
    • 如果可能,请提供缩小或扩大范围的选项。例如,您可以提供不同的预算选项,用于记录 2 个、4 个或 6 个平台的部署说明。