架构文档之《概要设计说明书》

                                                          概要设计说明书

文件编号
文件状态
当前版本
拟定				时间
审核				时间
批准				时间

一、引言

1.1、编写目的

本文档的目的旨在推动软件工程的规范化，使设计人员遵循统一的概要设计书写规范，节省制作文档的时间，降低系统实现的风险，做到系统设计资料的规范性与全面性，以利于系统的实现、测试、维护、版本升级等。

2.1、背景

1）. 项目起源：说明项目是如何开始的，包括项目的发起人、项目的起因和项目目标。
2）. 项目目的：明确项目的主要目标、意义和预期成果。
3）. 项目范围：阐述项目的范围，包括所解决的问题、涉及的业务领域和主要工作内容。
4）. 关键人物：介绍项目中的关键人物，如项目经理、技术负责人和其他核心成员。
5）. 项目时间表：提供项目的开始时间、预计结束时间以及关键里程碑。
6）. 环境与资源：说明项目所处的环境特点以及可用资源情况，如设备、场地、人力资源等。

3.1、术语和缩写解释

4.1、参考资料

二、概述

2.1、系统任务

2.1.1、系统目标

说明系统要实现的目标

2.1.2、运行环境

简要说明该系统运行环境的规定版本，包括软件和硬件的支持

2.1.3、与其他系统相关

和其他系统由交互时需说明互相之间的关系

2.2、需求规定

2.2.1、功能需求

2.2.2、非功能性需求

2.2.3、约束和假定

由客户强制说明系统约束，说明系统如何适应这些约束。本系统和外部系统关联比较紧密时会受到第三方系统的约束需要说明

三、总体设计

3.1、基本设计概念和处理流程

使用流程图说明

3.2、软件系统结构

3.2.1、用户模块

3.2.2、订单模块

3.3、功能需求与系统模块的关系

最好用矩阵图说明各项功能需求的实现通各模块的关系

3.4、接口设计

3.4.1、用户接口

说明用户请求参数和响应参数

3.4.2、外部接口

说明本系统与外部系统接口调用关系

3.4.3、内部接口

说明系统内部调用接口参数响应

3.5、数据结构设计

3.5.1、逻辑结构设计要点

给出系统所用到的接口字段名即长度用法

3.5.2、物理结构设计要点

给出存储位置及设备关联关系

3.5.3、数据结构与程序的关系

说明各个数据和程序的关系最好使用图说明

四、运行设计

4.1、运行模块组合

说明一下各种运行所经历内部程序的模块组合

4.2、运行控制

说明每种运行的方式方法和操作步骤

4.3、运行时间

每种运行模块所占用系统的时间

五、系统出错处理设计

5.1、出错信息

说明每种可能出错或者故障情况出现时，系统定义的出错信息和含义

5.2、补救措施

出现某种故障时所要采取的措施

六、系统维护设计

说明系统维护在程序内部做出的安排

七、尚未解决的问题

说明概要设计中需要做的但是因为各种原因没能实现的问题列表

世间哪有两全法，不负如来不负卿。