软件系统详细设计说明书模板-软件系统说明书模板

远程多考区在线考试系统第15页共15页xxxxx系统

详细设计说明书文件状态：[√]草稿[]正式发布[]正在修改文件标识：当前版本：1.0作者：完成日期：版本历史版本/状态作者参与者起止日期备注1.0开始编写修改记录日期修订版本修改章节修改描述作者

目录TOC\o"1-4"\h\z\u1 引言 51.1 编写目的 51.2 背景 51.3 参考资料 51.4 术语定义及说明 52 设计概述 52.1 任务和目标 52.1.1 需求概述 52.1.2 运行环境概述 52.1.3 条件与限制 62.1.4 详细设计方法和工具 63 系统详细需求分析 63.1 详细需求分析 63.2 详细系统运行环境及限制条件分析接口需求分析 64 总体方案确认 64.1 系统总体结构确认 64.2 系统详细界面划分 74.2.1 应用系统与支撑系统的详细界面划分 74.2.2 系统内部详细界面划分 75 系统详细设计 75.1 系统程序代码架构设计 75.1.1 UI(UserInterface)用户界面表示层 75.1.2 BLL(BusinessLogicLayer)业务逻辑层 85.1.3 DAL(DataAccessLayer)数据访问层 85.1.4 Common类库 85.1.5 EntityClass实体类 85.2 系统结构设计及子系统划分 85.3 系统功能模块详细设计 95.3.1 XX子系统 9.1 XX模块 9列表和分页 9创建XX 9.2 XX模块 9XX列表 9XX修改 95.3.2 XX子系统 95.3.6.1 用户管理模块 95.3.6.2 角色管理模块 145.3.6.3 系统设置模块 145.3.6.4 系统登录注销模块 145.4 系统界面详细设计 145.4.1 外部界面设计 145.4.2 内部界面设计 145.4.3 用户界面设计 146 数据库系统设计 146.1 设计要求 146.2 信息模型设计 146.3 数据库设计 146.3.1 设计依据 146.3.2 数据库种类及特点 156.3.3 数据库逻辑结构 156.3.4 物理结构设计 156.3.5 数据库安全 156.3.6 数据字典 157 信息编码设计 157.1 代码结构设计 157.2 代码编制 15引言编写目的说明编写详细设计方案的主要目的。说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）和数据库系统的设计考虑，为程序员编码提供依据。如果一个软件系统比较简单，层次很少，本文件可以不单独编写，和概要设计说明书中不重复部分合并编写。方案重点是模块的执行流程和数据库系统详细设计的描述。背景应包含以下几个方面的内容：A.待开发软件系统名称；B.该系统基本概念，如该系统的类型、从属地位等；C.开发项目组名称。参考资料列出详细设计报告引用的文献或资料，资料的作者、标题、出版单位和出版日期等信息，必要时说明如何得到这些资料。术语定义及说明列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文。设计概述任务和目标说明详细设计的任务及详细设计所要达到的目标。需求概述对所开发软件的概要描述,包括主要的业务需求、输入、输出、主要功能、性能等，尤其需要描述系统性能需求。运行环境概述对本系统所依赖于运行的硬件，包括操作系统、数据库系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。条件与限制详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。详细设计方法和工具简要说明详细设计所采用的方法和使用的工具。如HIPO图方法、IDEF（I2DEF）方法、E－R图，数据流程图、业务流程图、选用的CASE工具等，尽量采用标准规范和辅助工具。系统详细需求分析主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。详细需求分析包括：详细功能需求分析详细性能需求分析详细资源需求分析详细系统运行环境及限制条件分析详细系统运行环境及限制条件分析接口需求分析包括：系统接口需求分析现有硬、软件资源接口需求分析引进硬、软件资源接口需求分析总体方案确认着重解决系统总体结构确认及界面划分问题。系统总体结构确认对系统组成、逻辑结构及层次进行确认，对应用系统、支撑系统及各自实现的功能进行确认，细化集成设计及系统工作流程，特别要注意因软件的引进造成的系统本身结构和公司其他系统的结构变化。包括：系统组成、逻辑结构及层次确认应用系统结构确认支撑系统结构确认系统集成确认系统工作流程确认系统详细界面划分应用系统与支撑系统的详细界面划分应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范围及访问方式，网络及数据库对应用系统的支撑方式，全局数据的管理与存取方式等。系统内部详细界面划分系统各功能之间的界面包括覆盖范围，模块间功能调用涉及到的系统模块及方法，全局数据格式，系统性能要求等。系统详细设计系统程序代码架构设计系统采用三层架构模型，将应用系统划分为用户界面表示层、业务逻辑层、数据访问层，以及EntityClass实体类、Common类库组成，各层的关系如下图所示：UI(UserInterface)用户界面表示层负责与用户进行交互，显示、接受数据，与此同时，做一些简单逻辑处理，如：输入数据有效性判断、显示各种异常、处理Dataset记录集数据。它只与BLL(BusinessLogicLayer)业务逻辑层、EntityClass实体类两个项目发生关联，可能与Common类库发生关联。BLL(BusinessLogicLayer)业务逻辑层是整个系统的核心，它承担了所有的逻辑判断，实现了程序的功能，它是灵活的。BLL层既是调用者，又是被调用者，因此，要适当的进行设计达到解耦的效果。BLL层只关联DAL层和实体类，可能关联Common类库。虽然BLL层被U层调用，但是BLL层无需关心UI层的情况。数据库中每个表都对应一个BLL类，为了达到解耦效果，BLL类不能直接调用其他表的DAL类，可以BLL类之间相互调用。DAL(DataAccessLayer)数据访问层提供数据访问的接口，没有任何逻辑。在接口中对数据库操作语句进行组合装配。DAL层一般关联Common类库中的最底层，最基础的数据库类（比如：链接数据库），必须关联EntityClass实体类项目。DAL层只是数据库的管理者，但不是访问者，不直接与数据库发生关联。数据库中每个表都对应一个DAL层的接口(访问控制)类。Common类库用于存放公用的类。最常用的就是数据库访问类，比如：链接字符串，数据库引擎类。它直接与数据库进行机械式的交换，无任何逻辑。EntityClass实体类相当于加强的数据结构，实现了对数据的封装。数据库中每个表都对应一个实体类，表的字段就是实体类的属性，类型一一对应。UI、BLL、DAL这三层的交互主要就是通过实体类作为参数，并Return回信息。系统结构设计及子系统划分根据业务和功能，将系统的逻辑结构划分为XX子系统、XX子系等6个子系统，如下图所示：XXXXXXXXXXXXXXXX系统XX管理子系统XX管理子系统XX子系统XX子系统XX子系统XX子系统各个子系统按照功能角度分解，划分出若干不同的功能模块，如下面各图所示：系统功能模块详细设计按结构化设计方法，在系统功能逐层分解的基础上，对系统各功能模块或子系统进行设计。此为详细设计的主要部分之一。用层次图描述系统的总体结构、功能分解及各个模块之间的相互调用关系和信息交互，用IPO图或其他方法描述各模块完成的功能。以上建议采用HIPO图进行功能分解与模块描述，更高的要求建议采用IDEF0方法进行功能模型设计。详细设计应用系统的各个构成模块完成的功能及其相互之间的关系，用IPO或结构图描述各模块的组成结构、算法、模块间的接口关系，以及需求、功能和模块三者之间的交叉参照关系。每个模块的描述说明可参照以下格式：模块编号：模块名称：输入：处理：算法描述：输出：其中处理和算法描述部分主要采用伪码或具体的程序语言完成。对详细设计更高的要求建议用IDEF0图进行各功能模块的设计。如果对软件需进行二次开发（包括功能扩展、功能改造、用户界面改造等），则相应的设计工作应该设立子课题完成。注意：算法描述主要是说明BLL层的代码逻辑，UI层只做简单的输入验证和界面显示功能。XX子系统XX模块列表和分页创建XXXX模块XX列表XX修改XX子系统用户管理模块模块描述：管理系统用户，包括添加用户并赋予角色、修改用户资料和角色、删除用户。主要功能：添加用户、修改用户、删除用户、列表和分页。列表和分页流程图省略输入项分页索引 页面传参数 页面加载时为1输出项列表详细记录；当前页码；分页总数；记录总数。算法描述系统管理用户数据量不大，而且该功能使用频率不高，可以不用优化分页，直接获取用户表全部记录，建议UI层使用gridview控件，调用ExamSys.BLL.System_admin_infoGetAllList()绑定控件，利用gridview自带分页功能，显示分页按钮、当前页、分页总数、记录总数、添加用户流程图输入用户输入用户资料选择角色加密密码填写合规用户信息保存至表System_admin_info验证必填项验证用户名是否存在是否成功分拆角色ID字符串循环字符串数组信息保存至表Dict_admin_vs_roles返回成功信息是否是返回失败信息否是否操作记录日志输入项用户ID string 必填姓名 string 必填用户密码 string 必填确认密码 string 必填联系电话 stringE-mail string状态 char用户角色ID string 输出项成功，UI提示添加用户完成；失败，UI提示具体信息。算法描述前端js判断必填项的输入和二次密码是否相同，角色可以不选；BLL须验证必填项，用户名是唯一的不能重复；加密密码使用MD5.Encrypt(stringString,stringKey)，Key="XXXXXXXX"；用户信息保存至表System_admin_info，ExamSys.DAL.System_admin_infoAdd(ExamSys.Model.System_admin_infomodel)；分拆角色ID字符串并循环字符串数组，信息保存至表Dict_admin_vs_roles，ExamSys.BLL.Dict_admin_vs_rolesAdd(ExamSys.Model.Dict_admin_vs_rolesmodel)。修改用户流程图输入用户输入用户资料选择角色填写合规用户信息保存至表System_admin_info验证必填项加密密码是否成功分拆角色ID字符串循环字符串数组信息保存至表Dict_admin_vs_roles返回成功信息是是返回失败信息否否根据用户ID删除表Dict_admin_vs_roles记录是否成功是否操作记录日志输入项用户ID string 页面传参数姓名 string 必填用户密码 string 必填确认密码 string 必填联系电话 stringE-mail string状态 char用户角色ID string 输出项成功，UI提示修改用户完成；失败，UI提示具体信息。算法描述前端js判断必填项的输入和二次密码是否相同，角色可以不选；加密密码使用Chukeh.Security.MD5.Encrypt(stringString,stringKey)，Key="LinLiYan"；根据用户ID删除表Dict_admin_vs_roles的记录ExamSys.BLL.Dict_admin_vs_rolesDeleteByAdminID(stringadmin_id)；分拆角色ID字符串并循环字符串数组，信息保存至该表ExamSys.BLL.Dict_admin_vs_rolesAdd(ExamSys.Model.Dict_admin_vs_rolesmodel)。删除用户流程图列表中列表中点击删除按钮是否成功返回成功信息是返回失败信息否根据用户ID删除表Dict_admin_vs_roles记录是否成功是否根据用户ID删除表System_admin_info记录操作记录日志输入项用户ID string 页面传参数输出项成功，UI提示删除用户完成，刷新列表；失败，UI提示具体信息。算法描述根据用户ID删除表System_admin_info的记录ExamSys.DAL.System_admin_infoDelete(stringadmin_id)；根据用户ID删除表Dict_admin_vs_roles的记录ExamSys.BLL.Dict_admin_vs_rolesDeleteByAdminID(stringadmin_id)。角色管理模块系统设置模块系统登录注销模块系统界面详细设计系统界面说明应用系统软件的各种接口。整个系统的其他接口（如系统硬件接口、通讯接口等）在相应的部分说明。外部界面设计根据系统界面划分进行系统外部界面设计，对系统的所有外部接口（包括功能和数据接口）进行设计。内部界面设计设计系统内部各功能模块间的调用关系和数据接口。用户界面设计规定人机界面的内容、界面风格、调用方式等，包括所谓的表单设计、报表设计和用户需要的打印输出等设计。此部分内容可能比较多。数据库系统设计此数据库设计可单独成册，尤其对大型的数据库应用系统，即有一个单独的《数据库设计说明书》。设计要求信息模型设计确定系统信息的类型（实体或视图），确定系统信息实体的属性、关键字及实体之间的联系，详细描述数据库和结构设计，数据元素及属性定义，数据关系模式，数据约束和限制。数据库设计设计依据说明数据被访问的频度和流量，最大数据存储量，数据增长量，存储时间等数据库设计依据。数据库种类及特点说明系统内应用的数据库种类、各自的特点、数量及如何实现互联，数据如何传递。数据库逻辑结构说明数据库概念模式向逻辑模式转换所采用的方法论及工具，完成数据库概念模式向逻辑模式的转换。详细列出所使用的数据结构中每个数据项、记录和文件的标识、定义、长度及它们之间的相互关系。此节内容为数据库设计的主要部分。物理结构设计列出所使用的数据结构中每个数据项的存储要求、访问方法、存取单位和存取物理关系等。建立系统程序员视图，包括：数据在内存中的安排，包括对索引区、缓冲区的设计；所使用的外存设备及外存空间的组织，包括索引区、数据块的组织与划分；访问数据的方式方法。数据库安全说明数据的共享方式，如何保证数据的安全性及保密性。数据字典编写详细的数据字典。对数据库设计中涉及到的各种项目，如数据项、记录、系、文卷模式、子模式等一般要建立起数据字典，以说明它们的标识符、同义名及有关信息。信息编码设计代码结构设计确认信息分类编码总体方案，进行分类代码结构设计。代码编制按代码结构编制信息代码篇一：农村居民私人建房申请表(范文)农村居民私人建房申请表（范文）镇（乡）城建办（村镇办）：国土资源所：本人系镇（乡）村村民（姓名），原住宅位于（自然村名），原集体建设使用证，编号，用地面积平方米。由于（建房原因），需在（新建地）建造住宅，建筑占地约平方米，建筑层次为层。原房屋。（行政村意见）：（是否符合规划：中心村、保留点）申请人：年月日德清县乡村建设规划许可证申请表（农房）篇二：农村个人建房申请书农村个人建房申请书xx土地规划局：.我叫xxx，是×x乡xx村xx组农民。由于下列几个原因，我申请新建住房。一、我现住的房屋，还是1956年建的简陋木制瓦房，至今己近50年，虽经过多次整修，但破损处仍然较多，修修补补既难解决漏雨漏风问题，也影响房屋外观。因而建新房非常有必要。二、我现居住的房屋一共5间，60多平方米，要住8人，还要堆放粮食等，显得十分拥挤。特别是我大儿子后年要娶媳妇，女方家要求必须有新房才肯嫁过来。为了改善现有的住房状况，为.了我大儿子能顺利成家，我也必须建新房。三、这些年来，党的政策越来越好，我们农民的收入也一年比一年增加。我通过二十多年的辛勤劳动，不断积攒，已基本上攒够了建新房(建成砖混水泥房)的费用。只要上级一批准，我就能马上动工。四、我建房的方案是：拆除现有的住房，主要在老地基建新房，另外占用我现住房背后的自留地40平方米。所建房屋为一楼一底，约200平方米。特此申请，敬请审核批准。附：l.现住房照片2.生产小组的证明。此致敬礼!申请人：xx乡xx村xx组xxxxx申请时间：×x年x月x日居民个人建房申请书国有土地范围内房屋，也就是城镇自建房,在有关法律文件生效或者事实发生后以买卖、互换、赠与、继承、遗赠等方式申请房屋所有权转移登记。集体土地范围内房屋所有权转移登记，则有严格规定。福泉市建设局：我是(乡镇/办事处)居民，拟(新、翻、扩)建住宅。拟建房屋用地位于：(乡镇/办事处)路，总用地面积平方米，建筑占地面积平方米，层数层，建筑面积平方米。本人承诺拟建房屋和四邻无争议。特此申请申请人：(签字、指印)年月日联系电话：篇三：农村建房申请书建房申请书尊敬的xxxxx领导：您好！我系xxx镇xxx村xx组村民xxx，今年xxx岁。由于以下几点原因，我申请新建住房一栋。一、我现住住房，是1987年建的简陋瓦房，至今己25年，虽经过多次整修，但破损处仍然较多，修修补补既难解决漏雨漏风问题，也影响房屋外观。因而建新房非常有必要。二、我现居住的房屋一共8间（楼上四间陋雨，可用四间），____多平方米，要住9人，还要堆放粮食、农具、杂物等，显得十分拥挤。由于目前我在外地务工，因此还可勉强居住，但过年过节回家，居住问题已非常严峻，并且不可能一辈子在外务工，迟早会返乡。特别是明年4月宝宝将降生，届时四世同堂，住房问题更严峻，因此建新房成为家族中亟需解决的问题。三、父亲生两女，我和姐姐两姊妹，现在我和姐姐都到了谈婚论嫁的年纪，并且已经属于晚婚晚育年龄，同辈都已生儿育女，年龄问题将不能再拖，有幸今年找到另一半，但男方要求必须有新房才肯上门做女婿，由于住房迟迟得不到解决，婚事也一拖再拖。为了让父母放心我的终身大事，顺利成家，建新房成为亟待解决的难题。四、考虑到一些具体需求，因此不在以前地基上建而要另外采用地皮建房。1、原来地皮面积满足不了现在建房面积的需求。左右比较狭窄，面积较小，不能满足一个四世同堂家族的住房面积需求。2、重新拆了旧房建新房需要一笔很大的拆迁费用，将给家庭带来严重的经济负担，是家庭富裕的拉路虎，有悖国家全面建设小康社会的构想。3、拆迁出来的砖瓦已经无多大的作用，满足不了建新房的物质要求，属于资源的浪费，违背了国家建设资源节约型社会的意志。五、这些年来，党的政策越来越好，我毕业后也通过自己的辛勤努力工作，收入也一年比一年增加。通过这几年的的奋斗和不断积攒，已基本上攒够了建新房(建成砖混水泥房)的费用。只要上级一批准，我就能马上动工。六、我建房的方案是：在我家自留土地上建一栋____平方米的房子，这片土地从爷爷辈起就是我家的菜地，已经30年多年，并不会动用村里任何他人的共同土地或私有土地，也不影响他人的生活起居，绝不存在损害他人利益或违背他人利益的情况。希望领导批准建新房。特此申请，敬请审核批准。附：l．现住房照片2．生产小组的证明。此致敬礼!申请人：xxxxxxx年xx月xx日建房申请书书坊乡村建站：本人曾松华，是书坊乡书坊村第八村民小组小组农民。由于下列原因，我申请新建住房。我现住的房屋，还是1986年建的简陋木制瓦房，虽经过多次整修，但破损处仍然较多，现墙体出现裂缝。因而建新房非常有必要。我现居住的房屋一共3间，50多平方米，要住5人，还要堆放粮食等，显得十分拥挤。为了改善现有的住房状况，必须建新房。计划新建砖混水泥房，建房的方案是：拆除现有的住房，主要在老地基建新房，占地面积约60平方米。特此申请，敬请审核批准。此致敬礼!申请人：2013年月日篇四：农村个人建房申请农村个人建房申请尊敬的各位领导：本人是xx镇xx乡xx村村民xxx，19xx年x月x日出生，长年在外打工，在村里没有属于自己的房屋，现准备回村长期居住，故此申请在胡宅村新建住房，如能得到政府各级部门的批准，我将根据农村居民建房的有关规定，文明施工，安全施工，不影响周围邻居的工作和休息，对建筑材料不乱堆乱放，不阻碍交通与消防通道。特此申请，敬请审核批准申请人：xxx20xx年xx月xx日篇五：农村建房申请书建房申请书尊敬的领导：您好！本人系xxx村民。由于以下几点原因，我申请新建住房一栋。