XX项目
设计规格说明书
(仅供内部使用)
重庆工学院计算机学院
XX年XX月XX日
修改记录
目录
1.引言.................................... 错误!未定义书签。
项目名称.................................... 错误!未定义书签。
编写目的.................................... 错误!未定义书签。
项目背景.................................... 错误!未定义书签。
定义........................................ 错误!未定义书签。
参考资料.................................... 错误!未定义书签。
2.任务概述..................................... 错误!未定义书签。
项目总体目标................................ 错误!未定义书签。
需求概述.................................... 错误!未定义书签。
运行环境.................................... 错误!未定义书签。
软件环境............................... 错误!未定义书签。
硬件环境............................... 错误!未定义书签。
开发环境.................................... 错误!未定义书签。
条件与限制.................................. 错误!未定义书签。
3.总体设计..................................... 错误!未定义书签。
系统架构.................................... 错误!未定义书签。
处理流程.................................... 错误!未定义书签。
4.功能详细设计................................. 错误!未定义书签。
功能1 ...................................... 错误!未定义书签。
功能说明............................... 错误!未定义书签。
功能结构............................... 错误!未定义书签。
类设计................................ 错误!未定义书签。
用户界面设计............................ 错误!未定义书签。
类1 的算法与程序逻辑.................. 错误!未定义书签。
方法1 .............................. 错误!未定义书签。
功能............................ 错误!未定义书签。
输入............................ 错误!未定义书签。
输出............................ 错误!未定义书签。
异常............................ 错误!未定义书签。
算法与逻辑...................... 错误!未定义书签。
方法2 .............................. 错误!未定义书签。
方法3 .............................. 错误!未定义书签。
类2 的算法与程序逻辑.................. 错误!未定义书签。
类3 的算法与程序逻辑.................. 错误!未定义书签。
功能2 ...................................... 错误!未定义书签。
功能3 ...................................... 错误!未定义书签。
功能n ...................................... 错误!未定义书签。
5.数据结构设计................................. 错误!未定义书签。
数据库的说明................................ 错误!未定义书签。
逻辑结构设计................................ 错误!未定义书签。
物理结构设计................................ 错误!未定义书签。
6. 接口设计..................................... 错误!未定义书签。
软件接口.................................... 错误!未定义书签。
硬件接口.................................... 错误!未定义书签。
7. 尚未解决的问题............................... 错误!未定义书签。
7. 附录......................................... 错误!未定义书签。
1.引言
项目名称
编写目的
【阐明编写概要设计说明书的目的,指明读者对象。
】
项目背景
【应包括:
a.项目的委托单位、开发单位和主管部门;
b.该软件系统与其他系统的关系。
】
定义
【列出本文档中所用到的专门术语的定义和缩写词的原文。
】
参考资料
【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:
a.项目经核准的计划任务书、合同或上级机关的批文;
b.项目开发计划;
c.需求规格说明书;
d.测试计划(初稿);
e.用户操作手册(初稿);
f.文档所引用的资料、采用的标准或规范。
】
2.任务概述
项目总体目标
【本项目的总体目标是什么,就是要得一个什么样的结果,例如:开发一个适用于大卖场的进销存管理系统】
需求概述
【对系统需求作一个总的说明】
运行环境
2.2.1 软件环境
【对运行的软件的要求,例如:客户端操作系统、服务器操作系统、数据库、中间件、浏览器等】
2.2.2 硬件环境
【对运行的硬件的要求,例如:服务器、客户机、网络设计、其他的特殊设备等】
开发环境
【对开发语言、开发工具等一些说明】
条件与限制
【对设计的一些条件限制的说明】
3.总体设计
系统架构
【说明系统的整件构成,可以用构件图、树形图进行描述。
主要说明系统由哪些部分构成,各部分的静态关系,需要对每部分作简要说明】
处理流程
【说明系统中各部分的动态关系,比如:调用关系、数据传递关系等,可以用活动图,流程图描述】
4.功能详细设计
功能1
4.1.1 功能说明
【本功能的总体说明,比如功能满足的需求】
4.1.2 功能结构
【如果功能由可以分为多个子功能,用图形描述各功能的有关系,并对每个子功能作必要的说明】
4.1.3 类设计
【对类的设计说明,可以用类图描述,主要描述本功能涉及到的核心类,如果这些类涉及到其他功能的类,也需要画出来,但需要说明在哪个功能里作了详细说明;
如果多个之间存在较为复杂的协作关系,需要用协作图,时序图描述类与类之间的协作关系;
类需要在下表中作详细说明:
说明:A表示访问属性,有:公、私、保,分别表公有、私有、保护。
】
4.1.4用户界面设计
【对功能涉及到的用户界面进行说明,可以用图形工具把界面画出来,并作必要的说明】
4.1.5 类1 的算法与程序逻辑
【如果类的方法的算法比较复杂,需要在此作详细的说明,
可以用状态图描述类的状态变化】
方法1
功能
【对方法的功能给予描述】
输入
【输入参数】
输出
【输入参数】
异常
【方法可能抛出的异常】
算法与逻辑
【如果算法比较复杂,可以活动图、流程图、伪代码来描述】
方法2
方法3
4.1.6 类2 的算法与程序逻辑
4.1.7 类3 的算法与程序逻辑
功能2
功能3
功能n
5.数据结构设计
数据库的说明
【一些数据设计相关的说明,比如什么类型的数据库,版本,设计的风格等说明】逻辑结构设计
【数据表逻辑设计,可以用ER图描述】
物理结构设计
【对每个表进行详细描述,例如:
1.流程,表名:workFlow
】
6. 接口设计
软件接口
【如果软件需要与其他系统交互,在这里进行说明。
主要说明有什么样的交互,需要怎么进行交互,以及接口标准】
硬件接口
【如是软件需要与一些特殊的硬件(如:条码读写设备,摄像设备,一些常规的设备不需要特别的说明,例如:打印机,计算机等)接口,在这里进行说明】
7. 尚未解决的问题
【如果还问题没有解决,在这里列出】
7. 附录
【一些其他相关的材料可以些列出,例如用户使用的一些表格】。