57 系统详细设计说明书Word格式.docx
- 文档编号:17393419
- 上传时间:2022-12-01
- 格式:DOCX
- 页数:8
- 大小:111.13KB
57 系统详细设计说明书Word格式.docx
《57 系统详细设计说明书Word格式.docx》由会员分享,可在线阅读,更多相关《57 系统详细设计说明书Word格式.docx(8页珍藏版)》请在冰豆网上搜索。
2008-12-10
第一章引言
一.1目的
提示:
简要说明编写这份详细设计说明书的目的,指出预期的读者。
本详细设计说明书的适用读者为:
软件开发者、测试人员
一.2背景
一.3术语定义
序号
术语名称
术语定义
1
2
3
一.4参考资料
列出所本文档所使用的参考资料,包括:
A本软件开发所经核准的合同或标书或可行性报告等文档
B软件开发计划书
C需求分析报告
D测试方案(若存在初稿的话)
E概要设计说明书
F与本项目有关的已发表的文件或资料
G本文件中各处引用的文件、资料,所采用的软件开发标准和规范
注意:
必须列出文件、资料的作者、标题、编号、发表日期和出版单位,以说明这些文件资料的来源。
若某些文档有保密要求的,则要说明其保密级别。
文档名称
作者
版本/日期
一.5文档编写格式
一级标题:
三号字体,黑体,加粗,1.5倍行距,居中。
二级标题,小三号字体,黑体,加粗,1.5倍行距,段前18磅段后6磅。
三级标题,小四号字体,黑体,加粗,1.5倍行距,段前18磅段后6磅。
三级以上标题、项:
小四号字体,宋体,常规,1.5倍行距,段前18磅段后6磅。
正文:
小四字体,宋体,常规,段前段后0行,1.5倍行距,缩进左右0个字符,首行缩进2个字符。
表格:
五号字体,宋体,1.25倍行距,段前留0.5行,段后留0行。
表头加粗。
页眉:
小5号字体,填写项目名称,单划线,居中
页脚:
小5号字体,页数(注意页数不包括封面),居中
第二章系统概述
画出系统的体系结构图,以说明系统体系结构的实现技术,所用到的数据库主体的描述、如何实现访问数据库、如何划分程序的主体部分。
可以采用MVC模式表述、也可以采用UML中的
系统设计主要是基于MVC设计模式,M代表模型Model,V代表视图View,C代表控制器Controller。
MVC模式将系统分为三层,层与层之间通过又一定的模式联系,使数据实体与业务逻辑、业务逻辑与页面展现分离。
MVC模式图举例如下图:
图2-1MVC模式图
第三章程序1设计说明
从本章开始,逐步将各模块的功能和设计思想、内容等进行逐层解剖分析。
三.1程序描述
给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点。
三.1.1模块架构图
给出模块的代码结构,如典型的三层结构,可以用UML的组件图表达。
三.1.2功能
简要进行功能描述,可采用IPO(即输入-处理-输出图)表示。
三.1.3类图
用UML类图利用面向对象思想设计模块代码实现,用类图表达出完整的类结构,包括类名,属性,主要方法名称,方法参数,关键的方法或算法可以用标注的方法,用伪码表达出来。
类图中要表示出类与类之间关系,从属关系、调用关系等。
UML类图举例如下:
图3-1类图
注意,重要的方法要做详细的说明,举例如下:
说明:
1.BaseAbsDao:
a)getAll():
返回所有信息的列表。
b)getById(stringid):
根据id检索,并返回特定的对象。
2.BaseBean:
三.1.4增加功能(功能点)
三.1.4.1功能描述
增加机构的管理信息。
三.1.4.2输入或界面设计
图、表方式清晰描述每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。
数量和频度、输入媒体、输入数据的来源和安全保密条件等
三.1.4.3类和接口设计
列出本模块与其它模块的接口关系或要求列明所有接口,包括接口名称,调用方法,接口参数结构等。
1.接口:
接口名称:
接口方法:
输入参数:
返回信息:
2.数据接口:
3.其他接口:
三.1.5程序流程
以流程图或顺序图形式给出本程序模块流转关系。
包括一下参数:
处理过程:
涉及的数据结构:
返回结果:
其他参数:
三.1.6测试和限制条件
给出详细设计中考虑的测试程序测试点和状态、参数等,以及对系统在程序运行、测试时需要做出的各种限制等。
三.1.7备注
第四章程序2设计说明
与上一章类似,若有N个,则需要分开N项描述。
第五章公用接口程序设计说明
给出各类公用接口的程序的设计考虑,如全局变量、数据字典、公用界面、公用方法和过程等。
五.1全局变量
罗列各个全局变量的属性要求,包括全局变量名称、说明、数据类型、长度、取值范围等信息
名称
说明
数据类型
长度
取值范围
五.2公用界面或接口
要求描述清楚公用界面的界面布局情况,以及界面上所涉及到的各种数据项的相关属性,与界面相关的详细处理说明(有逻辑算法和计算公式,则要详细说明)、输入和输出数据要求等等,要求要附有界面的书面格式,可详细注明参见某个图表或某个相关附件
五.3公用方法和过程
介绍公用方法和过程所实现的主要功能,说明公用方法和过程所需调用的输入参数、输出参数以及逻辑处理和相关算法描述,并注明该公用方法和过程的适用范围。
可以使用表格形式表述。
第六章附件
罗列与本详细设计报告相关的文档资料,可包括以下内容:
1.数据库设计的有关文档资料,如:
数据字典
2.用户界面有关约定、相关报表或模板格式、各种常规底稿模板等
3.编程语言程序设计规范
4.其它相关资料
评审意见
综合意见:
本文档经过大家评审讨论,最后一致认为:
可以通过/修改***些问题之后直接通过/存在较多问题,如***,请修改后举行第二次评审/或进行网站评审/或进行邮件评审。
结论:
一致同意通过
保留部分意见,通过
问题较多,不能通过
评审参与人员
角色
人员
个人意见
主持人
【个人保留的意见填写,完全同意或不同意,本栏都不写。
】
记录人
主要作者
评审人1
评审人2
评审人…
QA人员
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 57 系统详细设计说明书 系统 详细 设计 说明书