关于详细文档

先说背景,

 1系统的功能在紧张的实现中,目前只是实现CURD,但某些成员在实现那些功能中,最终发现还是有些地方是没有符合业务的.那只得反工了.

 2第一阶段的版本是出来了,为了更好的进行迭代开发,出一个版本给用户去体验,以便能更好的获取是否有新的需求或是确认目前实现的功能是否真正的符合需求.

 3测试人员需要一个参考以便测试结果的正确性.

 4要考虑以后的维护方便.

 

 基于上述几大问题,从技术人员,测试人员,用户,上级四方面来说,必须有一个方案满足各方的要求.想来想去,只能靠详细文档为我们解决这个方案了,只是适当的调整文档的内容而已.文档是在网上下载的,很容易下载,但是,讨论结果有五各方面是必须需要的:

 

1:输人项

 

2输出项

3算法

4流程逻辑(时序图)

5业务实现思想(主要是描述步骤,且必须说明操作的表或字段)

6 测试

目前的项目由于时间有限,人员也有限,不可能每一项都要求做一个功能的时候就写,但基于背景1,最终决定第5项是在实现功能之前需要写的,因为如果不写的话,最终反工花的时间会更多.其它的几项可在功能实现完成后填写.

 

有了详细文档中的这几大项,基本上是满足了各个方面的要求了.