系统概要设计项目说明指导书模板.doc

×××概要设计说明书

（V.XXX）

文档状态：
文档标识：
XXX-SD-
[√] 初稿
[ ] 正式公布
[ ] 修改
编 撰：

编撰日期：

保密等级：

文档版本：

xxxxx

修订历史统计
日期
版本
说明
作者

目录
1 引言 1
1.1 编写目标 1
1.2 背景 1
1.3 定义 1
1.4 参考资料 1
2 设计概要 1
2.1 设计范围 1
2.2 设计目标 1
2.3 设计标准 1
3 架构设计 2
3.1 概述 2
3.2 系统边界 2
3.3 系统架构 2
3.4 功效架构 2
3.5 技术架构 2
3.6 布署架构及软硬件配置 2
3.6.1 布署架构 2
3.6.2 硬件配置方案 2
3.6.3 软件配置方案 2
4 功效设计 3
4.1 模块1设计说明 3
4.1.1 模块描述 3
4.1.2 功效说明 3
4.1.3 步骤描述 3
4.1.4 相关算法 4
4.1.5 性能 4
4.1.6 限制条件 4
4.1.7 还未处理问题 4
5 权限设计 4
6 外部接口设计 5
6.1 XXXX接口 5
7 数据库设计 5
8 非功效设计 5
8.1 性能设计 5
8.2 事务处理 6
8.3 错误处理 6
8.4 日志处理和日志分析 6
8.5 安全设计 6
9 信息定义 6
10 风险管理 6
10.1 技术风险 6
11 遵照标准和规范 7

1 引言
1.1 编写目标
　　[说明编写这份设计说明书目标，指出预期读者。]
1.2 背景
[列出本项目标任务提出者、开发者、用户，提出缘由，现实状况分析等]
1.3 定义
　　[列出本文件中用到专门术语定义和外文首字母组词原词组。]
1.4 参考资料
　　[列出相关参考资料。]
2 设计概要
2.1 设计范围
[说明本文档设计所包含内容，如功效、接口描述]
2.2 设计目标
[从经过此次设计能够处理那些问题，达成什么样效果]
2.3 设计标准
[针对本项目说明系统设计所要遵照对应标准，如标准化、模块化等，并做具体说明]

3 架构设计
3.1 概述
3.2 系统边界
[定义系统和其它系统间功效、业务和数据边界]
3.3 系统架构
[用系统架构图描述本系统基础结构，关键包含直接组成系统各个组件。相对细致描述各个组件之间和系统和系统之间连接和通信关系]
3.4 功效架构
[用功效结构图和文字方法描述系统关键功效和功效之间关系]
3.5 技术架构
[用技术架构图和文字方法描述系统所采取技术路线和系统分层结构关系]
3.6 布署架构及软硬件配置
3.6.1 布署架构
[描述系统拓扑结构，包含应用服务器、数据库服务器、数据交换服务器等在物理上拓扑结构。]
3.6.2 硬件配置方案
[用列表形式说明系统硬件需求，关键包含硬件具体配置，用途、数量]
3.6.3 软件配置方案
[用列表形式说明系统软件需求，关键包含软件具体配置，用途、数量]

4 功效设计
4.1 模块1设计说明
[从本章开始，逐一地给出各个层次中每个模块设计考虑。以下给出提要是针对通常情况。对于一个具体模块，尤其是层次比较低模块或子程序，其很多条目标内容往往和它所隶属上一层模块对应条目标内容相同，在这种情况下，只要简单地说明这几点即可。]
4.1.1 模块描述
[给出对该模块基础描述，关键说明设计本模块对应关键需求，建设目标意义、建设关键内容、模块特点等]
4.1.2 功效说明
[说明该基础模块应含有功效,用列表形式列出该模块关键功效点，并描述各个功效点简明说明]以下图所表示：
原型界面
界面ID
功效概述
状态评价计划管理
PM00001
实现实状况态评价计划查询，修改，删除等功效

4.1.3 步骤描述
[用图表辅以必需说明来表示本模块逻辑步骤，能够用Visio绘制步骤图、或用活动图等图形形式来描述，也能够使用UML工具构建]
该部分需要根据模块业务步骤进行具体描述

4.1.4 相关算法
[对于使用到特殊或复杂算法，应具体说明算法计算公式及计算步骤，和实现方法等]
4.1.5 性能
功效点ID
估计最大数据量
响应时间要求
性能瓶颈点
处理该问题关键技术点

[说明对该模块性能要求，如定义多大数据量下，该模块响应时间，该性能定义也将作为系统开发完成后测试项目]
4.1.6 限制条件
[说明本模块在运行使用中所受到限制条件。]
4.1.7 还未处理问题
       说明在本程序设计中还未处理而设计者认为在软件完成之前应处理问题
5 权限设计
表述角色定义，功效权限、数据权限分组。

6 外部接口设计
6.1 XXXX接口
接口函数名：XXXX(string strxxx）
接口频度：[多长时间同时一次]
接口方法：[采取哪种方法实现该接口，如webservices等，是手动或自动同时]
参数strxxx：[参数内容说明]
返回值：[返回值定义]
Exception：[返回错误代码定义,可参见消息定义]
功效描述：功效描述
接口字段名
英文名
长度
类型
必传
内容说明
设备类型编码
FeatureType

　字符
●
　PAC
该部分内容能够为生成JavaDoc提供依据
7 数据库设计
【数据库设计内容关键给出数据库E-R图实例，并能生成数据库建库脚本】
8 非功效设计
8.1 性能设计
【描述我们可能碰到慢操作和查询和任何提升她们速度？我们所面临大数据量操作是什么？假如提升性能策略？（比如：建立数据库索引、数据分区、数据缓存）等】

8.2 事务处理
【系统事务处理策略和方法】
8.3 错误处理
【怎样处理应用系统和系统所产生错误？怎样校验用户输入？假如显示错误提醒？假如统计日志供系统管理员分析？假如预防系统瓦解？】
8.4 日志处理和日志分析
【用户操作日志怎样处理？】
8.5 安全设计
[从物理设备、网络层保护、操作系统安全防护，数据安全防护、应用层安全防护五个方面分别叙述怎样保障系统安全运行]
9 信息定义
消息ID
消息类型
消息内容
参数说明
I00001
Info
更新完成

W00001
Warning

E00001
Error

[在此处统一定义系统消息提醒信息，包含“信息”，“警告”，“错误”三种类型，并说明消息内容和参数说明，各功效模块在使用时候直接使用消息ID]

10 风险管理
10.1 技术风险
【描述我们技术风险，比如说我们所使用API改变我们怎么面对？】

11 遵照标准和规范