模板系统设计说明书

XXX项目系统设计说明书（文档编号： ）项目经理：生效日期：目 录1. 编制目的12. 适用范围13. 文件说明11. 概述51.1系统简介51.2系统目标51.3系统设计原则51.4系统运行环境51.5开发环境52. 总体结构62.1系统部署6系统拓扑结构6系统部署说明62.2软件部署63. 数据流程63.1数据流程图63.2数据流程图说明63.3数据字典64. 系统模块设计74.1子系统模块结构图74.2子系统模块概要设计75. 数据库设计85.1结构概要85.2表结构86. 接口设计96.1人机界面设计96.2软件接口设计96.3外部软件接口106.4外部硬件接口107. 数据设计107.1全局数据107.2文件组织结构117.3文件结构117.4数据备份、恢复118. 系统业务功能设计118.1业务内容118.2处理流程119. 其它设计1110. 代码组织1110.1源代码组织结构1110.2编译方式1210.3源代码文件说明1211. 术语表12 1. 概述1.1 系统简介简要描述本系统基本情况。1.2 系统目标描述概要设计所要实现的目标，包括功能目标、性能目标等。1.3 系统设计原则列举系统设计时遵循的基本理论或基本原则，例如面向对象的系统分析原则、逐步求精原则等。根据用户需求和系统设计原则，对设计要点进行优先级排序（注：一定要分出优先次序，不能有任何两项平级），要点可包括：体积大小、速度、可靠性、安全性、易测试性、易维护性、可复用性、可移植性等。1.4 系统运行环境包括对硬件平台、操作系统、数据库系统、中间件平台、编程平台、网络和外围设备、网络传输介质和网络协议的描述。对于B/S或C/S结构需要分别指出各部分的运行环境。1.5 开发环境列举项目组进行系统分析、程序设计和程序开发时用到的工程工具和开发语言。应描述每一工具软件的名称、版本等。2. 总体结构2.1 系统部署2.1.1 系统拓扑结构图以图形方式给出该软件产品在用户方部署时，预期的网络和硬件部署结构，以及系统和其他系统间的部署关系等。涉及网络结构时，建议使用网络拓扑图方式描述。对软件运行时需要配置的计算机或其他外部设备，均应以图形方式加以描述。2.1.2 系统部署说明对上面的系统部署图中每个系统设备的功能加以必要的描述，说明该设备的基本配置要求，其上运行的操作系统名称和版本，应用程序的名称和版本等。2.2 软件部署描述应用软件体系部署，可以包括设计思想、部署图、软件架构说明、层次结构等方面。3. 数据流程3.1 数据流程图以图形方式描述系统整体的数据流转情况及数据处理行为，数据流程图格式应符合软件工程的一般标准。3.2 数据流程图说明对上面的数据流程图中每个数据流转或数据处理环节加以必要的解释和说明。3.3 数据字典4. 系统模块设计4.1 子系统模块结构图以图形方式给出软件系统的子系统（或软件包）划分，模块划分，子系统间、模块间关系等。结构图格式应符合软件工程的一般标准。（注意：一般应在系统结构中包含“发布子系统”，即通常所说的安装程序或其他形式的发布程序，在下面的“子系统模块概要设计”中也应包含“发布子系统”的概要设计说明。）4.2 子系统模块概要设计对“子系统模块结构图”中出现的每个子系统或模块，描述以下内容： 名称和版本。 子系统或模块的内部编号（编号格式由项目组自定）。 表现形式（以何种形式运行，如服务程序、应用程序、COM组件、数据库脚本、JSP程序等等）。 功能描述。 处理流程图（对较简单的模块，在前面“功能描述”中已可以准确定义该模块功能的，可省略功能流程图） 子系统模块有无人机交互界面，如有，则给出该子系统-模块人机交互界面的类型（如普通Web界面、普通GUI界面、Java Applet界面、Java Swing界面、字符终端界面、命令行界面等）和设计原则（界面风格、基本操作方式等）。 与其他子系统或模块的接口（描述每个接口的名称、输入信息、输出信息、异常处理等）。 实现方式（以何种开发工具，何种开发语言实现该子系统或模块）。 实现思路（给出实现该模块的基本思路，包括对模块内部结构、算法、编程方法等的初步设想）。5. 数据库设计此节描述存储在通用数据库中的数据，或存储在硬盘、磁带、光盘等永久性存储介质上，但存储格式与通用数据库相同的数据。如果系统不以数据库方式存储数据，则此节可省略。5.1 结构概要描述数据库的系统设置、表空间分配、用户权限设置等概要信息。5.2 表结构必要时，可用单独的文档（如，XXX数据库结构设计）来描述数据库设计。对不需要单独的文档来描述数据库设计的，对系统使用的每一种数据库表或数据库视图，参考下面的表格，描述其内部结构：表或视图名称字段数该表在系统中的功能简述所属表空间或数据文件名称字段名称字段类型字段长度和精度主、外键关系字段说明字段取值范围或约束关系字段的缺省值创建该表的SQL语句：6. 接口设计6.1 人机界面设计对于系统中涉及人机交互界面的模块，从以下几方面内容进行描述： 界面类型（如普通Web界面、普通GUI界面、Java Applet界面、Java Swing界面、字符终端界面、命令行界面等） 界面图示。以图形方式给出界面外观，图形中应能清晰表现界面风格（颜色、字体、排版、样式等），界面要素个数，界面要素位置，界面要素的名称和显示文本内容，界面的修饰图案等。 菜单和工具栏描述。对有菜单和工具栏的界面，以文字或图形方式给出界面中的菜单和工具栏结构，包括其中每个菜单项或工具栏项目的名称、类型、对应的处理功能等。 界面的输入数据项目。描述用户在该界面上输入的数据名称、类型、格式、相关的界面要素名称等。 界面的输出数据项目。描述系统在该界面上输出的数据名称、类型、格式、相关的界面要素名称等。 界面响应的用户事件。以文本或图表方式列举界面响应的每种用户事件（例如鼠标点击、鼠标拖曳、热键等，但菜单和工具栏事件除外）的类型、名称、引发的处理动作等内容。 如该界面具有联机帮助系统，则描述联机帮助系统的实现方式（如Tooltip帮助、界面中的文本信息、文本文件、HTML文件、*.doc文件、*.hlp帮助文件、*.chm帮助文件等），概述其帮助信息内容，并注明帮助信息所在的原始文件名称。 其他需要描述的界面设计内容。6.2 软件接口设计对模块提供的与其他模块或其他系统交互的软件接口，描述以下内容： 接口名称，版本。 接口类型。 接口表现形式（函数调用、远程交易、信号响应等）。 接口的输入项目。 接口的输出项目。 接口完成的处理功能。 接口的异常处理设计。 其他需要描述的接口设计内容。6.3 外部软件接口对模块使用到的其他模块或其他系统的软件接口，列举以下内容：1. 接口所属的软件或模块名称。2. 接口名称。3. 接口的描述文档（一般为“参见XX模块详细设计说明书）。无参照文档的，在此给出接口的功能、输入、输出描述。6.4 外部硬件接口对模块使用到的硬件接口，在此给出该接口的规格描述（硬件名称、连接方法、电气特性等），或注明“参见XX”文件说明。7. 数据设计7.1 全局数据针对系统中使用的全局数据，包括变量和常量，描述以下内容：1. 变量或常量名称。2. 变量或常量类型。3. 变量或常量字节大小和内部结构。4. 变量或常量的用途。5. 其他需要描述的信息。7.2 文件组织结构指文件在存储介质上的目录层次、目录命名、文件类型、文件命名等内容。7.3 文件结构精确描述每种数据文件的内部结构。此项内容无特定格式要求。7.4 数据备份、恢复描述系统数据备份、恢复的方式、方法。8. 系统业务功能设计8.1 业务内容对该业务功能的内容进行概要说明。8.2 处理流程简单说明该业务的处理步骤及处理方法。对于复杂的流程，可以用流程图的方式进行说明；对于简单的、流线型的处理流程可以分步骤进行说明。9. 其它设计对以上概要设计中未包含项目的说明，如并行处理、安全设计、内存管理等。10. 代码组织10.1 源代码组织结构与本模块相关的源代码文件有哪些，这些源代码文件以何种目录结构组织。10.2 编译方式与本模块相关的源代码所属的工程文件或make文件名，编译本模块的方式及编译结果，与编译有关的控制说明（如编译时的版本控制选项、预处理宏的取值等）及其他相关内容。10.3 源代码文件说明对于本模块相关每一个主要源代码文件，参考下面的表格，描述该文件内容：源文件名称语言类别源文件内容及功能描述备注11. 术语表以字典形式给出该软件系统中使用的，有必要显示说明的术语名称及其解释，必要时，还可以给出该术语的英文译名、参考文献等信息。