软件开发文档:-软件系统设计说明书.docx
公司名称
公司名称
{项目名称}
软件系统设计说明书
文件状态:
[√]草稿
[]正式发布
[]正在修改
文件标识:
当前版本:
作者:
审核:
完成日期:
版本历史
版本/状态
作者
审核
起止日期
备注
目录
TOC\o1-3\h\z0.文档介绍 4
0.1文档目的与范围 4
0.2读者对象 4
0.3参考文献 4
0.4术语与缩写解释 4
1.系统概述 5
2.设计约束 5
3.开发、测试与运行环境 5
4.软件系统结构图 6
4.1结构图A 6
4.2结构图B 6
5.功能模块设计概述 6
5.1模块汇总 6
5.2模块之间的关系 6
5.3命名规则(可选) 7
6.数据库设计概述 7
6.1数据库环境说明 7
6.2数据库命名规则 7
6.3安全性设计说明 7
6.4表汇总和表设计 7
7.用户界面设计概述 8
8.综合考虑(可选) 8
8.1稳定性和可扩展性 8
8.2性能分析 8
8.3复用和移植 8
8.4防错与出错处理 8
8.5其它 9
0.文档介绍
0.1文档目的与范围
0.2读者对象
0.3参考文献
提示:列出本文档的所有参考文献(可以是非正式出版物),格式如下:
[标识符]作者,文献名称,出版单位(或归属单位),日期
0.4术语与缩写解释
缩写、术语
解释
…
1.系统概述
提示:(1)说明本系统“是什么”,(2)描述本系统的主要功能。
2.设计约束
提示:
(1)需求约束。体系结构设计人员从需求文档(如《用户需求说明书》和《软件需求规格说明书》)中提取需求约束,例如:
本系统应当遵循的标准或规范
软件、硬件环境(包括运行环境和开发环境)的约束
接口/协议的约束
用户界面的约束
软件质量的约束,如正确性、健壮性、可靠性、效率(性能)、易用性、清晰性、安全性、可扩展性、兼容性、可移植性等等。
(2)隐含约束。有一些假设或依赖并没有在需求文档中明确指出,但可能会对系统设计产生影响,设计人员应当尽可能地在此处说明。例如对用户教育程度、计算机技能的一些假设或依赖,对支撑本系统的软件硬件的假设或依赖等。
3.开发、测试与运行环境
提示:说明本系统应当在什么样的环境下开发和运行,有什么强制要求和建议?
类别
标准配置
最低配置
开发环境
测试环境
运行环境
4.软件系统结构图
提示:
(1)将系统分解为若干子系统,绘制各种结构图(例如层次结构图、数据流图),说明各子系统的主要功能。(尽可能简单明了,但是能够阐述清楚系统的结构)。
(2)说明“如何”以及“为什么”(howandwhy)如此分解系统。
(3)说明各子系统如何协调工作,从而实现原系统的功能。
4.1结构图A
4.2结构图B
5.功能模块设计概述
5.1模块汇总
子系统A
模块名称
功能概述
信息管理系统
管理员注册摄像头信息
管理员修改摄像头信息
管理员删除摄像头信息
管理员查询摄像头信息
储存登陆中心控制系统的用户名和密码信息
储存所有摄像头的所有者信息
子系统B
模块名称
功能概述
中心控制系统
接受管理员“开始传送”指令并传递给对应的摄像头
接受管理员“停止传送”指令并传递给对应的摄像头
处理摄像头发送的“心跳”消息
处理摄像头的“报到”消息
对摄像头掉线的处理:通知摄像头所有者
显示当前所有摄像头的状态
指令发送失败,发送“超时”消息给管理员
子系统C
模块名称
功能概述
摄像头
每分钟发送一次“心跳”消息以保持“在线”状态
新加入的摄像头发送“报到”消息成功后状态变为“在线”
执行“开始传递”指令,传输视频信息给中心控制系统
执行“停止传递”指令,停止传输视频
5.2模块之间的关系
5.3命名规则(可选)
提示:说明源文件、类、函数、变量等命名规则
6.数据库设计概述
6.1数据库环境说明
提示:说明所采用的数据库系统,设计工具,编程工具,有关配置等
6.2数据库命名规则
提示:说明表、字段等命名规则
6.3安全性设计说明
提示:考虑用户密码、访问权限等等
6.4表汇总和表设计
表汇总
用途
表A
表B
表C
使用设计工具PowerDesign设计所有的表。
7.用户界面设计概述
提示:说明界面设计要素,注意事项,界面原型等。
8.综合考虑(可选)
8.1稳定性和可扩展性
提示:在“软件”生命周期内,判断哪些需求是不变的,预测哪些需求可能发生的变化。
在总体设计的时候,既要使总体结构稳定,又要适应需求变化。
8