软件概要设计说明书样本.doc

文档类别：
模板
文档编号：
TT-TEM-TS/SDS
版本号：
1.01

文档名称：
软件概要设计阐明书
项目名称：
XXXXXX
项目负责人：
XXXXXX

编写人：

编写时间：
8月3日
校对人：

校对时间：

复查人：

复查时间：

批准人：

批准时间：

版本变更记录

版本
文档时间
变更阐明

目 录
1 简介 5
1.1 目 5
1.2 合用范畴 5
1.3 项目背景 5
1.4 术语 5
1.5 环境描述 5
1.5.1 运营环境 5
1.5.2 开发环境 5
1.6 参照资料 6
2 系统概述 7
2.1 目的 7
2.2 需求概述 7
2.3 外部接口 7
2.4 条件与限制 7
3 架构设计 8
3.1 系统架构 8
3.2 接口设计 8
3.3 功能模块分解 8
3.4 目录构造 8
3.5 布置设计 8
4 模块概要设计 9
4.1 <模块编号>功能模块概要设计（面向过程）（模块名称） 9
4.1.1 功能阐明/单元测试要点 9
4.1.2 界面设计 9
4.1.3 解决流程 9
4.1.4 接口设计 9
4.1.5 数据构造和算法 9
4.1.6 故障/异常解决 9
4.2 类1概要设计（面向对象） 9
4.2.1 类名称 9
4.2.2 功能描述 10
4.2.3 类定义 10
4.2.4 对外接口 10
5 顾客界面设计 11
5.1 界面设计内容 11
5.2 界面设计与场景描述 11
6 数据库设计 12
6.1 数据库环境阐明 12
6.2 数据库设计命名规则 12
6.3 数据库逻辑设计 12
6.4 数据库物理设计 12
6.4.1 数据表总汇 12
6.4.2 数据表A设计 12
6.5 数据库安全设计 13
6.5.1 防止顾客直接操作数据库办法 13
6.5.2 顾客帐号密码加密办法 13
6.5.3 角色与权限 13
6.6 数据库管理与维护阐明 13
7 维护设计 14
8 附录 15
8.1 附录A－有关文档 15

1 简介
1.1 目
【概要设计阐明书目】
1.2 合用范畴
【概要设计阐明书合用范畴】
1.3 项目背景
¨ 任务提出者：。
¨ 开发者：
¨ 最后顾客：具备核心业务行业顾客。
¨ 实现该软件环境简述：基于TCP/IP局域网、WIN /NT/9X操作系统、JAVA、DELPHI、ROSE等开发设计工具。
1.4 术语
提供对的理解顾客需求所需所有术语定义、首字母缩写词和缩略语。可以通过参照项目词汇表来获取这些信息。
1.5 环境描述
1.5.1 运营环境
基本硬件配备为CPU PII366以上、内存128M 以上、硬盘 10G以上、网卡100M；运营软件需求为操作系统WINDOWNS /NT/9X。
1.5.2 开发环境
数据库Oracle系列;开发工具DELPHI、JAVA(Eclipse等);设计建模工具：ROSE；配备工具：VSS等。工具类型：数据库；开发工具；设计建模工具；配备工具；WEB服务器；操作系统；其她；
序号
工具名称
工具类型
版本

1.6 参照资料
XXX 2.3版本开发筹划和任务书。
XXX 2.3需求规格阐明书.doc。

2 系统概述
2.1 目的
系统所要实现目的
2.2 需求概述
阐明对本系统重要输入输出项目、解决功能性能规定。引用软件需求阐明书里面需求概述章节。
2.3 外部接口
描述该系统与外部系统接口。
2.4 条件与限制
Ø 时间约束：
Ø 资源约束：
Ø 成本约束：
Ø 功能范畴约束：

3 架构设计
详细描述系统设计方案和构架涉及各某些功能和原理，以及各某些之间接口、数据流程、控制流程。
3.1 系统架构
详细描述系统分层构造、实现方案、命名规范。（如果采用公司框架构造则做出阐明即可。）
3.2 接口设计
系统描述系统中接口关系。
3.3 功能模块分解
依照对《软件需求规格阐明书》分析，将系统分解成相对独立，具备高度复用性，数据联系简洁功能模块系列。
如果为面向对象分析设计办法，在此做整体类图。
3.4 目录构造
详细描述代码目录构造，web项目目录构造及页面样式和框架构造。
3.5 布置设计
对系统布置进行设计。

4 模块概要设计
4.1 <模块编号>功能模块概要设计（面向过程）（模块名称）
4.1.1 功能阐明/单元测试要点
该功能/模块详细阐明及单元测试要点。
4.1.2 界面设计
该功能/模块界面设计。（如果放在下面界面设计中，这里则左处阐明下面相应界面）
4.1.3 解决流程
用文本或图例阐明重要解决流程。如果没有话，填“无”。
4.1.4 接口设计
对内、外重要函数接口。如果没有话，填“无”。
4.1.5 数据构造和算法
描述核心数据构造和算法及函数设计。如果没有话，填“无”。
4.1.6 故障/异常解决
对也许浮现异常描述和解决。如果没有话，填“无”。
4.2 类1概要设计（面向对象）
4.2.1 类名称
描写类名称。
4.2.2 功能描述
描写该类实现详细功能。
4.2.3 类定义
描写类定义属性和办法。
4.2.4 对外接口
描写与外部类接口。

5 顾客界面设计
5.1 界面设计内容
阐述本软件顾客界面设计遵循规范及设计某些资源、内容。
5.2 界面设计与场景描述
阐明界面设计文献入口。

界面文献
重要场景描述

6 数据库设计
6.1 数据库环境阐明
1、阐明所采用数据库系统，设计工具，编程工具。
2、详细阐明数据库服务器所需配备。
6.2 数据库设计命名规则
1、完整并且清晰阐明本数据库命名规则。
2、如果本数据库命名规则与公司原则不完全一致话，请作出解释。
6.3 数据库逻辑设计
数据库设计人员依照需求文档，创立与数据库有关那某些实体关系图（ERD）。如果采用面向对象办法（OOAD），这里实体相称于类（class）。
6.4 数据库物理设计
1、重要是设计表构造。普通地，实体相应于表，实体属性相应于表列，实体之间关系成为表约束。逻辑设计中实体大某些可以转换成物理设计中表，但是它们并不一定是一一相应。
2、对表构造进行规范化解决（第三范式）。
3、可以采用powerDesiger设计文献代替。
6.4.1 数据表总汇
表名
功能阐明
表A

表B

6.4.2 数据表A设计
表名

列名
中文描述
数据类型（精度范畴）
空/非空
约束条件

补充阐明

6.5 数据库安全设计
提高软件系统安全性应当从“管理”和“设计”两方面着手。这里仅考虑数据库安全性设计。
6.5.1 防止顾客直接操作数据库办法
顾客只能用帐号登陆到应用软件，通过应用软件访问数据库，而没有其他途径操作数据库。
6.5.2 顾客帐号密码加密办法
对顾客帐号密码进行加密解决，保证在任何地方都不会浮现密码明文。

6.5.3 角色与权限
拟定每个角色对数据库表操作权限，如创立、检索、更新、删除等。每个角色拥有刚好可以完毕任务权限，不多也不少。在应用时再为顾客分派角色，则每个顾客权限等于她所兼角色权限之和。
角色
可以访问表与列
操作权限

角色A

角色B

6.6 数据库管理与维护阐明
在设计数据库时候，及时给出管理与维护本数据库办法，有助于将来撰写出对的完备顾客手册。

7 维护设计
XXX系统维护设计重要方式：
通过服务器Web服务界面，可以实行各种维护、升级、系统设立/升级、日记管理、服务管理等。
通过XXX服务器设立，可以实现自动下发。

8 附录
8.1 附录A－有关文档
² 数据库设计文献 文档途径：
² 界面设计文献 文档途径：