概要设计说明书模板

GEM/TMP-ENG-PDS-V1.0软件概要设计说明书高博软件实训中心PAGEiiGEMSoftwareTechnologySimuLab概要设计说明书（模板）PreliminaryDesignSpecification编号：GEM/TMP-ENG-PDS-V1.0日期：年月日编制：SEPG高博软件实训中心PAGEiiGEMSoftwareTechnologySimuLabGEM/TMP-ENG-PDS-V1.0软件概要设计说明书苏州软件（微软技术）实训基地文档控制变更记录版本日期作者/修改人注释苏州软件（微软技术）实训基地PAGEi目录1 概述 11.1 系统概述 11.2 文档概述 11.3 标识 12 引用文档 13 设计方法和原则 23.1 限制和约束 23.2 设计遵循原则 23.3 设计方法 24 总体设计 34.1 软件系统概述 34.2 模块划分 34.3 模块调用关系 35 接口设计 35.1 用户接口 35.2 外部接口 45.3 内部接口 46 数据库设计 46.1 外部设计 46.1.1 标识符 46.1.2 使用程序 46.2 支持软件 56.2.1 数据库命名规则 56.2.2 数据库对象命名规则 66.2.3 字段命名规则 66.2.4 SQL语句规则 66.3 数据库的逻辑结构设计 76.3.1 关系数据库的逻辑设计过程 76.3.2 E-R模型转换为关系模型 76.4 数据库的物理设计 76.4.2 视图设计 16.4.3 存储过程设计 16.4.4 触发器设计 16.5 安全性设计 26.5.1 防止用户直接操作数据库的方法 26.5.2 用户账号密码的加密方法 26.5.3 角色与权限 26.6 优化 26.7 数据库管理与维护说明 37 出错和维护设计 37.1 出错处理 37.1.1 出错信息 37.1.2 扑救措施 37.1.3 后备技术 37.1.4 恢复及重启技术 47.2 维护设计 4概要设计说明书 机密苏州软件（微软技术）实训基地 第1页概述系统概述描述本文档所适用的集成系统和软件系统的一般特征。简要说明项目背景、规模、完成的功能等。文档概述简述本文档的内容和目的。本文档是软件详细设计和编码的重要依据。本文将描述：标识写明本文档的完整标识文档，其中包括：唯一标识号：GEM/TMP-ENG-PDS-V1.0文档正式标题：例如：ViStar5.0非线性编辑系统软件概要设计说明书缩略语：序号缩略语全称简要说明123引用文档本文档中直接引用的所有文档，包括其它相关文档、经审批的立项申请表或合同、批文和编制该文档时参考的资料、文献、技术标准等。相关文档文档编号文档名称作者/修订者版本号备注其它编号文档名称作者/修订者发布日期出版单位备注设计方法和原则描述现有开发条件和需实现的目标，说明概要设计应遵循的原则和采用的设计方法。限制和约束简要说明现有技术条件、资金状况、开发环境（工具和平台）、时间限制以及在上述条件下要实现的系统目标。设计遵循原则描述对本软件系统进行概要设计的原则。注，设计原则可考虑以下内容：命名规则，意义明确无二义、简洁、无重复，如果是改进系统，则命名规则应考虑与原系统的一致性。模块独立性原则，避免重复定义，处理完整，输入输出明确；边界设计原则，包括外部接口、内部接口和用户接口，如有“接口设计”文档，在此引用即可；数据库或数据文件的设计规则，如有“数据库设计”文档，在此引用即可；安全和保密原则；系统的灵活性、适用性及可维护性；设计方法基于以上考虑，说明采用的设计方法。如果其中某些设计依赖于某种运行状态或方式，则在此说明这种特定依赖条件和必要的设计约定。总体设计根据“软件需求说明书”中功能需求的划分进行软件结构的概要设计。软件系统概述简要说明本软件系统在系统总体中的作用、接收的输入和产生的输出，以及与其它系统的相互关系。模块划分根据需求分析阶段功能的分类，确定本软件系统的内部结构和组成元素。注意：总体结构设计一般采取自顶向下的办法，逐级分解软件需求。在功能说明中要写出完成的软件需求说明书中对应的需求。序号模块名称功能说明模块调用关系给出系统调用的结构框图。接口设计描述本软件系统的接口特性。如果另行编写“接口设计文档”，则此处引用。接口的类型分为三种：用户接口、外部接口和内部接口。用户接口描述本软件系统应建立的与用户的接口，即人机接口：列出提供给用户的操作命令以及每条命令的语法结构，如果是图形用户接口，给出操作界面；列出用户提交不同命令时，本软件系统做出的应答信息。外部接口描述本软件系统与系统总体中其它部分的接口，包括：与硬件的接口；与其它软件系统的接口；与相关支持软件，如非开发软件的接口，并对支持软件加以说明。序号名称参数描述功能说明类型名称说明内部接口描述本软件系统内部个模块的调用接口：序号名称参数描述返回类型功能说明类型名称说明数据库设计外部设计标识符提示：详细说明用于唯一地标识该数据库的名称或标识符以及附加的描述性信息。说明：本节不能裁剪。样例：本数据库名称为db_wangiu。Wanliu是客户湾流公司名称“湾流”的拼音形式。使用程序提示：列出将要使用或访问此数据库的所有应用程序，对于这些应用程序的每一个，给出它的名称和版本号。说明：本节不能裁剪。样例：湾流企业平台系统Version1.0使用本数据库。支持软件提示：简单介绍同此数据库直接有关的支持软件，如数据库管理系统、存储定位程序和用于装入、生成、修改、更新数据库的程序等。说明这些软件的名称、版本号和主要功能特性，如所用数据模型的类型、允许的数据容量等。列出这些支持软件的技术文件的标题、编号及来源。说明：本节不能裁剪。样例：PowerdesignerV10.0用于设计和生成数据库结构。数据库命名规则提示：描述对本系统进行概要设计的原则，设计原则可考虑以下内容：完整并且清楚的说明本数据库的命名规则；如果本数据库的命名规则与机构的标准不完全一致的话，请作出解释。说明：本节可以裁剪。数据库涉及字符规则提示：与字符有关的命名规则：说明：本节不能裁剪。样例：采用26个英文字母（区分大小写）和0~9这十个自然数，加上下划线_组成，共63个字符。不能出现其他字符（注释除外）；所有的数据对象绝对不能使用汉语拼音或其缩写来命名。数据库对象命名规则提示：与数据库对象如有关的表、视图（查询）、存储过程（参数查询）、索引，触发器等的命名规则。说明：本节不能裁剪。样例：数据库对象包括表、视图（查询）、存储过程（参数查询）、索引，触发器。对象名字由前缀和实际名字组成，长度不超过30；数据表能用一个英文单词表示，就尽量不要缩写；前缀：使用大写字母。类型前缀举例表（Table）T_T_User视图（View）V_V_Depart_Users存储过程（StorePreocess）SP_SP_InsertUser索引（Index）I_I_UserName触发器（Trigglers）TR_TR_ClearNums字段命名规则提示：与数据表字段有关的命名规则。说明：本节不能裁剪。样例：字段命名中所有单词紧靠在一起，字段首字母小写，大写后面单词的首字母。SQL语句规则提示：与SQL语句有关的书写规则。说明：本节不能裁剪。样例：所有SQL关键词全部大写，比如SELECT,UPDATE,FROM,ORDER,BY等。数据库的逻辑结构设计关系数据库的逻辑设计过程提示：由于DBMS目前一般采用关系数据模型，因此数据库的逻辑设计，就是将概念设计中所得到的E-R图转换成等价的关系模式。说明：本节不能裁剪。E-R模型转换为关系模型提示：实体与关系的转换方式。说明：本节可以裁剪。样例：数据库设计人员根据需求文档，创建与数据库相关的那一部分的实体关系图。如果采用面向对象方法，其实体相当于类数据库的物理设计提示：实体与关系的转换方式。说明：本节可以裁剪。样例：样例：主要是设计表结构。一般地，实体对应于表，实体的属性对应于表的列，实体之间的关系成为表的约束。逻辑设计中的实体大部分可以转换成物理设计中的表，但是它们并不一定是一一对应的；对表结构进行规范化处理（第三范式）。表设计提示：所有数据表的汇总和详细设计以及说明。说明：本节不能裁剪。表汇总序号名称用途与约束1T_User用户表2表B3表C4表D5表E本节不能裁剪。表A序号字段名字段说明类型长度NULLDEFAULTPKUKFKIndex备注1userIDVARCHAR20NOTY2departmentIDVARCHAR20NOT13nameVARCHAR20NOT4……补充说明表N序号字段名字段说明类型长度NULLDEFAULTPKUKFKIndex备注1234补充说明苏州软件（微软技术）实训基地苏州软件（微软技术）实训基地视图设计提示：所有数据视图的汇总和功能说明。说明：本节不能裁剪。样例：序号视图名称功能说明1V_Users_Product用户购买的产品视图2视图B3视图C……存储过程设计提示：所有存储过程的汇总和功能说明。说明：本节不能裁剪。样例：序号存储过程名称功能说明1SP_AddUsert增加用户2存储过程B3存储过程C……触发器设计提示：所有触发器的汇总和功能说明。说明：本节不能裁剪。样例：序号触发器名称功能说明1TR_ClearNums数字清零2触发器B3触发器C……安全性设计提示：提高软件系统的安全性应当从“管理”和“设计”两方面着手。这里仅考虑数据库的安全性设计。说明：本节不能裁剪。样例：说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据