作为TechComm项目管理,在产品Release Plan确定之后,需要第一时间制订Documentation Plan;然后,在项目经理的协作下,组织产品、开发、测试、实施相关接口人进行审阅与存档。
制定Plan主要目的在于:
- 规范与指导项目经理以及TechComm Manager对文档的完整性与进度进行管理;
用户文档分为外部用户文档(文档工程师撰写,针对购买产品的外部用户)与内部用户文档(研发与测试撰写,针对内部用户,比如内部二次开发API文档)
- 明确TechComm人员在本次Release中的写作任务与职责;
- 明确各类研发、测试文档的责任人(以便让研发提前在项目安排上预留文档开发时间,同时也让TechComm预留时间做编辑校审);
- 为写作过程中的上下游合作提供流程指导。
Plan内容包括如下:
- 明确本次release中将对外、对内发布的所有文档 (范围)
- 所有文档的写作负责人以及审阅参与方 (负责)
- 明确文档的写作与审阅流程与大致时间点 (时间期限)
- 文档的发布方式
后期...将以事例方式,介绍如何根据读者persona制订文档列表,在Agile流程下的用户文档开发流程、研发文档的交互与约束说明、如何结合开发测试schedule粗定文档的完稿、评审(含内审)、编辑、与回归测试时间点?