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

远程多试验区在线考试系统http:/www.Bai /小毛o /电脑系统详细设计说明书文件状态:草稿 正式发表 正在更改文件id :当前版本:1.0作者:完成日期:版本历史记录版本/状态作者参加者开始日期备注1.0开始写作修改唱片。日期修订版修改文章变更说明作者目录1引言51.1制作目的51.2背景51.3参考资料51.4术语的定义和说明52设计概要52.1任务和目标52.1.1需求的概要52.1.2运行环境的概要52.1.3条件和限制62.1.4详细的设计方法和工具63系统详细需求分析63.1详细的需求分析63.2详细的系统执行环境和制约条件分析界面需求分析64整体方案确认64.1系统整体的构成确认64.2系统详细接口分类74.2.1应用系统和支撑系统的详细接口划分74.2.2系统内部详细的接口划分75系统详细设计75.1系统程序代码架构设计75.1.1用户界面显示层75.1.2业务逻辑层(bll )业务逻辑层85.1.3数据访问层(dal )数据访问层85.1.4Common类库85.1.5实体类实体类85.2系统结构设计和子系统划分85.3系统功能模块详细设计95.3.1XX子系统9. 1XX模块9清单和分页符9创建XX9. 2XX模块9XX清单9XX修正95.3.2XX子系统用户管理模块角色管理模块系统设定模块系统登录取消模块145.4系统接口的详细设计145.4.1外部接口设计145.4.2内部接口设计145.4.3用户界面设计146数据库系统设计146.1设计要求146.2信息模型设计146.3数据库设计146.3.1设计依据146.3.2数据库的种类和特征156.3.3数据库逻辑结构156.3.4物理结构设计156.3.5数据库安全性156.3.6数据词典157信息代码设计157.1代码结构设计157.2代码创建151引言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系统程序代码架构设计系统采用三层结构模型，应用系统由用户界面显示层、业务逻辑层、数据访问层和实体类、公共类库构成，各层的关系如下图所示。5.1.1用户界面显示层(ui )。负责与用户的对话、数据的显示、接收，同时进行数据有效性判断的输入、各种异常的显示、Dataset记录集数据的处理等简单的逻辑处理。 它仅与两个项目(业务逻辑层(bll )业务逻辑层和实体类实体类)相关，可能与公共类库相关。5.1.2业务逻辑层(bll )业务逻辑层是整个系统的核心，承担所有逻辑判断，实现程序功能，灵活。 BLL层既是调用者，也是被调用者，因此必须恰当地设计以达到解除结合的效果。 BLL层可以仅将DAL层与实体类关联，并将公共类库与实体类关联。 BLL层被u层调用，而BLL层不需要在意UI层的状况。 数据库中的每个表都对应于BLL类，为了实现解绑定效果，BLL类不能直接调用其他表的DAL类，而是可以在BLL类之间相互调用。5.1.3数据访问层(dal )数据访问层提供数据访问的接口，没有逻辑。 在接口上组合数据库操作语句。 DAL层通常是公共类库的最低级别，必须与最基本的数据库类(例如，到数据库的链接)相关联，并与实体类实体类项相关联。 DAL层是数据库的管理员，但不是访问者，而是与数据库直接相关。 数据库中的每个表都对应于DAL层的接口(访问控制)类。5.1.4公共程序库用于存储共同的类。 最常见的是数据库访问类。 例如，链接字符串、数据库引擎类。 与数据库直接机械交换，不合逻辑。5.1.5实体类实体类相当于强化了的数据结构，实现了数据的封装。 数据库中的每个表对应于实体类，表中的字段对应于实体类的属性，类型一对一对应。 UI、BLL、DAL三层的交互主要以实体类为参数，通过Return返回信息。5.2系统结构设计和子系统划分根据业务和功能，将系统的逻辑结构分为XX子系统、XX子系统等6个子系统。 下图所示。XXXXXXXX系统XX管理子系统XX管理子系统XX子系统XX子系统XX子系统XX子系统各子系统根据功能的角度进行分解，如下图所示分为几个不同的功能模块5.3系统功能模块的详细设计根据结构化设计方法，在逐步分解系统功能的基础上，设计系统的各功能模块和子系统。 这是详细设计的主要部分之一。用分层图描述系统的整体结构、功能分解和各模块间的相互调用关系和信息交换，用IPO图和其他方法描述各模块完成的功能。 以上提案用HIPO图进行功能分解和模块描述，更高的要求用IDEF0方法进行功能模型设计。详细设计了应用系统各构成模块完成的功能及其相互关系，用IPO和结构图描述各模块的构成结构、算法、模块之间的接口关系、需求、功能和模块之间的相互参照关系。每个模块的说明可以参考以下格式:模块编号:模块名称:输入:处理:算法说明:输出:其中，处理和算法的描述部分主要用伪码或具体的程序语言完成。对于要求更详细的设计的要求，使用IDEF0图进行各功能模块的设计。在需要二次开发软件的情况下(包括功能扩展、功能改造、用户界面改造等)，相应的设计工作必须设置子课题来完成。注意:算法的说明主要说明BLL层的代码逻辑，UI层只进行简单的输入验证和界面显示功能。5.3.1 XX子系统.1 XX模块列表和分页符创建XX. 2 XX模块XX列表XX变更5.3.2 XX子系统用户管理模块模块说明:管理系统用户，包括添加和授予用户、修改用户数据和角色以及删除用户。主要功能:添加用户、更改用户、删除用户、列表和分页。.1列表和寻呼1 .流程图省略2 .输入项分页索引页传输参数页加载时为13 .输出项1 )列表详细记录2 )当前页码3 )寻呼总数4 )唱片总数。4 .算法的说明系统管理用户的数据量少，而且此功能不经常使用，因此可以在不优化分页的情况下获取用户表的所有记录，并在UI层使用gridview控件来获取examplesys.bll.system _ admin _ infog 调用绑定控件，利用gridview的分页功能显示分页按钮、当前页面、分页总数、记录总数，.2添加用户1 .流程图输入用户数据。选择角色加密密码。填写合规性。用户信息保存在System_admin_info表中必要项目的验证认证用户名是否存在成功与否。分割角色ID字符串循环字符串数组将信息保存到表Dict_admin_vs_roles中返回成功信息是的，是的。否是的，是的。返回失败信息否是的，是的。否操作日志2 .输入项用户id字符串是必需的名称字符串是必需的用户密码string是必需的我需要确认密码字符串。联系电话string电子邮件字符串状态char用户角色id字符串3 .输出项1 )成功，UI通知用户添加完成2 )失败，UI提示具体信息。4 .算法的说明1 )开头js判断必要项目的输入和二次密码是否相同，也可以不选择角色2) BLL需要验证必要项目，用户名是唯一不可重复的3 )加密密码是MD5 .加密(字符串，字符串密钥)，密钥=xxxxxxxx ；4 )用户信息保存在表System_admin_info，examplesys.dal.system _ admin _ info add (examplesys.model.system _ admin _ info model )中5 )分割角色ID字符串，使字符串数组循环，并将信息表示为Dict_admin_vs_roles，examples.bll.dict _ admin _ vs _ roles add (examples.model.dict _ admin _ vs.3用户的变更1 .流程图输入用户数据。选择角色填写合规性。用户信息保存在System_admin_info表中必要项目的验证加密密码。成功与否。分割角色ID字符串循环字符串数组将信息保存到表Dict_admin_vs_roles中返回成功信息是的，是的。是的，是的。返回失败信息否否根据用户ID删除表Dict_admin_vs_roles记录成功与否。是的，是的。否操作日志2 .输入项用户IDstring页传输参数名称字符串是必需的用户密码string是必需的你需要确认密码字符串。联系电话string电子邮件字符串状态char用户角色id字符串3 .输出项1 )成功，UI提示用户修改2 )失败，UI提示具体信息。4 .算法的说明1 )开头js判断必要项目的输入和二次