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

: .
xxxxx系统
详细设计说明书
文件状态：
[V]草稿
[]正式发布
[]正在修改
文、逻辑结构及层次确认应用系统结构确认支撑系统结构确认系统集成确认系统工作流程确认

应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范围及访问方式，网络及数据库对应用系统的支撑方式，全局数据的管理与存取方式等。

系统各功能之间的界面包括覆盖范围，模块间功能调用涉及到的系统模块及方法，全局数据格式，系统性能要求等。
5 系统详细设计

系统采用三层架构模型，将应用系统划分为用户界面表示层、业务逻辑层、数据访问层，以及EntityClass实体类、Comm磷库组成，各层的关系如下图所示:
UI(UserInterface)用户界面表示层
负责与用户进行交互，显示、接受数据，与此同时，做一些简单逻辑处理，如：输入数据有效性判断、显示各种异常、处理Dataset记录集数据。它只与BLL(BusinessLogicLayer)业务逻辑层、EntityClass实体类两个项目发生关联，可能与Common库发生关联。
BLL(BusinessLogicLayer)业务逻辑层
是整个系统的核心，它承担了所有的逻辑判断，实现了程序的功能，它是灵活的。BLL层既是调用者，又是被调用者，因此，要适当的进行设计达到解耦的效果。BLLM只关联DALM和实体类，可能关联Common库。虽然BLLM被U层调用，但是BLL层无需关心UI层的情况。数据库中每个表都对应一个BLL类，为了达到解耦效果，BLL类不能直接调用其他表的DA啖，可以BL啖之间相互调用。
DAL(DataAccessLayer)数据访问层
提供数据访问的接口，没有任何逻辑。在接口中对数据库操作语句进行组合装配。DALM一般关联Common库中的最底层，最基础的数据库类(比如：链接数据库)，必须关联EntityClass实体类项目。DALM只是数据库的管理者，但不是访问者，不直接与数据库发生关联。数据库中每个表都对应一个DALM的接口(访问控制)类。
Common库
用于存放公用的类。最常用的就是数据库访问类，比如：链接字符串，数据库引擎类。它直接与数据库进行机械式的交换，无任何逻辑。
EntityClass实体类
相当于加强的数据结构，实现了对数据的封装。数据库中每个表都对应一个实体类，表的字段就是实体类的属性，类型一一对应。UI、BLL、DAL^三层的交互主要就是通过实体类作为参数，并Return回信息。

根据业务和功能，将系统的逻辑结构划分为X疽系统、X仃系等6个子系统，如下图所示：
各个子系统按照功能角度分解，戈U分出若干不同的功能模块，如下面各图所示:

按结构化设计方法，在系统功能逐层分解的基础上，对系统各功能模块或子系统进行设计。此为详细设计的主要部分之一。
用层次图描述系统的总体结构、功能分解及各个模块之间的相互调用关系和信息交互，用IPO图或其他方法描述各模块完成的功能。以上建议采用HIP消进行功能分解与模块描述，更高的要求建议采用IDEF昉法进行功能模型设计。
详细设计应用系统的各个构成模块完成的功能及其相互之间的关系，用IPO或结构图描述各模块的组成结构、算法、模块间的接口关系，以及需求、功能和模块三者之间的交叉参照关系。
每个模块的描述说明可参照以下格式：
模块编号：
模块名称：
输入：
处理：
算法描述：
输出：
其中处理和算法描述部分主要采用伪码或具体的程序语言完成。
对详细设计更高的要求建议用IDEF0图进行各功能模块的设计。
如果对软件需进行二次开发（包括功能扩展、功能改造、用户界面改造等），则相应的设计工作应该设立子课题完成。
注意：算法描述主要是说明BLLM的代码逻辑，UI层只做简单的输入验证和界面显示功能。
XX?!
模块描述：管理系统用户，包括添加用户并赋予角色、修改用户资料和角色、删除用户。
主要功能：添加用户、修改用户、删除用户、列表和分页。
列表和分页
1、流程图
省略
2、输入项
分页索引页面传参数页面加载时为1
3、输出项
1) 列表