技术写作流程

敏捷开发、产品快速迭代 之时,正常情况下是 两周一个迭代,一个月一次产品发布,我在工作中是这样安排我的技术写作流程的。

一本手册的诞生
  1. 收集产品需求

    在软件产品提测时,向 PM 收集已细化的产品需求,通常是以一个个任务项(PBI)的形式存在,PM 将此次迭代的 PBI 分配给我。

  2. 理解产品需求

    梳理并分析产品需求,了解需求来源、需求背景、用户痛点等等,了解本次迭代新增了哪些功能,优化了哪些功能,修复了什么 BUG 等等。

  3. 操作使用产品

    结合每一个 PBI 的功能,操作使用产品,在使用产品的过程中,深入理解产品功能,为构思产品文档大纲和编写产品文档作铺垫。

  4. 设计文档大纲

    与设计产品架构一样,可以参考竞品或查找资料,设计拟定文档的主要大纲结构,包括每一篇内容的设计。

  5. 编写文档初稿

    正式开始按所理解和操作的产品功能进行编写文档内容,当然如果中间遇到任何问题,可以与 PBI 中标注的开发人员进行咨询,以辅助完成文档初稿的编写。

  6. 评审与修订初稿

    组织 PM、开发人员以及相关人员进行评审初稿文档,遇到问题即时修订更正。可以是会议,可以是邮件。

  7. 发布文档

    随着产品的发布,在产品发布后的一至两天内,应立即将对应的文档发布至文档网站。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容