历史项目文档整理纪实

整理历史项目文档的过程,可能是这样的:

  • 整理前:有什么必要啊,谁来搞这个看源码不就好了吗?
  • 整理中:模块不是很清晰啊,架构图怎么画比较好呢?这个地方和那个地方层级好混乱啊,怎么描述好呢?这块的性能瓶颈根本不清楚啊。这块的功能设计已经和需求脱轨了,现在不需要这样做了。
  • 整理后:一篇文档,以及一堆 todo。

可见文档整理的好处还是很多的,可以帮我们跳出细节,俯视整个业务流程,从当前的角度重新审视功能设计。

如何整理文档呢?

首先要对需求和项目做梳理和拆分。业务建议按关联程度,每一块拆分为独立的小块,整体上对每个小块再进行规划即可,拆得过大或者过碎都不好。这一点与需求设计是一样的,理论上,文档整理就是一个重新梳理需求,整理需求的过程。一篇好的文档,必然是需求清晰的。

每个项目的介绍,可以包括:服务简介,业务流程,业务依赖,服务执行时序介绍,关键数据结构介绍,数据统计,监控报警等。

图表说明非常重要。一般有:业务场景图,架构设计图,时序图,带泳道的活动图,协作图等。灵活使用不同图表表述内容,可以帮助读者快速领会设计意图。

设计好的文档,要找几个人从不同的角度给你提意见。最好能涵盖:了解需求的业务负责人,准备提需求的产品运营等,不了解需求的技术等。

2019-03-31 13:34 5
Comments
Write a Comment