软件详细设计文档模板(最全面)-详细设计文档.docx

《软件详细设计文档模板(最全面)-详细设计文档.docx》由会员分享，可在线阅读，更多相关《软件详细设计文档模板(最全面)-详细设计文档.docx（19页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、研产生产中心之五兆芳 芳创作文档编号版本A1密级商密A项目名称Xx系统项目来源Xxx系统详细设计说明书（内部资料请勿外传）日期:日期:日期:日期:编写: 查抄: 审核: 批准:XX公司版权所有不得复制文档变动记实序号变动（+/-）说明作者版本号日期批准12目录1.引言41.1编写目的和规模4 1.2术语表48.模块设计8.1 用例图8.2 功效设计说明8.2.1 模块1模块1主要分为以下几个子模块:子模块1、子模块2和子 模块N.8.2.1.1 子模块18.2.1.1.1 设计图功效描述扼要描述子模块1的业务功效.1.1.1.1.1 数据详细描述用户输入的数据（包含任何输入设备）以及这些数据

2、的有效性查验法则.详细描述从物理模型中的哪些表获得数据以及获得这些数据 的条件.1.1.1.1.2 出数据详细描述子功效1所产生的数据以及这些数据的表示形式.82115业务算法和流程从业务角度详细描述按照输入数据产生输出数据的业务算法 和流程.8.2.1.1.6 数据设计给出本程序中的局部数据结构说明,包含数据结构名称,功 效说明,具体数据结构说明（定义、注释设计、取值）等.相关 数据库表,数据存储设计（具体说明需要以文件方法保管的数 据文件名、数据存储格局、数据项及属性等.）82117源程序文件说明给出本程序的各源程序文件的说明,包含源程序文件名称及 其所在目录,功效说明,包含的前导文件及函

3、数名称等.8.2.1.1.8 函数说明具体说明本程序中的各个函数,包含函数名称及其所在文 件,功效,格局,参数,全局变量,局部变量,前往值,算法 说明,使用约束等.8.2.1.1.9 限制条件8.2.1.1.10 其他说明8.2.1.1.11模块1主要分为以下几个子模块:子模块1、子模块2和子模块N.8.2.2.1 子模块18.2.2.1.1 设计图8.2.2.1.2 功效描述扼要描述子模块1的业务功效.82213输入数据详细描述用户输入的数据（包含任何输入设备）以及这些数据 的有效性查验法则.详细描述从物理模型中的哪些表获得数据以及获得这些数据 的条件.82214输出数据详细描述子功效1所产

4、生的数据以及这些数据的表示形式.8.2.2.1.5 业务算法和流程从业务角度详细描述按照输入数据产生输出数据的业务算法 和流程.8.2.2.1.6 数据设计给出本程序中的局部数据结构说明,包含数据结构名称,功 效说明,具体数据结构说明（定义、注释设计、取值）等.相关数据库表,数据存储设计（具体说明需要以文件方法保管的数 据文件名、数据存储格局、数据项及属性等.）82217源程序文件说明给出本程序的各源程序文件的说明,包含源程序文件名称及 其所在目录,功效说明,包含的前导文件及函数名称等.8.2.2.1.8 函数说明具体说明本程序中的各个函数,包含函数名称及其所在文 件,功效,格局,参数,全局变

5、量,局部变量,前往值,算法 说明,使用约束等.8.2.2.1.9 限制条件8.2.2.1.10 说明9 .接口设计9.1 内部接口9.2 外部接口9.2.1 接口说明例如：XX子系统通过XX从XX子系统取得XX等，相关尺 度,调用示例,可按照需要增加章节描述接口.例如:内部接口调用:例:/*通过用户办事号码取得该客户认证密码等信息,如果该客 户存在前往为0,其他情况参考错误编码*/public RUserlnfo ge t Us er Info (S tri ng userNo);10 .数据库设计详见xxx数据库设计说明书如果数据库设计内容比较少,则直接在此处描述.11 .系统平安保密设计1

6、1.1 说明例如:由于存在与外部系统的接口，所以需要考虑拜访平安 的问题.11.2 设计例如:分为数据传输部分,IP过滤部分,身份验证部分.章节 可弥补11.2.1 数据传输部分例如:在部分数据传递的时候,考虑以https协议,需要在安 排的时候作相关处理.11.2.2 IP过滤分部例如:可在系统前端通过Fil ter实现,该Fil ter实现对该 地址拜访的IP过滤作用.可信任IP地址通过xml文件进行配置.11.2.3 身份验证部分例如:对信任的用户，颁布身份验证码,通过该标识进行身份 识另U.12 .系统性能设计13 .系统出错处理例如:为了在系统出现异常情况下给用户以明确的提示,可 采

7、取两种方法予以提示:1 .使用Javascript的alert ()函数直接提示,这主要在输 入或修改的情况下使用;2 .使用统一的错误界面提示,该界面对应于页面.错误界面 样式如下图所示:错误提示界面14 .设计和开发标准I可以列表方法列出设计开发的参考文档的索引,内容较少 /关头内容可以章节方法填写】14.1 数据库设计标准I拜见XXXX数据库设计标准14.2 . NET编码标准特别强调：令详细请拜见ASP. Net文档标准令这里只做复杂论述，如有变动，会实时同事整个项目组相 关人员.(1)不要给类名加前缀.使用PascalCasing气概，不使 用匈牙利命名法.(2)要用名词词组来给类型

8、命名.使用PascalCasing气 概.(3)类名少用缩写，不要使用下划线字符(_).(4)基类CBase的文件名为：FileBase. cs;(5) 泛型类命名：考虑用T来命名参数类型，类 如：public class List.(6)接口(Interface)命名标准和类命名标准相同，唯一区别是 接口在名字前加上“I”前缀. 枚举命名：以单数结尾，标明这是一个枚举，例如：Enum ColorButtons(8)结构命名：标明这是一个结构体，例如：Structure Customer Inf oRecord 以 Record 结尾。除使用东西直接生成的类外，其它所有类的功效要有注 释，即便

9、只是一个数据对象；非罕有功效的API必须要 有功效描述的注释.独立的要被应用其他功效所调用的模 块的接口和公共API的注释要完备，即包含功效说明、 参数和前往值说明.其它情况的API的注释尽量完备，但 不强制要求. 一次性的流打开后必须封闭和释放.一般地，在流打开 后，都有一个try catch语句，务必加上finally块释 放流资源.今即便IF, While是单语句，也要使用“ ”来划分程序 块.。不要有完全为调试使用的日志信息，如 xxxx. info( “1”)；如要使用，在调试完成后请实时删 除.令一些知识性代码，不需要写没需要的注释.令不要用东西生成没用的注释.系统架构目录结构设计

10、图,如下: 结构说明:作用规模包名描述整个程序ContentImages存放图片ScriptsJquery以及样式表等jquery-easyui包数字为版本jquery-ui包数字为版本Scripts/jthok-ui自定义的js格局文件Scripts/themesIcon格局图片以及样式Controllers./Controller控制器处理来自浏览器的输入， 井前往相应页面给用户.Data./Data放自定义的json文件Models./Models存放模型Scripts./Scripts引入的各类外部js文件Views./Views存放各类类型的试图注意定义路由法则等配置文件1.3参考资

11、料41. 4使用的文字处理和画图东西42 .全局数据结构说明52. 1常量53. 2变量54. 3数据结构53 .模块设计53 . 1用例图54 .2功效设计说明53. 2. 1 模块 154. 2.2 模块 264.接口设计74 . 1内部接口 75 .2外部接口 74. 2. 1接口说明75. 2.2调用方法85 .数据库设计86 .系统平安保密设计86. 1说明86. 2设计86. 2. 1数据传输部分86. 2.2 IP过滤分部86. 2. 3身份验证部分87 .系统性能设计98 .系统出错处理91 .引言1.1 布景此文档的布景1.2 编写目的和规模说明写这份详细设计说明书的目的.本

12、详细设计说明书编写的目的是说明程序模块的设计考虑, 包含程序描述、输入/输出、算法和流程逻辑等,为软件编程和 系统维护提供根本.本说明书的预期读者为系统设计人员、软件 开发人员、软件测试人员和项目评审人员.1.3 术语表定义系统或产品中涉及的重要术语,为读者在阅读文档时提 供需要的参考信息.序号术语或缩略语说明性定义1PMProject Manager,项目经理21.4参考资料列出有关资料的名称、作者、文件编号或版本等.参考资料包含:a.需求说明书、架构设计说明书等;b.本项目的其他已颁发的文件;配引用文件、资料、软件开发尺度等.资料名称作者文件编号、版本资料存放地点1.5使用的文字处理和画图

13、东西文字处理软件:编写设计文档使用的文字处理软件,如RedOffice 画图东西:使用的UML东西，如Rose、Jude、Vis io2 .设计概述2.1 任务和目标2.1.1 需求概述2.1.2 运行情况概述2.1.3 条件与限制2.1.4 详细设计办法和东西3 .系统详细需求阐发主要对系统级的需求进行阐发.首先应对需求阐发提出的企 业需求进一步确认,并对由于情况变更而带来的需求变更进行较为详细的阐发.3.1 详细需求阐发3.1.1 详细功效需求阐发3.1.2 详细性能需求阐发3.1.3 详细资源需求阐发3.1.4 详细接口需求阐发3.1.5 详细系统运行情况及限制条件阐发4 .总体计划确认

14、着重解决系统总体结构确认及界面划分问题.4.1 系统总体结构确认对系统组成、逻辑结构及条理进行确认,对应用系统、支撑 系统及各自实现的功效进行确认,细化集成设计及系统任务流 程,特别要注意因软件的引进造成的系统自己结构和公司其他 系统的结构变更.包含:4.1.1 系统组成、逻辑结构及条理确认4.1.2 应用系统结构确认4.1.3 支撑系统结构确认4.1.4 系统集成确认4.1.5 系统任务流程确认4.2 系统详细界面划分4.2.1 应用系统与支撑系统的详细界面划分应用系统与支撑系统之间的界面包含系统主办事器与其他办 事器的办事规模及拜访方法,网络及数据库对应用系统的支撑 方法,全局数据的办理与

15、存取方法等.4.2.2 系统内部详细界面划分系统各功效之间的界面包含笼盖规模,模块间功效调用涉及 到的系统模块及办法,全局数据格局,系统性能要求等.5 .全局数据结构说明本章说明本程序系统中使用的全局数据常量、变量和数据结 构.5.1 常量包含数据文件名称及其所在目录,功效说明,具体常量说明等5.2 变量本章说明本程序系统中使用的全局数据常量、变量和数据结 构.5.3 数据结构包含数据结构名称,功效说明,具体数据结构说明（定义、 注释、取值）等.6 .系统详细设计6.1 功效结构图6.2 系统结构设计及子系统划分对系统的组成及逻辑结构进行设计前确认.划分系统功效模块或子系统（如果有或有需要,特

16、别是大型 的软件系统）.6.3 系统功效模块详细设计按结构化设计办法,在系统功效逐层分化的根本上,对系统 各功效模块或子系统进行设计.此为详细设计的主要部分之一.用条理图描述系统的总体结构、功效分化及各个模块之间的 相互调用关系和信息交互,用IPO图或其他办法描述各模块完 成的功效.以上建议采取HIPO图进行功效分化与模块描述,更 高的要求建议采取IDEFO办法进行功效模型设计.详细设计应用系统的各个组成模块完成的功效及其相互之间 的关系,用IPO或结构图描述各模块的组成结构、算法、模块 间的接口关系,以及需求、功效和模块三者之间的穿插参照关 系.每个模块的描述说明可参照以下格局:模块编号:模

17、块名称:输入:处理:算法描述:输出:其中处理和算法描述部分主要采取伪码或具体的程序语言完成对详细设计更高的要求建议用IDEFO图进行各功效模块的设 计.如果对软件需进行二次开发（包含功效扩展、功效改革、用 户界面改革等），则相应的设计任务应该设立子课题完成.6.4 系统界面详细设计系统界面说明应用系统软件的各类接口.整个系统的其他接 口 （如系统硬件接口、通讯接口等）在相应的部分辩明.6.4.1 外部界面设计按照系统界面划分进行系统外部界面设计,对系统的所有外 部接口 （包含功效和数据接口）进行设计.6.4.2 内部界面设计设计系统内部各功效模块间的调用关系和数据接口.6.4.3 用户界面设计法则人机界面的内容、界面气概、调用方法等,包含所谓的 表单设计、报表设计和用户需要的打印输出等设计.此部分外容 可能比较多.7 .开发和测试生产情况说明7.1 开发情况7.2 测试及产品情况- Development evnironment: programming lanuague, databaseWindwos 2003, iis 6. 0, MySQL,