软件系统设计说明书模板

xxxxx系统具体设计说明书文件状态：文件状态：文件标识：[√]草稿当前版本：1.0[]正式公布作者：[]正在修改完成日期：版本/状态版本/状态作者参与者起止日期备注1.0开头编写日期日期本修改章节修改描述作者名目\l“_TOC_250051“引言 5\l“_TOC_250050“编写目的 5\l“_TOC_250049“背景 5\l“_TOC_250048“参考资料 5\l“_TOC_250047“术语定义及说明 5\l“_TOC_250046“设计概述 5\l“_TOC_250045“任务和目标 5\l“_TOC_250044“需求概述 5\l“_TOC_250043“运行环境概述 5\l“_TOC_250042“条件与限制 6\l“_TOC_250041“具体设计方法和工具 6\l“_TOC_250040“系统具体需求分析 6\l“_TOC_250039“具体需求分析 6\l“_TOC_250038“具体系统运行环境及限制条件分析接口需求分析 6\l“_TOC_250037“总体方案确认 6\l“_TOC_250036“系统总体构造确认 6\l“_TOC_250035“系统具体界面划分 7\l“_TOC_250034“应用系统与支撑系统的具体界面划分 7\l“_TOC_250033“系统内部具体界面划分 7\l“_TOC_250032“系统具体设计 7\l“_TOC_250031“系统程序代码架构设计 7\l“_TOC_250030“UI(UserInterface)用户界面表示层 7\l“_TOC_250029“BLL(BusinessLogicLayer)业务规律层 8\l“_TOC_250028“DAL(DataAccessLayer)数据访问层 8\l“_TOC_250027“Common类库 8\l“_TOC_250026“EntityClass实体类 8\l“_TOC_250025“系统构造设计及子系统划分 8\l“_TOC_250024“系统功能模块具体设计 9\l“_TOC_250023“XX子系统 9XX模块 9列表和分页 9创立XX 9\l“_TOC_250022“XX模块 9XX列表 9XX修改 9\l“_TOC_250021“XX子系统 9\l“_TOC_250020“用户治理模块 9\l“_TOC_250019“角色治理模块 14\l“_TOC_250018“系统设置模块 14\l“_TOC_250017“系统登录注销模块 14\l“_TOC_250016“系统界面具体设计 14\l“_TOC_250015“外部界面设计 14\l“_TOC_250014“内部界面设计 14\l“_TOC_250013“用户界面设计 14\l“_TOC_250012“数据库系统设计 14\l“_TOC_250011“设计要求 14\l“_TOC_250010“信息模型设计 14\l“_TOC_250009“数据库设计 14\l“_TOC_250008“设计依据 14\l“_TOC_250007“数据库种类及特点 15\l“_TOC_250006“数据库规律构造 15\l“_TOC_250005“物理构造设计 15\l“_TOC_250004“数据库安全 15\l“_TOC_250003“数据字典 15\l“_TOC_250002“信息编码设计 15\l“_TOC_250001“代码构造设计 15\l“_TOC_250000“代码编制 15引言编写目的说明编写具体设计方案的主要目的。说明书编制的目的是说明一个软件系统各个层次中的每个程序〔每个模块或子程序〕和数据库系统的设计考虑，为程序员编码供给依据。假设一个软件系统比较简洁，层次很少，本文件可以不单独编写，和概要设计说明书中不重复局部合并编写。方案重点是模块的执行流程和数据库系统具体设计的描述。背景应包含以下几个方面的内容：待开发软件系统名称；该系统根本概念，如该系统的类型、附属地位等；开发工程组名称。参考资料列出具体设计报告引用的文献或资料，资料的作者、标题、出版单位和出版日期等信息，必要时说明如何得到这些资料。术语定义及说明列出本文档中用到的可能会引起混淆的特地术语、定义和缩写词的原文。设计概述任务和目标说明具体设计的任务及具体设计所要到达的目需求概述需要描述系统性能需。运行环境概述对本系统所依靠于运行的硬件，包括操作系统、数据库系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。条件与限制具体描述系统所受的内部和外部条件的约束和限制说以及进度、治理等方面的限制。具体设计方法和工具IPOIDEF〔I2DEF〕E－R图，数据流程图、业务流程图、选用CASE工具等，尽量承受标准标准和关心工具。系统具体需求分析主要对系统级的需求进展分析。首先应对需求分析提出的企业需求进一步确认，并对由于状况变化而带来的需求变化进展较为具体的分析。具体需求分析包括：具体功能需求分析具体性能需求分析具体资源需求分析具体系统运行环境及限制条件分析具体系统运行环境及限制条件分析接口需求分析包括：系统接口需求分析现有硬、软件资源接口需求分析引进硬、软件资源接口需求分析总体方案确认着重解决系统总体构造确认及界面划分问题。系统总体构造确认对系统组成细化集成设计及系统工作流程，特别要留意因软件的引进造成的系统本身构造和公司其他系统的构造变化。包括：系统组成、规律构造及层次确认应用系统构造确认支撑系统构造确认系统集成确认系统工作流程确认系统具体界面划分应用系统与支撑系统的具体界面划分应用系统与支撑系统之间的界面包括系统主效劳器与其他效劳器的效劳范围及访问方式，网络及数据库对应用系统的支撑方式，全局数据的治理与存取方式等。系统内部具体界面划分系统各功能之间的界面包括掩盖范围，模块间功能调用涉及到的系统模块及方法，全局数据格式，系统性能要求等。系统具体设计系统程序代码架构设计系统承受三层架构模型，将应用系统划分为用户界面表示层、业务规律层、数据访问层，以及EntityClass实体类、Common类库组成，各层的关系如以下图所示：UI(UserInterface)用户界面表示层负责与用户进展交互，显示、承受数据，与此同时，做一些简洁规律处理，如：输入数据有效DatasetBLL(BusinessLogicLayer)业务规律层、EntityClass实体类两个工程发生关联，可能与Common类库发生关联。BLL(BusinessLogicLayer)是整个系统的核心，它担当了全部的规律推断，实现了程序的功能，它是敏捷的。BLL层既是调用者，又是被调用者，因此，要适当的进展设计到达解耦的效果。BLL层只关联DAL能关联Common类库。虽然BLL层被U层调用，但是BLL层无需关心UI层的状况。数据库中每个表都对应一个BLLBLL类不能直接调用其他表的DALBLL类之间相互调用。DAL(DataAccessLayer)供给数据访问的接口，没有任何规律。在接口中对数据库操作语句进展组合装配。DAL层一般关联Common类库中的最底层，最根底的数据库类〔比方：链接数据库〕，必需关联EntityClass实体类工程。DAL层只是数据库的治理者，但不是访问者，不直接与数据库发生关联。数据库中每个表都对应一个DAL层的接口(访问掌握)类。Common类库用于存放公用的类。最常用的就是数据库访问类，比方：链接字符串，数据库引擎类。它直接与数据库进展机械式的交换，无任何规律。EntityClass实体类相当于加强的数据构造，实现了对数据的封装。数据库中每个表都对应一个实体类，表的字段就是实体类的属性，类型一一对应。UI、BLL、DAL这三层的交互主要就是通过实体类作为参数，并Return回信息。系统构造设计及子系统划分依据业务和功能，将系统的规律构造划分为XX子系统、XX子系等6个子系统，如以下图所示：XXXXXXXX系统XXXXXXXX系统XX治理子系统XX治理子系统XX子系统XX子系统XX子系统XX子系统各个子系统依据功能角度分解，划分出假设干不同的功能模块，如下面各图所示：系统功能模块具体设计按构造化设计方法，在系统功能逐层分解的根底上，对系统各功能模块或子系统进展设计。此为具体设计的主要局部之一。IPOHIPO图进展功能分解与模块描述，更高的要IDEF0方法进展功能模型设计。具体设计应用系统的各个构成模块完成的功能及其相互之间的关系I或构造图描述各模块的组成构造、算法、模块间的接口关系，以及需求、功能和模块三者之间的穿插参照关系。每个模块的描述说明可参照以下格式：模块编号：模块名称：输入：处理：算法描述：输出：其中处理和算法描述局部主要承受伪码或具体的程序语言完成。对具体设计更高的要求建议IDEF0图进展各功能模块的设计。假设对软件需进展二次开发〔包括功能扩展、功能改造、用户界面改造等〕，则相应的设计工作应当设立子课题完成。留意：算法描述主要是说明BLL层的代码规律，UI层只做简洁的输入验证和界面显示功能。XX子系统列表和分页创立XXXX模块XX列表XX修改XX子系统用户治理模块模块描述：治理系统用户，包括添加用户并赐予角色、修改用户资料和角色、删除用户。主要功能：添加用户、修改用户、删除用户、列表和分页。列表和分页1省略2分页索引3

页面传参数 页面加载时为1列表具体记录；当前页码；分页总数；记录总数。4系统治理用户数据量不大，而且该功能使用频率不高，可以不用优化分页，直接猎取用户表全部记录，建议UI层使用gridview控件，调用ExamSys.BLL.System_admin_infoGetAllList绑定控件，利用gridview自带分页功能，显示分页按钮、当前页、分页总数、记录总数、添加用户1选择角色验证必填项否填写合规是验证用户名是是否存在否加密密码用户信息保存至表System_admin_info否返回失败信息是否成功是分拆角色ID字符串循环字符串数组返回成功信息操作记录日志2用户IDstring必填姓名string必填用户密码string必填确认密码string必填联系stringE-mailstring状态char用户角色IDstring3成功，UI提示添加用户完成；失败，UI提示具体信息。4前端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)。修改用户1选择角色验证必填项否填写合规是加密密码用户信息保存至表System_admin_info否 是否成功是依据用户ID删除表Dict_admin_vs_roles记录否返回失败信息是否成功是分拆角色ID字符串循环字符串数组返回成功信息操作记录日志2用户IDstring页面传参数姓名string必填用户密码string必填确认密码string必填联系E-mail状态用户角色ID3

stringstringcharstring成功，UI提示修改用户完成；失败，UI提示具体信息。4前端js推断必填项的输入和二次密码是否一样，角色可以不选；加密密码使用Chukeh.Security.MD5.Encrypt(stringString,stringKey)，Key=“LinLiYan“；IDDict_admin_vs_rolesExamSys.BLL.Dict_admin_vs_rolesDeleteByAdminID(stringadmin_id)；ID字符串并循环字符串数组，信息保存至该表ExamSys.BLL.Dict_admin_vs_rolesAdd(ExamSys.Model.Dict_admin_vs_rolesmodel)。删除用户1列表中列表中依据用户ID删除表System_admin_info记录否 是否成功是依据用户ID删除表Dict_admin_vs_roles记录否返回失败信息是否成功是操作记录日志返回成功信息2用户ID string 页面传参数3、输出项1UI提示删除用户完成，刷列表；2UI提示具体信息。3ID删除表System_admin_info的记录ExamSys.DAL.System_admin_infoDelete(stringadmin_id)；IDDict_admin_vs_rolesExamSys.BLL.Dict_admin_vs_rolesDeleteByAdminID(stringadmin_id)。角色治理模块系统设置模块系统登录注销模块系统界面具体设计〔如系统硬件接口〕在相应的局部说明。外部界面设计依据系统界面划分进展系统外部界面设计，对系统的全部外部接口〔包括功能和数据接口〕进展设计。内部界面设计设计系统内部各功能模块间的调用关系和数据接口。