《系统详细设计说明书.docx》由会员分享,可在线阅读,更多相关《系统详细设计说明书.docx(8页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、系统详细设计说明书 XXXXXX XXXXXXXXXXXXX 项目名称 详细设计说明书 XXX公司 二XX年X月 文档修改记录 目录 第一章引言. 错误!未定义书签。 目的. 错误!未定义书签。 背景. 错误!未定义书签。 术语定义. 错误!未定义书签。 参考资料. 错误!未定义书签。第二章系统概述. 错误!未定义书签。第三章程序1设计说明. 错误!未定义书签。 程序描述. 错误!未定义书签。 模块架构图 . 错误!未定义书签。 功能 . 错误!未定义书签。 类图 . 错误!未定义书签。 增加功能(功能点) . 错误!未定义书签。 程序流程 . 错误!未定义书签。 测试和限制条件 . 错误!未
2、定义书签。 备注 . 错误!未定义书签。第四章程序2设计说明. 错误!未定义书签。第五章公用接口程序说明. 错误!未定义书签。 全局变量. 错误!未定义书签。 公用界面或接口. 错误!未定义书签。 公用方法和过程. 错误!未定义书签。第六章附件. 错误!未定义书签。详细设计评审意见. 错误!未定义书签。 第一章引言 1.1目的 提示:简要说明编写这份详细设计说明书的目的,指出预期的读者。 本详细设计说明书的适用读者为:软件开发者、测试人员 1.2背景 1.3术语定义 1.4参考资料 提示:列出所本文档所使用的参考资料,包括: A 本软件开发所经核准的合同或标书或可行性报告等文档 B 软件开发计
3、划书 C 需求分析报告 D 测试方案(若存在初稿的话) E 概要设计说明书 F 与本项目有关的已发表的文件或资料 G 本文件中各处引用的文件、资料,所采用的软件开发标准和规范 注意:必须列出文件、资料的作者、标题、编号、发表日期和出版单位,以说明这些文件资料的来源。若某些文档有保密要求的,则要说明其保密级别。 第二章系统概述 画出系统的体系结构图,以说明系统体系结构的实现技术,所用到的数据库主体的描述、如何实现访问数据库、如何划分程序的主体部分。可以采用MVC模式表述、也可以采用UML中的 系统设计主要是基于MVC设计模式,M代表模型Model,V代表视图 View, C代表控制器Contro
4、ller。MVC模式将系统分为三层,层与层之间通过又一定的模式联系,使数据实体与业务逻辑、业务逻辑与页面展现分离。 MVC模式图举例如下图: 图二-1 MVC模式图 第三章程序1设计说明 提示:从本章开始,逐步将各模块的功能和设计思想、内容等进行逐层解剖分析3.1程序描述 提示:给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点。 3.1.1模块架构图 提示:给出模块的代码结构,如典型的三层结构,可以用UML的组件图表达。3.1.2功能 提示:简要进行功能描述,可采用IPO(即输入-处理-输出图)表示。 3.1.3类图 提示:用UML类图利用面向对象思想设计模
5、块代码实现,用类图表达出完整的类结构,包括类名,属性,主要方法名称,方法参数,关键的方法或算法可以用标注的方法,用伪码表达出来。类图中要表示出类与类之间关系,从属关系、调用关系等。 UML类图举例如下: 图三-1 类图 注意,重要的方法要做详细的说明,举例如下: 3.1.4增加功能(功能点) 提示:简要进行功能描述,可采用IPO(即输入-处理-输出图)表示。 3.1. 4.1功能描述 增加机构的管理信息。 3.1. 4.2输入和界面设计 提示:图、表方式清晰描述每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件
6、等 3.1. 4.3类和接口设计 提示:列出本模块与其它模块的接口关系或要求列明所有接口,包括接口名称,调用方法,接口参数结构等。 1.接口: 接口名称: 接口方法: 输入参数: 返回信息: 2.数据接口: 3.其他接口: 3.1.5程序流程 提示:以流程图或顺序图形式给出本程序模块流转关系。包括一下参数: 输入参数: 处理过程: 涉及的数据结构: 返回结果: 其他参数: 3.1.6测试和限制条件 提示:给出详细设计中考虑的测试程序测试点和状态、参数等,以及对系统在程序运行、测试时需要做出的各种限制等。 3.1.7备注 第四章程序2设计说明提示:与上一章类似,若有N个,则需要分开N项描述。 第
7、五章公用接口程序说明 提示:给出各类公用接口的程序的设计考虑,如全局变量、数据字典、公用界面、公用方法和过程等。 5.1全局变量 提示:罗列各个全局变量的属性要求,包括全局变量名称、说明、数据类型、长度、取值范围等信息 5.2公用界面或接口 提示:要求描述清楚公用界面的界面布局情况,以及界面上所涉及到的各种数据项的相关属性,与界面相关的详细处理说明(有逻辑算法和计算公式,则要详细说明)、输入和输出数据要求等等,要求要附有界面的书面格式,可详细注明参见某个图表或某个相关附件 5.3公用方法和过程 提示:介绍公用方法和过程所实现的主要功能,说明公用方法和过程所需调用的输入参数、输出参数以及逻辑处理和相关算法描述,并注明该公用方法和过程的适用范围。可以使用表格形式表述。