【经验谈】如何制定Documentation Development Plan?

作为TechComm项目管理,在产品Release Plan确定之后,需要第一时间制订Documentation Plan;然后,在项目经理的协作下,组织产品、开发、测试、实施相关接口人进行审阅与存档。

制定Plan主要目的在于:

  • 规范与指导项目经理以及TechComm Manager对文档的完整性与进度进行管理;

用户文档分为外部用户文档(文档工程师撰写,针对购买产品的外部用户)与内部用户文档(研发与测试撰写,针对内部用户,比如内部二次开发API文档)

  • 明确TechComm人员在本次Release中的写作任务与职责;
  • 明确各类研发、测试文档的责任人(以便让研发提前在项目安排上预留文档开发时间,同时也让TechComm预留时间做编辑校审);
  • 为写作过程中的上下游合作提供流程指导。

Plan内容包括如下:

  • 明确本次release中将对外、对内发布的所有文档 (范围)
  • 所有文档的写作负责人以及审阅参与方 (负责)
  • 明确文档的写作与审阅流程与大致时间点 (时间期限)
  • 文档的发布方式

后期...将以事例方式,介绍如何根据读者persona制订文档列表,在Agile流程下的用户文档开发流程、研发文档的交互与约束说明、如何结合开发测试schedule粗定文档的完稿、评审(含内审)、编辑、与回归测试时间点?

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 131,421评论 19赞 558
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 79,062评论 12赞 120
  • 亲爱的洛晔 上午我又一个人去看电影了,是《悟空传》,去的路上买了一包辣条和一个小蛋糕。到的时候片子都播了十分钟了。...
    因何凭栏阅读 34评论 2赞 1
  • 《米娅快跑》 原文:两天之后苏晚上到我家,跟我描述了和大老板的见面,果然一切如Leon所料,他先是对苏的态度表示欢...
    临淄茂业DDM黄红阅读 105评论 0赞 0
  • 有时候,莫名的心情不好,不想和任何人说话,只想一个人静静的发呆。有时候,夜深人静,突然觉得不是睡不着,而是固执地不...
    平淡_e642阅读 22评论 0赞 0