软件开发文档指南:软件需求分析报告文档模板软件概要设计报告文档模板软件详细设计报告文档模板软件数据库设计报告文档模
3.3 软件的详细设计
3.3.1 详细设计
在概要设计的基础上,开发者需要进行软件系统的详细设计。在详细设计中,描述实 现具体模块所涉及到的主要算法、数据结构、类的层次结构及调用关系,需要说明软件系统各个层次中的每一个程序(每个模块或子程序)的设计考虑,以便进行编码和测试。应当保证 软件的需求完全分配给整个软件。详细设计应当足够详细,能够根据详细设计报告进行编码。 3.3.2 特例
如果软件系统比较简单,层次较少,可以不必进行专门的详细设计,而和概要设计结合起来。
3.3.3 详细设计的要求
a.一致性
详细设计的要求应该与需求分析报告所描述的需求、与概要设计一致。同时,详细设计的各项要求之间也应该是一致的。
b.合理性
详细设计所提出的设计方法和标准应该是合理的、恰当的。 c.可追踪性
对详细设计所提出的各项要求应该可以得到它的清晰的源流,即可在需求分析报告、概要设计报告中有明确的需求描述。
d.可行性
根据详细设计进行编码、测试、操作和维护应该是可行的。 3.3.4 数据库设计
如果软件产品需要使用到数据库,软件的详细设计应包括对数据库的设计。数据库设计应在软件的需求分析、概要设计完成之后、详细设计的其它工作之前进行。在进行数据库设计时,应当按照交通局制定的《南京市交通局信息化数据库建设规范》要求进行。 3.3.5 详细设计的评审
在软件详细设计完成后,软件开发者应向交通局提交《软件系统数据库设计报告》和《软件系统详细设计报告》。在交通局对《软件系统数据库设计报告》、《软件系统详细设计报告》评审通过后,即可进入软件编码阶段。 3.3.6 详细设计格式
《软件系统详细设计报告》、《软件系统数据库设计报告》需按一定的格式进行编写, 具体的《软件系统详细设计报告》文档编写模板和《软件系统数据库设计报告》文档编写模 板请见附录C、附录D。
3.4 软件的编码
3.4.1 软件编码
在软件编码阶段,开发者根据《软件系统详细设计报告》中对数据结构、算法分析和模块实现等方面的设计要求,开始具体的编写程序工作,分别实现各模块的功能,从而实现对目标系统的功能、性能、接口、界面等方面的要求。 3.4.2 软件编码的要求
a.模块化编码 b.代码可读性