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

1、For personal use only in study and research; not forcommercialuse薇节螃螁羆肂 xxxxx系统薀详细设计说明书衿莆文件状态：袅文件标蒃识：螃 草稿莀当前版芄 1.0薂 正式发布本：羇 正在修改蒁作者：蒈羄完成日蒂期：袀莇版本历史螄艿 版本 / 状态罿作者螇参与者蒅起止日期莁备注肇 1.0芆芅蒂蒀开始编写蚅羅腿薈肅蚆芁羀螈膂莂聿膇羂膀膇修改记录蚇蚃日期膁修订版蕿修改章肆修改描述蒃作者本节节蚈蒆膃肀羀衿袈肅肂薂薈肆膁羁莈袄薃莁聿羅蚁目录袀 1引言.错误！未定义书签。衿1.1编写目的 .错误！未定义书签。羆1.2背景.错误！未定义书签。

2、肄1.3参考资料 .错误！未定义书签。芀1.4术语定义及说明 .错误！未定义书签。薀 2设计概述 .错误！未定义书签。螄2.1任务和目标 .错误！未定义书签。膂 2.1.1需求概述 .错误！未定义书签。虿 2.1.2运行环境概述 .错误！未定义书签。肆 2.1.3条件与限制 .错误！未定义书签。袅 2.1.4详细设计方法和工具 .错误！未定义书签。芁 3系统详细需求分析 .错误！未定义书签。肈3.1详细需求分析 .错误！未定义书签。螆3.2详细系统运行环境及限制条件分析接口需求分析.错误！未定义书签。羆 4总体方案确认.错误！未定义书签。蚃4.1系统总体结构确认 .错误！未定义书签。螂4.2系

3、统详细界面划分 .错误！未定义书签。薇 4.2.1应用系统与支撑系统的详细界面划分.错误！未定义书签。螄 4.2.2系统内部详细界面划分 .错误！未定义书签。螁 5系统详细设计.错误！未定义书签。芁5.1系统程序代码架构设计 .错误！未定义书签。芇 5.1.1UI(User Interface)用户界面表示层 .错误！未定义书签。螅 5.1.2BLL(Business Logic Layer)业务逻辑层 .错误！未定义书签。膄 5.1.3DAL(Data Access Layer)数据访问层 .错误！未定义书签。蚀 5.1.4Common类库 .错误！未定义书签。肇 5.1.5Entity C

4、lass 实体类 .错误！未定义书签。袇5.2系统结构设计及子系统划分.错误！未定义书签。节5.3系统功能模块详细设计 .错误！未定义书签。肀 5.3.1XX子系统 .错误！未定义书签。螈 .1XX模块 .错误！未定义书签。蚄 列表和分页 .错误！未定义书签。薄 创建 XX.错误！未定义书签。葿 .2XX模块 .错误！未定义书签。蒈 XX列表 .错误！未定义书签。蚅 XX修改 .错误！未定义书签。螃 5.3.2XX子系统 .错误！未定义书签。罿用户管理模块 . .错误！未定义书签。艿角色管理模块 . .错误！未定义书签。螇系统设置模块 . .错误！未定义书签。袁系统登录注销模块 . .错误！未

5、定义书签。蚂5.4系统界面详细设计 .错误！未定义书签。罿 5.4.1外部界面设计 .错误！未定义书签。薄 5.4.2内部界面设计 .错误！未定义书签。膄 5.4.3用户界面设计 .错误！未定义书签。肁 6数据库系统设计 .错误！未定义书签。蝿6.1设计要求 .错误！未定义书签。薅6.2信息模型设计 .错误！未定义书签。莂6.3数据库设计 .错误！未定义书签。蒁 6.3.1设计依据 .错误！未定义书签。膆 6.3.2数据库种类及特点 .错误！未定义书签。蚇 6.3.3数据库逻辑结构 .错误！未定义书签。蚄 6.3.4物理结构设计 .错误！未定义书签。袀 6.3.5数据库安全 .错误！未定义书签

6、。羆 6.3.6数据字典 .错误！未定义书签。蒄 7信息编码设计.错误！未定义书签。螃7.1代码结构设计 .错误！未定义书签。荿7.2代码编制 .错误！未定义书签。12蚆引言2.12.2薆编写目的羁说明编写详细设计方案的主要目的。蝿说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）和数据库系统的设计考虑，为程序员编码提供依据。蒇如果一个软件系统比较简单，层次很少，本文件可以不单独编写，和概要设计说明书中不重复部分合并编写。薇方案重点是模块的执行流程和数据库系统详细设计的描述。2.32.4芃背景膈应包含以下几个方面的内容：膇 A. 待开发软件系统名称；莄 B. 该系统基本

7、概念，如该系统的类型、从属地位等；莂 C. 开发项目组名称。2.52.6袂参考资料羇列出详细设计报告引用的文献或资料，资料的作者、标题、出版单位和出版日期等信息，必要时说明如何得到这些资料。2.72.8蒆术语定义及说明螄列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文。34芁设计概述4.14.2蚈任务和目标芃说明详细设计的任务及详细设计所要达到的目标。4.2.14.2.2 袃 需求概述螀 对所开发软件的概要描述 , 包括主要的业务需求、输入、输出、主要功能、性能等，尤其需要描述系统性能需求 。4.2.34.2.4 蒈 运行环境概述芄对本系统所依赖于运行的硬件，包括操作系统、数据库

8、系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。4.2.54.2.6 羁 条件与限制膀详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。4.2.74.2.8 腿 详细设计方法和工具莆 简要说明详细设计所采用的方法和使用的工具。如HIPO图方法、 IDEF（I2DEF）方法、 ER图，数据流程图、业务流程图、选用的CASE工具等，尽量采用标准规范和辅助工具。56莃系统详细需求分析蕿主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。6.16.2

9、衿详细需求分析膃包括：蒂详细功能需求分析肈详细性能需求分析虿详细资源需求分析膅详细系统运行环境及限制条件分析6.36.4袄详细系统运行环境及限制条件分析接口需求分析蚂包括：膆系统接口需求分析芆现有硬、软件资源接口需求分析羂引进硬、软件资源接口需求分析78膁总体方案确认袆着重解决系统总体结构确认及界面划分问题。8.18.2肃系统总体结构确认肁对系统组成、逻辑结构及层次进行确认，对应用系统、支撑系统及各自实现的功能进行确认，细化集成设计及系统工作流程，特别要注意因软件的引进造成的系统本身结构和公司其他系统的结构变化。包括：薁系统组成、逻辑结构及层次确认蚆应用系统结构确认膅支撑系统结构确认蒃系统集成

10、确认羀系统工作流程确认莇8.38.4膆系统详细界面划分8.4.18.4.2 薂 应用系统与支撑系统的详细界面划分葿应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范围及访问方式，网络及数据库对应用系统的支撑方式，全局数据的管理与存取方式等。8.4.38.4.4 肇 系统内部详细界面划分羃系统各功能之间的界面包括覆盖范围，模块间功能调用涉及到的系统模块及方法，全局数据格式，系统性能要求等。910羄系统详细设计10.110.2 衿 系统程序代码架构设计袈系统采用三层架构模型，将应用系统划分为用户界面表示层、业务逻辑层、数据访问层，以及Entity Class实体类、 Common类库

11、组成，各层的关系如下图所示：肅10.2.110.2.2 肂 UI(User Interface)用户界面表示层薂负责与用户进行交互，显示、接受数据，与此同时，做一些简单逻辑处理，如：输入数据有效性判断、显示各种异常、处理Dataset 记录集数据。它只与BLL(Business Logic Layer)业务逻辑层、 Entity Class实体类两个项目发生关联，可能与Common类库发生关联。10.2.310.2.4 薈 BLL(Business Logic Layer)业务逻辑层肆是整个系统的核心，它承担了所有的逻辑判断，实现了程序的功能，它是灵活的。BLL层既是调用者，又是被调用者，因此

12、，要适当的进行设计达到解耦的效果。BLL层只关联 DAL层和实体类，可能关联 Common类库。虽然 BLL层被 U层调用，但是 BLL层无需关心 UI 层的情况。数据库中每个表都对应一个 BLL类，为了达到解耦效果， BLL类不能直接调用其他表的 DAL类，可以 BLL类之间相互调用。10.2.510.2.6 膁 DAL(Data Access Layer)数据访问层羁提供数据访问的接口，没有任何逻辑。在接口中对数据库操作语句进行组合装配。DAL层一般关联 Common类库中的最底层，最基础的数据库类（比如：链接数据库），必须关联Entity Class实体类项目。 DAL层只是数据库的管理

13、者，但不是访问者，不直接与数据库发生关联。数据库中每个表都对应一个 DAL层的接口 ( 访问控制 ) 类。10.2.710.2.8 莈 Common类库袄用于存放公用的类。最常用的就是数据库访问类，比如：链接字符串，数据库引擎类。它直接与数据库进行机械式的交换，无任何逻辑。10.2.910.2.10薃 Entity Class实体类莁相当于加强的数据结构，实现了对数据的封装。数据库中每个表都对应一个实体类，表的字段就是实体类的属性，类型一一对应。UI 、 BLL、 DAL这三层的交互主要就是通过实体类作为参数，并Return 回信息。10.310.4 聿 系统结构设计及子系统划分羅根据业务和功

14、能，将系统的逻辑结构划分为XX子系统、 XX子系等 6个子系统，如下图所示：蚁袀 XXXXXXXX系统肄 XX管理衿XX管理芁 XX肆XX薀XX膂 XX螆各个子系统按照功能角度分解，划分出若干不同的功能模块，如下面各图所示：羆蚃螂薇螄10.510.6 螁 系统功能模块详细设计芁按结构化设计方法，在系统功能逐层分解的基础上，对系统各功能模块或子系统进行设计。此为详细设计的主要部分之一。芇用层次图描述系统的总体结构、功能分解及各个模块之间的相互调用关系和信息交互，用IPO图或其他方法描述各模块完成的功能。 以上建议采用 HIPO图进行功能分解与模块描述，更高的要求建议采用 IDEF0方法进行功能模

15、型设计。螅 详细设计应用系统的各个构成模块完成的功能及其相互之间的关系， 用IPO或结构图描述各模块的组成结构、算法、模块间的接口关系，以及需求、功能和模块三者之间的交叉参照关系。膄每个模块的描述说明可参照以下格式：蚀模块编号：肇模块名称：袇输入：节处理：肀算法描述：螈输出：蚄其中处理和算法描述部分主要采用伪码或具体的程序语言完成。薄 对详细设计更高的要求建议用 IDEF0图进行各功能模块的设计。葿如果对软件需进行二次开发（包括功能扩展、功能改造、用户界面改造等），则相应的设计工作应该设立子课题完成。蒈蚅注意： 算法描述主要是说明BLL层的代码逻辑，UI层只做简单的输入验证和界面显示功能。螃1

16、0.6.110.6.2 罿 XX子系统.1.2艿XX模块螇列表和分页袁创建 XX.3.4蚂XX模块罿 XX列表薄 XX修改10.6.310.6.4 膄 XX子系统5.3.6.15.3.6.2肁用户管理模块蝿模块描述：管理系统用户，包括添加用户并赋予角色、修改用户资料和角色、删除用户。薅主要功能：添加用户、修改用户、删除用户、列表和分页。5.3.6.1.15.3.6.1.2莂列表和分页1、2、 蒁流程图膆省略3、4、 蚇输入项蚄分页索引页面传参数页面加载时为 15、6、 袀输出项1)2)羆列表详细记录；3)4)蒄当前页码；5)6)螃分页总数；7)8)荿记录总数。7、8、 蚆算法描述薆系统管理用户

17、数据量不大，而且该功能使用频率不高，可以不用优化分页，直接获取用户表全部记录， 建议 UI 层使用 gridview 控件， 调用 GetAllList() 绑定控件， 利用 gridview 自带分页功能，显示分页按钮、当前页、分页总数、记录总数、5.3.6.1.35.3.6.1.4羁添加用户1、2、 蝿流程图薇输入用户资料羁袃膀螀腿蒈芁循环字符串数组蒇3、4、 莃输入项蕿用户 IDstring必填衿姓名string必填膃用户密码string必填蒂确认密码string必填肈联系电话string虿E-mailstring膅状态char袄用户角色 IDstring5、6、 蚂输出项1)2)膆 成

18、功， UI 提示添加用户完成；3)4)芆 失败， UI 提示具体信息。7、8、 羂算法描述1)2)膁 前端 js 判断必填项的输入和二次密码是否相同，角色可以不选；3)4)袆 BLL须验证必填项，用户名是唯一的不能重复；5)6)加密密码使用MD5.Encrypt( string String,string；肃Key) ， Key = "XXXXXXXX"7)8)肁 用户信息保存至表 System_admin_info， Add(model) ；9)10)薁 分拆角色 ID 字符串并循环字符串数组，信息保存至表 Dict_admin_vs_roles，Add( model)

19、。5.3.6.1.55.3.6.1.6蚆修改用户1、2、 膅流程图羀输入用户资料肆肂膁薂羁 根据用户 ID 删除表薃袄衿循环字符串数组蒃3、4、 聿输入项羅用户 IDstring页面传参数蚁姓名string必填袀用户密码string必填衿确认密码string必填羆联系电话string肄E-mailstring芀状态char薀用户角色 IDstring5、6、 螄输出项1)2)膂 成功， UI 提示修改用户完成；3)4)虿 失败， UI 提示具体信息。7、8、 肆算法描述1)2)袅 前端 js 判断必填项的输入和二次密码是否相同，角色可以不选；3)4)芁 加密密码使用 Encrypt( stri

20、ng String,string Key) ，Key = "LinLiYan"；5)6)肈 根据用户 ID 删除表 Dict_admin_vs_roles的记录 DeleteByAdminID( string admin_id)；7)8)螀 分拆角色 ID 字符串并循环字符串数组，信息保存至该表Add( model)。5.3.6.1.75.3.6.1.8袀删除用户1、2、 薇流程图列表中点击删除按钮根据用户 ID 删除表System_admin_info 记录否是否成功是根据用户 ID删除表Dict_admin_vs_roles记录返回失败信息否是否成功是操作记录日志返回成

21、功信息螅3、 输入项用户 IDstring页面传参数4、 输出项1、 成功， UI 提示删除用户完成，刷新列表；2、 失败， UI 提示具体信息。3、 算法描述1)根据用户 ID 删除表 System_admin_info的记录 Delete( string admin_id)；2)根据用户 ID 删除表 Dict_admin_vs_roles的记录 DeleteByAdminID( stringadmin_id) 。5.3.6.3角色管理模块5.3.6.4系统设置模块5.3.6.5系统登录注销模块10.7 系统界面详细设计系统界面说明应用系统软件的各种接口。 整个系统的其他接口（如系统硬件接口、通讯接口等）在相应的部分说明。10.7.1 外部界面设计根据系统界面划分进行系统外部界面设计，对系统的所有外部接口（包括功能和数据接口）进行设计。10.7.2 内部界面设计设计系统内部各功能模块间的调用关系和数据接口。10.7.3 用户界面设计规定人机界面的内容、界面风格、调用方式等，包括所谓的表单设计、报表设计和用户需要的打