详细设计应该包含哪些内容?
虽然GJB438B规定了软件设计说明的编写要求,但是很多组织编写的部件设计和详细设计的内容却几乎雷同。这其实违背了详细设计要达成的对部件进行详细设计的目标。究其原因,还是这些组织的软件开发人员因为刚实施GJB5000,还不熟悉详细设计如何编写。
在《软件设计说明中的几个难点——设计决策、执行方案、详细设计的写法》中,笔者已经给出了详细设计的编写实例,这里再给出另外一种详细设计应编写的内容。
模块描述
对模块/单元/类进行简要描述,主要说明设计它的目的/意义和特点。
功能
描述模块/单元/类的功能。
性能
描述模块/单元/类的性能要求。
输入项
描述模块/单元/类的每一个输入项。
输出项
描述模块/单元/类的每一个输出项。
设计方法(算法)
如果有,应描述模块/单元/类所使用的算法,具体的计算公式及计算步骤。
流程逻辑
使用流程图等图表来描述模块/单元/类的逻辑流程。
接口
描述本模块/单元/类与其他相关模块/单元/类间的接口关系,说明涉及的参数传递方式。
存储分配
如果有,说明本模块/单元/类的存储分配要求。
注释设计
描述对软件程序的注释要求。
限制条件
描述本模块/单元/类在运行或使用过程中的限制条件。
测试计划
描述对本模块/单元/类进行单元测试计划的要求。
尚未解决的问题
描述当前设计中尚未解决而在系统完成之前应解决的问题。
以上的详细设计内容中,1~ 9项应当不可或缺,10~13项可以进行裁剪。
如果你不知道详细设计怎么写,不妨参考上面的内容。
这正是:
详细概要应不同,内容设计十几种
不看整体看局部,参考实例可致用
参考书目:软件工程:软件建模与文档写作,作者:龙浩,出版社:人民邮电出版社
赞 (0)