{ 项目名称 }

总体概要设计报告

版 本 历 史

 目 录

0     文档介绍... 4

0.1      文档目的... 4

0.2      文档范围... 4

0.3      读者对象... 4

0.4      参考文献... 4

0.5      术语与缩写解释... 5

1     系统概述... 5

1.1      系统概述... 5

1.2      设计约束... 5

1.3      设计策略... 5

1.4      环境要求... 6

1.4.1       开发环境的配置... 6

1.4.2       运行环境的配置... 6

1.4.3       测试环境的配置... 6

2     总体设计... 6

2.1      系统总体结构... 6

2.2      功能分配... 7

2.2.1       子系统N的结构与功能... 7

3     模块设计... 7

3.1      模块命名规则... 7

3.2      模块汇总... 7

3.2.1       模块汇总表... 7

3.2.2       模块关系图... 8

3.3      子系统A的模块设计... 8

3.3.1       n模块A-n. 8

3.4      子系统B的模块设计... 8

3.4.1       n 模块B-n. 8

4     接口设计... 9

5     数据库设计... 9

5.1      数据库环境说明... 9

5.2      数据库的命名规则... 9

5.3      逻辑设计... 9

5.4      物理设计... 10

5.4.1       表汇总... 10

5.4.2       表A. 10

5.4.3       表B. 10

5.5      安全性设计... 10

5.5.1       防止用户直接操作数据库的方法... 11

5.5.2       用户帐号密码的加密方法... 11

5.5.3       角色与权限... 11

5.6      优化... 11

5.7      数据库管理与维护说明... 12

6     用户界面设计... 12

6.1      应当遵循的界面设计规范... 12

6.2      界面的关系图和工作流程图... 12

6.3      主界面... 12

6.4      子界面A.. 12

6.5      子界面B. 13

6.6      美学设计... 13

6.7      界面资源设计... 13

0         文档介绍

0.1    文档目的

 

0.2    文档范围

 

0.3    读者对象

 

0.4    参考文献

提示：列出本文档的所有参考文献（可以是非正式出版物），格式如下：

[标识符] 作者，文献名称，出版单位（或归属单位），日期

例如：

[AAA]作者，《立项建议书》，机构名称，日期

 [SPP-PROC-SD] SEPG，系统设计规范，机构名称，日期

0.5    术语与缩写解释

1         系统概述

1.1    系统概述

提示：（1）说明本系统“是什么”，（2）描述本系统的主要功能。

1.2    设计约束

提示：

（1）需求约束。体系结构设计人员从需求文档（如《用户需求说明书》和《软件需求规格说明书》）中提取需求约束，例如：

²  本系统应当遵循的标准或规范

²  软件、硬件环境（包括运行环境和开发环境）的约束

²  接口/协议的约束

²  用户界面的约束

²  软件质量的约束，如正确性、健壮性、可靠性、效率（性能）、易用性、清晰性、安全性、可扩展性、兼容性、可移植性等等。

（2）隐含约束。有一些假设或依赖并没有在需求文档中明确指出，但可能会对系统设计产生影响，设计人员应当尽可能地在此处说明。例如对用户教育程度、计算机技能的一些假设或依赖，对支撑本系统的软件硬件的假设或依赖等。

1.3    设计策略

提示：体系结构设计人员根据产品的需求与发展战略，确定设计策略（Design Strategy）。例如：

²  扩展策略。说明为了方便本系统在将来扩展功能，现在有什么措施。

²  复用策略。说明本系统在当前以及将来的复用策略。

²  折衷策略。说明当两个目标难以同时优化时如何折衷，例如“时－空”效率折衷，复杂性与实用性折衷。

1.4    环境要求

1.4.1          开发环境的配置

提示：说明本系统应当在什么样的环境下开发，有什么强制要求和建议？

 

1.4.2          运行环境的配置

提示：说明本系统应当在什么样的环境下运行，有什么强制要求和建议？

 

1.4.3          测试环境的配置

提示：说明本系统应当在什么样的环境下测试，有什么强制要求和建议？

（1）一般地，单元测试、集成测试环境与开发环境相同。

（2）一般地，系统测试、验收测试环境与运行环境相同或相似（更加严格）。

2         总体设计

2.1    系统总体结构

提示：

（1）将系统分解为若干子系统，绘制物理图和逻辑图，说明各子系统的主要功能。

（2）说明“如何”以及“为什么”（how and why）如此分解系统。

（3）说明各子系统如何协调工作，从而实现原系统的功能。

 

2.2    功能分配

2.2.1          子系统N的结构与功能

提示：

（1）将子系统N分解为模块（Module），绘制逻辑图（如果物理图和逻辑图不一样的话，应当绘制物理图），说明各模块的主要功能。

（2）说明“如何”以及“为什么”（how and why）如此分解子系统N。

（3）说明各模块如何协调工作，从而实现子系统N的功能。

 

3         模块设计

3.1    模块命名规则

提示：模块设计人员确定本软件的模块命名规则（例如类、函数、变量等），确保模块设计文档的风格与代码的风格保持一致。可以从机构的编程规范中摘取或引用（如果存在的话）。

 

 

3.2    模块汇总

3.2.1          模块汇总表

提示：这里模块是指相对独立的软件设计单元，例如对象类、函数包等等。

3.2.2          模块关系图

提示：参考体系结构设计文档

 

 

 

 

 

 

 

 

3.3    子系统A的模块设计

3.3.1          n模块A-n

 

3.4    子系统B的模块设计

3.4.1          n 模块B-n

 

4         接口设计

【包括用户、软、硬件接口及内部模块间调用接口。主要说明向用户提供的命令和语法结构。】

5         数据库设计

5.1    数据库环境说明

提示：

（1）说明所采用的数据库系统，设计工具，编程工具等

（2）详细配置

 

5.2    数据库的命名规则

提示：

（1）完整并且清楚的说明本数据库的命名规则。

（2）如果本数据库的命名规则与机构的标准不完全一致的话，请作出解释。

 

 

5.3    逻辑设计

提示：数据库设计人员根据需求文档，创建与数据库相关的那部分实体关系图（ERD）。如果采用面向对象方法（OOAD），这里实体相当于类（class）。

5.4    物理设计

提示：

（1）主要是设计表结构。一般地，实体对应于表，实体的属性对应于表的列，实体之间的关系成为表的约束。逻辑设计中的实体大部分可以转换成物理设计中的表，但是它们并不一定是一一对应的。

（2）对表结构进行规范化处理（第三范式）。

5.4.1          表汇总

 

5.4.2          表A

5.4.3          表B

……

5.5    安全性设计

提示：提高软件系统的安全性应当从“管理”和“设计”两方面着手。这里仅考虑数据库的安全性设计。

5.5.1          防止用户直接操作数据库的方法

提示：用户只能用帐号登陆到应用软件，通过应用软件访问数据库，而没有其它途径操作数据库。

5.5.2          用户帐号密码的加密方法

提示：对用户帐号的密码进行加密处理，确保在任何地方都不会出现密码的明文。

5.5.3          角色与权限

提示：确定每个角色对数据库表的操作权限，如创建、检索、更新、删除等。每个角色拥有刚好能够完成任务的权限，不多也不少。在应用时再为用户分配角色，则每个用户的权限等于他所兼角色的权限之和。

5.6    优化

提示：分析并优化数据库的“时－空”效率，尽可能地“提高处理速度”并且“降低数据占用空间”。

（1）分析“时－空”效率的瓶颈，找出优化对象（目标），并确定优先级。

（2）当优化对象（目标）之间存在对抗时，给出折衷方案。

（3）给出优化的具体措施，例如优化数据库环境参数，对表格进行反规范化处理等。

5.7    数据库管理与维护说明

提示：在设计数据库的时候，及时给出管理与维护本数据库的方法，有助于将来撰写出正确完备的用户手册。

6         用户界面设计

6.1    应当遵循的界面设计规范

提示：结合用户需求和机构的《软件用户界面设计指南》，阐述本软件用户界面设计应当遵循的规范（原则、建议等）。

 

 

6.2    界面的关系图和工作流程图

提示：

（1）给所有界面视图分配唯一的标识符。

（2）绘制各个界面之间的关系图和工作流程图。

 

 

6.3    主界面

提示：

（1）绘制主界面的视图；

（2）说明主界面中所有对象的功能和操作方式；

 

 

6.4    子界面A

提示：

（1）绘制子界面A的视图；

（2）说明子界面A中所有对象的功能和操作方式；

 

 

6.5    子界面B

……

 

 

 

6.6    美学设计

提示：

（1）阐述界面的布局及理由

（2）阐述界面的色彩及理由

 

 

6.7    界面资源设计

7.1 图标资源

7.2 图像资源

7.3 界面组件