【机房合作】——如何写详细设计文档

    一直都很发怵写文档,因为不知道该往上面写些什么,前面也经历了两次文档的书写,可是总是不如合作版那么正规,也就是到了合作版我才真正的了解到了,到底文档都是怎么写的,它又是给谁看的,怎么让别人能在开发过程中用到你这个文档。这次合作,我主要负责的是写详细设计说明书,也就介绍一下该如何详细设计。


   什么是详细设计文档


    详细设计说明书又可称程序设计说明书。编制目的是说明一个软件系统各个层次中的每一个程序 (每个模块或子程序)的设计考虑。


   包含什么内容


 架构图

 架构图表示系统架构,也就是你整个系统是怎么运行的,可以包括系统结构图,最主要的还是包图,因为包图体现的是整个系统的层次结构,也表明了各层次之间的关系。


 类图

 详细设计说明书之所以称为详细设计,我觉得主要的就在这一部分,因为在详细设计中就是要详细介绍每一个类,包括类名、类的描述、方法说明、参数说明、返回值说明,还要介绍该类方法之间的调用关系,也就是时序图。


 时序图

 说起时序图,那么在详细设计中也是不可少的。时序图用来描述业务逻辑,主要用于每个功能的详细设计,时序图描述每个功能详细的方法调用,是实现方法之间的调用关系。


 定义代码规范

 代码规范要在详细设计中写明,规范注释、代码格式、命名,包括数据库命名、控件命名等。


 测试用例

 测试用例就是测试时需要进行的步骤,比如一个功能要测什么,怎么测,预测结果是什么,实测结果是什么,是否测试失败,如果失败还需说明失败的原因是什么。


为什么写详细设计

详细设计是对系统最详细的描述,细到包括每个类、每个方法、方法参数返回值、每个功能等等,正确的文档驱动开发,开发人员正是根据详细设计说明书进行开发,所以在详细设计中,应该是越详细越能让开发人员明白需求,明白开发过程。


总结

原先每次写详细设计文档,总是不知道该怎么写,所以写出来的文档也就几十页,这就觉得已经很多了,因为它只是一篇文档。但是经历过合作之后,这种想法就被颠覆了,合作时写的文档将近300页,从页数上看,也知道这次写的有多详细了,何况机房收费系统还只是一个小系统,如果遇到大的系统,不知道要写多少了。不过,现在的想法毕竟还是局限的,因为写的还是太少了,写的次数多了,想法自然也就丰富了。

本站公众号
   欢迎关注本站公众号,获取更多程序园信息
开发小院