XXX项目
概要设计说明书


1 引言
1.1 编写目的
[说明编写这份概要设计说明书的目的,指出预期的读者]
例如：
  本设计说明书简单阐明了XXX系统的XXX模块的基本设计思想、基本功能、模块划分以及模块间接口。以便于各模块开发人员能更好地了解该系统的基本情况及各模块详细功能。
1.2 参考文献
提示：列出本文档的所有参考文献（可以是非正式出版物），格式如下：
[标识符] 作者，文献名称，出版单位（或归属单位），日期
例如：
[AAA] 作者，《立项调查报告》，机构名称，日期
[BBB] 作者，《立项可行性分析报告》，机构名称，日期
[SPP-PROC-PIM] EPG，立项管理规范，机构名称，日期
1.3 术语与缩写解释
缩写、术语
解 释
SPP
精简并行过程，Simplified Parallel Process
PIM
立项管理，Project Initialization Management
…
2 总体设计
2.1 数据库设计说明书编写目的系统概述
[说明对本系统或模块的设计思想：模块划分原则、网络设计原则、开发模型等。]
2.2 系统设计原则
[说明本文件设计应遵循的原则等。]
2.3 设计中应用的关键技术
［说明本文件设计应用的关键技术，如多类型空间数据集成技术、海量图库管理技术、国土资源信息管理的多级服务器组建技术、国土资源信息WEB发布技术、工作流驱动技术、时域GIS管理技术］
2.4 系统结构图
[说明系统的内部结构，子系统/模块间的联系等，必须以图示和文字说明相结合]
2.5 网络结构图
[说明本系统在整体网络中的地位，及其和外界网络的关系，必须以图示和文字说明相结合]
2.6 系统功能模块图
[说明本系统的功能模块组成，及其各模块间的数据接口，各模块之间的控制与被控制关系，必须以图示和文字说明相结合]
2.7 数据流向图（或称为时序图）
[说明系统和外界的数据交互流程，并注明数据类型
或是模块和其它模块的数据交互流程，并注明模块间交互的数据类型]
【可参考《需求开发指南5.2》】
2.8 模块构成
系统划分模块：
对系统(或模块)中每一个功能，用图示或文字详细描述：
∙ 概述 --- 叙述功能名称、目标和作用；
∙ 输入 --- 叙述该功能输入的消息；
∙ 处理 --- 描述该功能做什么，如何对输入信息进行加工并转换成输出信息；
∙ 输出 --- 详述该功能输出的信息；
∙ 自主开发、复用、外包、采购方案---详述该模块的设计方案，包括自主开发、复用、外包、采购的选项。
模块名称
概述
输入
输出
处理
自主开发、复用、外包、采购方案
3 环境设计
[简要地说明对本系统的运行环境的规定]
4 硬件设备
[列出运行该软件所需要的硬设备.说明其中的新型设备及其专门功能.]
5 支持软件
[列出支持软件,包括要用到的操作系统、编程语言、编译(或汇编)程序、测试支持软件等及各软件的版本。]
6 接口设计
接口设计原则
取得一致性
类似的情况应该有让使用者有一致性的操作。在提示、选单与说明文件中，应该采用同样的名词。并且保持命令的一贯性。
让重度使用者使用快捷方式
当使用频率增加时，使用者会希望减少互动的次数、让每次的互动能够一次做更多的动作。缩写、功能键、隐藏功能与综观全局的功能，对专家来说非常有用。
提供有意义的回馈
当使用者做出一些动作时，系统应该提供回馈。越频繁的动作，其回馈的强度可以低一些。越重要或不寻常的动作，其回馈强度应该要显著一些。
设计对话产生结束
一连串的动作应该被组织成开始、中间、结束三部份。当动作结束的时候，要提供回馈让使用者知道动作已经完成。在做下个一连串的动作之前，先告知使用者整个流程，能够减轻使用者的压力、提高满意度。
提供简单的错误处理
最好不要让系统有严重错误的可能性。如果还是造成错误，系统应该能够侦测出来，并提供
一个简单、使用者可以理解的错误处理方式。
允许回到上一步
这个功能可以减低使用者的焦虑，因为使用者只到做错了可以重来。这个功能鼓励使用者探索不熟悉的选项。回到上一步的功能，可以包含一个、或是一连串的动作。
满足使用者控制的需求
有经验的使用者强烈的感觉到他们在控制系统，做出动作之后，系统提供回馈。系统设计上要让使用者作为动作的处发者，而不是响应者。