项目名称
系统设计说明书
| 模板编号 | PJ-QT-DP-04 |
| 文档版本号 | V01.00 |
文档编写时间:
编写部门:
部门负责人:
保密级别: □绝密 □机密 □保密 □公开
xxxxx公司
20 年 月
| 模版变更履历 | ||||
| 创建/变更人 | 变更内容 | 版本 | 创建/变更时间 | 批准人 |
| 王晶 | 模版新建 | V01.00 | 2009-5-11 | |
| 张彦德 | 保密级别“一般”改成“保密”;文档版本号,加“V01.00”; | V01.01 | 2009-12-21 | |
| 王晶 | 在2.1系统架构图的下面,增加复用和购买的构件。 | V01.02 | 2010-3-10 | |
| 文档变更履历 | ||||
| 创建/变更人 | 变更内容 | 版本 | 创建/变更时间 | 批准人 |
| 文档新建 | V01.00 | |||
1概要
1.1目的
说明编本文档的目的及预期读者。
1.2背景
| 项目名称 | |
| 任务提出者 | |
| 客户 | |
| 开发者 | |
| 用户 |
1.4参考资料
| 资料名称 | 资料来源 |
2.1系统架构图
在下表中列出项目中复用和购买的构件或功能。
| 复用 | 购买 |
| 1 | 1 |
| 2 | 2 |
依据《需求规格说明书》,列出软件要完成的上层需求的要点,包括功能性、非功能性需求对于各项需求进行简要阐述。
| 需求 | 简述 |
简要地说明对本系统的运行环境(包括软硬件环境和支持环境)的规定。
| 环境名称 | 描述 |
| 软件环境 | |
| 硬件环境 | |
| 支持环境 |
尽量使用图表的形式说明本系统的基本设计概念和处理流程。
2.5结构
用表及框图的形式说明本系统的系统元素(各层模块、子程序,公用程序等)的划分,扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系。
子系统划分:子系统清单;各子系统功能描述。
程序模块划分和功能分配:(包括前端程序模块和后端存储过程的划分和功能分配)子系统及程序模块清单;各程序模块功能描述;功能-模块对照表;模块-数据实体对照表。
2.6人工处理过程
说明在本软件系统的工作过程中不得不包含的人工处理过程(如果有的话)。
| 处理过程 | 描述 |
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
| 问题 | 描述 |
如果篇幅有限,此节详细内容可以用UML文件详细展现,在此处说明UML文件的名称即可。
3.1系统用例
3.1.1用例图
XX用例(名称)
3.1.2用例说明
3.2对象模型
3.2.1 总体类图介绍
3.2.2 对象描述
3.3其他
可根据需要将时序图、协作图、状态图、活动图等列于此处。
4接口设计
4.1 用户接口
说明将向用户提供的命令和它们的语法结构,以及软件的回答信息。
【系统对主要用户操作的响应方式,例如对于用户的操作错误,用对话框加文字的方式予以提示】
| 接口 | 命令 | 语法结构 | 回答信息 |
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口,本系统与各支持软件之间的接口关系。
软件接口
| 序号 | 接口编号 | 接口名称 | 对接实体1 | 对接实体2 | 接口内容 |
| 1 | RIF0101 | XXX数据接收接口 | 接口实体1 | 接口实体2 | 接口实体2接收接口实体1的数据 |
| 2 |
| 序号 | 设备名称 | 逻辑结构 | 物理地址 | 预期行为(设备作用) |
| 1 | 路由器 | 异地网络寻址 | ||
| 2 | VPN | 接入 |
说明本系统之内的各个系统元素之间的接口的安排。
【哪些模块是内部的接口模块,对这种模块的要求是怎样的?比如:数据库接口模块是通用的,我们应该把它做成一个动态库或组件。】
| 接口模块 | 处理 |
5.1功能1
本功能编号:SD0001(为每个功能编号,以便跟踪需求,填写需求跟踪矩阵,如SD0001,System Design)
5.1.1业务逻辑描述
充分理解需求的基础上,对本功能点相关的业务逻辑进行描述。
5.1.2功能的设计
在业务逻辑描述的基础上进一步对功能细节进行设计。
5.1.3功能逻辑流程描述
根据需要使用文字或图表的形式对本功能点相关的功能逻辑流程进行描述。
5.1.4关键程序详细设计
1.输入、输出项
给出对每一个输入、输出项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入输出的形式等。
2.算法
详细说明本程序所选用的算法,具体的计算公式和计算步骤。
3.流程逻辑
用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。
5.2功能2
本功能编号:SD0002
【编写要求见功能1】
5.3功能3
本功能编号:SD0003
【编写要求见功能1】
……
6运行设计
如不需要此节,整体删除即可。
6.1运行模块组合
说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合,说明每种运行所历经的内部模块和支持软件。
【例如:某自动报价系统,需求要求总代理可以看到最优价,并可以设定给二级代理的价格。因此当系统运行在二级代理的模式的时候将看不到系统的最优价格,也不需要“设定二级代理价格”的支持。】
6.2运行控制
说明每一种外界的运行控制的方式方法和操作步骤。
【例如:某网络系统,是否进行网络通信需要有一个按钮来控制,因此要特别说明,如果这个按钮没有被打开,系统就无法进行网络通信。】
6.3运行时间
说明每种运行模块组合将占用各种资源的时间。
【例如:某网络版的管理软件,模块A在进行某数据表进行操作时,将一直控制着该数据表,直到操作完成。在此期间,其他模块不能对该数据表进行包括读取在内的操作。】
7系统数据结构设计
7.1逻辑结构设计
给出本系统内所使用的每个数据结构的名称、标识符以及它们中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。
7.2物理结构设计
给出本系统内所使用的每个数据结构中的每个数据项的存储要求,访问方法、存取单位、存取的物理关系(索引、设备、存储区域)、设计考虑和保密条件。
8系统出错处理的设计
8.1出错信息
用表格方式说明每种可能的出错或故障情况出现时,系统输出信息的形式,含意及处理方法。
| 操作步骤 | 提示信息 | 备注 |
说明故障出现后可能采取的变通措施,包括:
后备技术——说明准备采用的后备技术,当原始系统数据万一丢失时启用的副本的建立和启动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术;
故障技术—— 说明准备采用的后备技术,使用另一个效率稍低的系统或方法来求得所需结果的某些部分,例如一个自动系统的降效技术可以是手工操作和数据的人工记录;
恢复及再启动技术——说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软件从头开始重新运行的方法。
8.3系统维护设计
说明为了系统维护的方便而在程序内部设计中做出的安排,包括在程序中专门安排于系统的检查与维护的检测点和专用模块。
9用户界面设计
和用户交互的最终界面在《详细设计说明书》中设计解释,在此应对系统的主界面和界面设计风格进行设计和描述。
10软件模块的物理分布
根据系统网络结构,描述软件模块在各个设备上的物理分布。下载本文