敏捷开发迭代速度快?开发完上线之后找不到相应人员?下一轮优化时不知从何下手?
相信大家在平时的工作中都遇到过相关的问题,究其原因是没有留足够的时间进行相关文档的沉淀和归档,导致后来人员对于之前的项目不够熟悉,不知道如何下手。所谓好记性不如烂笔头,结束一个项目时抽空整理出相关的特点,给后来人一个大概的论述,相信能很好的发挥承上启下的作用。很感谢我的上一任上司,她督促我们每一个版本都需要养成总结文档的习惯,写功能说明文档的习惯也是从这个时候慢慢继承下来的。
这里说的继承者是指——功能说明文档。每个专项开展测试,有新功能的时候都会测的热火朝天,但是测试结束之后,这个功能交接给另外的同学时或者合并到系统项目上时,又会出现功能继承缺失的情况,所以写好功能说明文档很重要。
功能说明文档包括以下几个方面:
功能使用截图;
功能实现原理;
涉及到的数据库和表;
遗留的缺陷。
【功能使用截图】
这个章节包括该功能的使用说明和使用方法,需要附上截图,防止出现不会使用的情况。对于按钮比较多的地方最好指出按钮对应的下一步功能。
【功能实现原理】
该功能的概要设计是什么样子的,需要附上概要设计接图,方便出现问题时进行定位。定位出是哪个部件导致的问题。
【涉及到的数据库和表】
一些数据入库需要经过哪些表和库,设置哪些接口,都需要标清楚。该版本新增了哪些表,删除了哪些表都需要一一记录。
【遗留的缺陷】
该功能给出结论是“通过”,但还遗留一些不影响上线,需要后期修改的bug,全部归类在这里。方便后续人员追踪。
以上就是我个人认为功能说明文档应该包含的一些部分。希望能对大家有所启发。