软件系统详细设计说明书模板软件系统说明书模板样本Word文档下载推荐.docx

软件系统详细设计说明书模板软件系统说明书模板样本Word文档下载推荐.docx

《软件系统详细设计说明书模板软件系统说明书模板样本Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《软件系统详细设计说明书模板软件系统说明书模板样本Word文档下载推荐.docx（13页珍藏版）》请在冰豆网上搜索。

开始编写

修改记录

日期

修订版本

修改章节

修改描述

1引言

1.1编写目

阐明编写详细设计方案重要目。

阐明书编制目是阐明一种软件系统各个层次中每个程序（每个模块或子程序）和数据库系统设计考虑，为程序员编码提供根据。

如果一种软件系统比较简朴，层次很少，本文献可以不单独编写，和概要设计阐明书中不重复某些合并编写。

方案重点是模块执行流程和数据库系统详细设计描述。

1.2背景

应包括如下几种方面内容：

A.待开发软件系统名称；

B.该系统基本概念，如该系统类型、从属地位等；

C.开发项目组名称。

1.3参照资料

列出详细设计报告引用文献或资料，资料作者、标题、出版单位和出版日期等信息，必要时阐明如何得到这些资料。

1.4术语定义及阐明

列出本文档中用到也许会引起混淆专门术语、定义和缩写词原文。

2设计概述

2.1任务和目的

阐明详细设计任务及详细设计所要达到目的。

2.1.1需求概述

对所开发软件概要描述，涉及重要业务需求、输入、输出、重要功能、性能等，特别需要描述系统性能需求。

2.1.2运营环境概述

对本系统所依赖于运营硬件，涉及操作系统、数据库系统、中间件、接口软件、也许性能监控与分析等软件环境描述，及配备规定。

2.1.3条件与限制

详细描述系统所受内部和外部条件约束和限制阐明。

涉及业务和技术方面条件与限制以及进度、管理等方面限制。

2.1.4详细设计办法和工具

简要阐明详细设计所采用办法和使用工具。

如HIPO图办法、IDEF（I2DEF）办法、E－R图，数据流程图、业务流程图、选用CASE工具等，尽量采用原则规范和辅助工具。

3系统详细需求分析

重要对系统级需求进行分析。

一方面应对需求分析提出公司需求进一步确认，并对由于状况变化而带来需求变化进行较为详细分析。

3.1详细需求分析

涉及：

∙详细功能需求分析

∙详细性能需求分析

∙详细资源需求分析

∙详细系统运营环境及限制条件分析

3.2详细系统运营环境及限制条件分析接口需求分析

∙系统接口需求分析

∙既有硬、软件资源接口需求分析

∙引进硬、软件资源接口需求分析

4总体方案确认

着重解决系统总体构造确认及界面划分问题。

4.1系统总体构造确认

对系统构成、逻辑构造及层次进行确认，相应用系统、支撑系统及各自实现功能进行确认，细化集成设计及系统工作流程，特别要注意因软件引进导致系统自身构造和公司其她系统构造变化。

•系统构成、逻辑构造及层次确认

•应用系统构造确认

•支撑系统构造确认

•系统集成确认

•系统工作流程确认

4.2系统详细界面划分

4.2.1应用系统与支撑系统详细界面划分

应用系统与支撑系统之间界面涉及系统主服务器与其她服务器服务范畴及访问方式，网络及数据库相应用系统支撑方式，全局数据管理与存取方式等。

4.2.2系统内部详细界面划分

系统各功能之间界面涉及覆盖范畴，模块间功能调用涉及到系统模块及办法，全局数据格式，系统性能规定等。

5系统详细设计

5.1系统程序代码架构设计

系统采用三层架构模型，将应用系统划分为顾客界面表达层、业务逻辑层、数据访问层，以及EntityClass实体类、Common类库构成，各层关系如下图所示：

5.1.1UI（UserInterface）顾客界面表达层

负责与顾客进行交互，显示、接受数据，与此同步，做某些简朴逻辑解决，如：

输入数据有效性判断、显示各种异常、解决Dataset记录集数据。

它只与BLL（BusinessLogicLayer）业务逻辑层、EntityClass实体类两个项目发生关联，也许与Common类库发生关联。

5.1.2BLL（BusinessLogicLayer）业务逻辑层

是整个系统核心，它承担了所有逻辑判断，实现了程序功能，它是灵活。

BLL层既是调用者，又是被调用者，因而，要恰当进行设计达到解耦效果。

BLL层只关联DAL层和实体类，也许关联Common类库。

虽然BLL层被U层调用，但是BLL层无需关怀UI层状况。

数据库中每个表都相应一种BLL类，为了达到解耦效果，BLL类不能直接调用其她表DAL类，可以BLL类之间互相调用。

5.1.3DAL（DataAccessLayer）数据访问层

提供数据访问接口，没有任何逻辑。

在接口中对数据库操作语句进行组合装配。

DAL层普通关联Common类库中最底层，最基本数据库类（例如：

链接数据库），必要关联EntityClass实体类项目。

DAL层只是数据库管理者，但不是访问者，不直接与数据库发生关联。

数据库中每个表都相应一种DAL层接口（访问控制）类。

5.1.4Common类库

用于存储公用类。

最惯用就是数据库访问类，例如：

链接字符串，数据库引擎类。

它直接与数据库进行机械式互换，无任何逻辑。

5.1.5EntityClass实体类

相称于加强数据构造，实现了对数据封装。

数据库中每个表都相应一种实体类，表字段就是实体类属性，类型一一相应。

UI、BLL、DAL这三层交互重要就是通过实体类作为参数，并Return回信息。

5.2系统构造设计及子系统划分

依照业务和功能，将系统逻辑构造划分为XX子系统、XX子系等6个子系统，如下图所示：

各个子系统按照功能角度分解，划分出若干不同功能模块，如下面各图所示：

5.3系统功能模块详细设计

按构造化设计办法，在系统功能逐级分解基本上，对系统各功能模块或子系统进行设计。

此为详细设计重要某些之一。

用层次图描述系统总体构造、功能分解及各个模块之间互相调用关系和信息交互，用IPO图或其她办法描述各模块完毕功能。

以上建议采用HIPO图进行功能分解与模块描述，更高规定建议采用IDEF0办法进行功能模型设计。

详细设计应用系统各个构成模块完毕功能及其互相之间关系，用IPO或构造图描述各模块构成构造、算法、模块间接口关系，以及需求、功能和模块三者之间交叉参照关系。

每个模块描述阐明可参照如下格式：

模块编号：

模块名称：

输入：

解决：

算法描述：

输出：

其中解决和算法描述某些重要采用伪码或详细程序语言完毕。

对详细设计更高规定建议用IDEF0图进行各功能模块设计。

如果对软件需进行二次开发（涉及功能扩展、功能改造、顾客界面改造等），则相应设计工作应当设立子课题完毕。

注意：

算法描述重要是阐明BLL层代码逻辑，UI层只做简朴输入验证和界面显示功能。

5.3.1XX子系统

.1XX模块

列表和分页

创立XX

.2XX模块

XX列表

XX修改

5.3.2XX子系统

5.3.6.1顾客管理模块

模块描述：

管理系统顾客，涉及添加顾客并赋予角色、修改顾客资料和角色、删除顾客。

重要功能：

添加顾客、修改顾客、删除顾客、列表和分页。

5.3.6.1.1列表和分页

1、流程图

省略

2、输入项

分页索引页面传参数页面加载时为1

3、输出项

1）列表详细记录；

2）当前页码；

3）分页总数；

4）记录总数。

4、算法描述

系统管理顾客数据量不大，并且该功能使用频率不高，可以不用优化分页，直接获取顾客表所有记录，建议UI层使用gridview控件，调用ExamSys.BLL.System_admin_infoGetAllList（）绑定控件，运用gridview自带分页功能，显示分页按钮、当前页、分页总数、记录总数、

5.3.6.1.2添加顾客

顾客IDstring必填

姓名string必填

顾客密码string必填

确认密码string必填

联系电话string

E-mailstring

状态char

顾客角色IDstring

1）成功，UI提示添加顾客完毕；

2）失败，UI提示详细信息。

1）前端js判断必填项输入和二次密码与否相似，角色可以不选；

2）BLL须验证必填项，顾客名是唯一不能重复；

3）加密密码使用MD5.Encrypt（stringString，stringKey），Key="

XXXXXXXX"

；

4）顾客信息保存至表System_admin_info，ExamSys.DAL.System_admin_infoAdd（ExamSys.Model.System_admin_infomodel）；

5）分拆角色ID字符串并循环字符串数组，信息保存至表Dict_admin_vs_roles，ExamSys.BLL.Dict_admin_vs_rolesAdd（ExamSys.Model.Dict_admin_vs_rolesmodel）。

5.3.6.1.3修改顾客

顾客IDstring页面传参数

1）成功，UI提示修改顾客完毕；

2）加密密码使用Chukeh.Security.MD5.Encrypt（stringString，stringKey），Key="

LinLiYan"

3）依照顾客ID删除表Dict_admin_vs_roles记录ExamSys.BLL.Dict_admin_vs_rolesDeleteByAdminID（stringadmin_id）；

4）分拆角色ID字符串并循环字符串数组，信息保存至该表ExamSys.BLL.Dict_admin_vs_rolesAdd（ExamSys.Model.Dict_admin_vs_rolesmodel）。

5.3.6.1.4删除顾客

1、成功，UI提示删除顾客完毕，刷新列表；

2、失败，UI提示详细信息。

3、算法描述

1）依照顾客ID删除表System_admin_info记录ExamSys.DAL.System_admin_infoDelete（stringadmin_id）；

2）依照顾客ID删除表Dict_admin_vs_roles记录ExamSys.BLL.Dict_admin_vs_rolesDeleteByAdminID（stringadmin_id）。

5.3.6.2角色管理模块

5.3.6.3系统设立模块

5.3.6.4系统登录注销模块

5.4系统界面详细设计

系统界面阐明应用系统软件各种接口。

整个系统其她接口（如系统硬件接口、通讯接口等）在相应某些阐明。

5.4.1外部界面设计

依照系统界面划分进行系统外部界面设计，对系统所有外部接口（涉及功能和数据接口）进行设计。

5.4.2内部界面设计

设计系