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

1、Forpersonaluseonlyinstudyandresearch;notforc0mmercialuse薇节螃腿噩建xxxxx系统期详细设计说明书衿莆文件状态：袅文件标蒙识:螃，草稿蔽正式发布赣止在修改原当前版本：先1.0蓬作者：曹肄完成日期：市苗版本历史蛔芳版本/状态量作者蟆参与者案起止日期筮备注肇1.0芨耳市盆开始编写蛔月退蜗-+-几蜘膂前聿腿n膀腿修改记录蜗童日期赚修订版本德修改章节肆修改描述募作者节妍要膈聿衿袈建蔽肆羁芨袄蒲筮聿蚀5.1.4Common库 错误！未定义书签。目录神1弓I百错误！未定义书签。衿1.1编写目的错误！未定义书签。熊1.2背景错误！未定义书签。肄1.3参

2、考资料错误！未定义书签。方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系统详细界面划分错误！未定义书签。薇4.2.1应用系统与支撑系统的详细界面

3、划分错误！未定义书签。端4.2.2系统内部详细界面划分错误！未定义书签。腿5系统详细设计错误！未定义书签。范5.1系统程序代码架构设计错误！未定义书签。芾5.1.1UI(UserInterface)用户界面表示层错误！未定义书签。嵋5.1.2BLL(BusinessLogicLayer)业务逻辑层错误！未定义书签。月15.1.3DAL(DataAccessLayer)数据访问层错误！未定义书签。肇5.1.5EntityClass实体类错误！未定义书签。W5.2系统结构设计及子系统划分错误！未定义书签。节5.3系统功能模块详细设计错误！未定义书签。聿5.3.1XXF系统错误！未定义书签。蝌1XX

4、块错误！未定义书签。蚄列表和分页错误！未定义书签。薄创建XX错误！未定义书签。菌.2XXB块错误！未定义书签。曹X*U表错误！未定义书签。蛔XX啰改错误！未定义书签。螃5.3.2XXF系统错误！未定义书签。量用户管理模块错误！未定义书签。艿角色管理模块错误！未定义书签。蟆系统设置模块错误！未定义书签。袁系统登录注销模块错误！未定义书签。蚂5.4系统界面详细设计错误！未定义书签。量5.4.1外部界面设计错误！未定义书签。薄5.4.2内部界面设计错误！未定义书签。艘5.4.3用户界面设计错误！未定义书签。犀6数据库系统设计错误！未定义书签。蝇6.1设计要求错误！未定义书签。薅6.2信息模型设计错误

5、！未定义书签。前6.3数据库设计错误！未定义书签。蓬6.3.1设计依据错误！未定义书签。滕6.3.2数据库种类及特点错误！未定义书签。蚁6.3.3数据库逻辑结构错误！未定义书签。妨6.3.4物理结构设计错误！未定义书签。未勺6.3.5数据库安全错误！未定义书签。噩6.3.6数据字典错误！未定义书签。蔻7信息编码设计错误！未定义书签。螃7.1代码结构设计错误！未定义书签。箴7.2代码编制错误！未定义书签。12 期引百2.12.2 菱编写目的羁说明编写详细设计方案的主要目的。蝇说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）和数据库系统的设计考虑，为程序员编码提供依据。藏

6、如果一个软件系统比较简单，层次很少，本文件可以不单独编写，和概要设计说明书中不重复部分合并编写。薇方案重点是模块的执行流程和数据库系统详细设计的描述。2.32.4 荒背景膈应包含以下几个方面的内容：胭A.待开发软件系统名称；童B.该系统基本概念，如该系统的类型、从属地位等；前C.开发项目组名称2.52.6 袂参考资料赣列出详细设计报告引用的文献或资料，资料的作者、标题、出版单位和出版日期等信息，必要时说明如何得到这些资料。2.72.8 荽术语定义及说明蝴列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文。34 尢设计概述4.14.2 妍任务和目标芃说明详细设计的任务及详细设计所要达

7、到的目标。4.2.14.2.2 亵需求概述蜜对所开发软件的概要描述，包括主要的业务需求、输入、输出、主要功能、性能等，尤其需要描述系统性能需求。4.2.34.2.4 蒈运行环境概述芄对本系统所依赖于运行的硬件，包括操作系统、数据库系统、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。4.2.54.2.6 羁条件与限制膀详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。4.2.74.2.8 腿详细设计方法和工具莆简要说明详细设计所采用的方法和使用的工具。如HIPC方法、IDEF(I2DEF)方法、E幽，数据流程图、业务

8、流程图、选用的CASE：具等，尽量采用标准规范和辅助工具。56蒂系统详细需求分析覆主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。6.16.2 衿详细需求分析膈包括： 蒂详细功能需求分析 肇详细性能需求分析 蚕详细资源需求分析,瞧详细系统运行环境及限制条件分析6.36.4 袄详细系统运行环境及限制条件分析接口需求分析蚂包括：滕系统接口需求分析黄现有硬、软件资源接口需求分析辐引进硬、软件资源接口需求分析8 赚总体方案确认祎着重解决系统总体结构确认及界面划分问题。8.18.2 肃系统总体结构确认康对系统组成、逻辑结构及层次进

9、行确认，对应用系统、支撑系统及各自实现的功能进行确认，细化集成设计及系统工作流程，特别要注意因软件的引进造成的系统本身结构和公司其他系统的结构变化。包括：英系统组成、逻辑结构及层次确认期应用系统结构确认脑支撑系统结构确认蒙系统集成确认辑系统工作流程确认8.38.4 滕系统详细界面划分8.4.18.4.2 蕨应用系统与支撑系统的详细界面划分盾应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范围及访问方式，网络及数据库对应用系统的支撑方式，全局数据的管理与存取方式等。8.4.38.4.4 肇系统内部详细界面划分籍系统各功能之间的界面包括覆盖范围，模块间功能调用涉及到的系统模块及方法，

10、全局数据格式，系统性能要求等。910箍系统详细设计10.110.2衿系统程序代码架构设计袈系统采用三层架构模型，将应用系统划分为用户界面表示层、业务逻辑层、数据访问层，以及EntityClass实体类、Common库组成，各层的关系如下图所示：10.2.110.2.2 建UI(UserInterface)用户界面表示层蔽负责与用户进行交互，显示、接受数据，与此同时，做一些简单逻辑处理，如：输入数据有效性判断、显示各种异常、处理Dataset记录集数据。它只与BLL(BusinessLogicLayer)业务逻辑层、EntityClass实体类两个项目发生关联，可能与Common库发生关联。10

11、.2.310.2.4 菅BLL(BusinessLogicLayer)业务逻辑层肆是整个系统的核心，它承担了所有的逻辑判断，实现了程序的功能，它是灵活的。BLL层既是调用者，又是被调用者，因此，要适当的进行设计达到解耦的效果。BLLM只关联DALM和实体类，可能关联Common1库。虽然BLLM被U层调用，但是BLL层无需关心UI层的情况。数据库中每个表都对应一个BLL类，为了达到解耦效果，BLL类不能直接调用其他表的DAia,可以BL块之间相互调用。10.2.510.2.6 赚DAL(DataAccessLayer)数据访问层羁提供数据访问的接口，没有任何逻辑。在接口中对数据库操作语句进行组

12、合装配。DALB一般关联Common库中的最底层，最基础的数据库类(比如：链接数据库)，必须关联EntityClass实体类项目。DALB只是数据库的管理者，但不是访问者，不直接与数据库发生关联。数据库中每个表都对应一个DALM的接口(访问控制)类。10.2.710.2.8 裴Common库袄用于存放公用的类。最常用的就是数据库访问类，比如：链接字符串，数据库引擎类。它直接与数据库进行机械式的交换，无任何逻辑。10.2.910.2.10 WEntityClass实体类筮相当于加强的数据结构，实现了对数据的封装。数据库中每个表都对应一个实体类，表的字段就是实体类的属性，类型一一对应。UI、BLL

13、、DAE三层的交互主要就是通过实体类作为参数,并Return回信息。10.310.4 聿系统结构设计及子系统划分箍根据业务和功能，将系统的逻辑结构划分为XX?系统、XXF系等6个子系统，如下图所示:蟆各个子系统按照功能角度分解，划分出若干不同的功能模块，如下面各图所示:噩蜜螂薇10.510.6 腿系统功能模块详细设计范按结构化设计方法，在系统功能逐层分解的基础上，对系统各功能模块或子系统进行设计。此为详细设计的主要部分之一。芾用层次图描述系统的总体结构、功能分解及各个模块之间的相互调用关系和信息交互，用IPO图或其他方法描述各模块完成的功能。以上建议采用HIPCS进行功能分解与模块描述，更高的

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

15、验证和界面显示功能。螃10.6.110.6.2 量XXf系统.1.2芳XXg块蟆列表和分页袁创建XX.3.4蚂XXg块量X*U表薄XX啰改10.6.310.6.4 月nXXf系统5.3.6.15.3.6.2 犀用户管理模块蝇模块描述：管理系统用户，包括添加用户并赋予角色、修改用户资料和角色、删除用户。薅主要功能：添加用户、修改用户、删除用户、列表和分页。5.3.6.1.15.3.6.3 .2前列表和分页1、2、蓬流程图滕省略3、4、蚁输入项蚄分页索引页面传参数页面加载时为15、6、木勺输出项1)2)噩列表详细记录；3)4) 蒄当前页码；5)6) 螃分页总数；7)8)箴记录总数。8)9) 蚆算法

16、描述菱系统管理用户数据量不大，而且该功能使用频率不高，可以不用优化分页，直接获取用户表全部记录，建议UI层使用gridview控件，调用GetAllList()绑定控件，禾U用gridview自带分页功能,显示分页按钮、当前页、分页总数、记录总数、5.3.6.1.35.3.6.1.4羁添加用户1、2、蝇流程图3、4、蒂输入项覆用户IDstring必填衿姓名string必填膈用户密码string必填肇联系电话string蚕E-mailstring脑状态char袄用户角色IDstring5、6、 蚂输出项1)2)滕成功，UI提示添加用户完成；3)4)黄失败，UI提示具体信息。7、8、精算法描述1)

17、2)赚前端js判断必填项的输入和二次密码是否相同，角色可以不选；3)4)未811验证必填项，用户名是唯一的不能重复；5)6) 肃加密密码使用MD5.Encrypt(stringString,stringKey)，Key=XXXXXXXX；7)8)犀用户信息保存至表System_admin_info,Add(model)；9)10)莫分拆角色ID字符串并循环字符串数组，信息保存至表Dict_admin_vs_roles,Add(model)。5.3.6.1.55.3.6.1.6 蚆修改用户1、2、瞧流程图3、4、聿输入项箍用户IDstring页面传参数蚁姓名string必填何用户密码string

18、必填衿确认密码string必填黑联系电话stringstring肄E-mail方状态char薄用户角色IDstring5、6、蝴输出项1)2)膂成功，UI提示修改用户完成；3、4)蚕失败，UI提示具体信息。7、8、 肆算法描述1)2) 袅前端js判断必填项的输入和二次密码是否相同，角色可以不选；3)4)范加密密码使用Encrypt(stringString,stringKey),Key=LinLiYan；5)6) 肇根据用户ID删除表Dict_admin_vs_roles的记录DeleteByAdminID(stringadmin_id)；7)8)蜜分拆角色ID字符串并循环字符串数组，信息保存

19、至该表Add(model)。5.3.6.1.75.3.6.1.8 就删除用户1、2、 薇流程图嵋3、输入项用户IDstring页面传参数4、输出项1、成功，UI提示删除用户完成，刷新列表；2、失败，UI提示具体信息。3、算法描述1）根据用户ID删除表System_admin_info的记录Delete（stringadmin_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 用户界面设计规定人机界面的内容、界面风格、调用方式等，包括所谓的表单设计、报表设计和用户需要的打印输出等设计。此部分内容可能比较多。11 数据库系统设计此数据库设计可单独成册，尤其对大型的数据库应用系统，即有一个单独的