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

研发生产中心文档编号版本A1密级商密A项目名称Xx系统项目来源Xxx系统详细设计说明书［内部资料请勿外传）XX公司版权所有不得复制文档变更记录序号麦更（+L）说明作者版本号日期批准12目录引言41.1编写目的和范围41.2术语表41.3参考资料41.4使用的文字处理和绘图工具4全局数据结构说明52.1常量52.2变屋52.3数据结构5模块设计53.1用例图53.2功能设计说明5模块15模块26接口设计74.1内部接口74.2外部接口74.2.1接口说明74.2.2调用方式85.数据库设计86系统安全保密设计86.1说明86.2设计86.2.1数据传输部分8IP过滤分部86.2.3身份验证部分8系统性能设计9系统岀错处理91.1背景此文档的背景1.2编写目的和范围说明写这悅详细设计说闕书的目的。本详细设计说明书编写的目的是说明程序模块的没计考虑,包括程序堆述、输入/输出、算送和流程逻辑等,为软件编程和系统维护提供基础。本说明节的预期读者为系统设计人灵、软件开发人员、软件测试入员和顼目评审入员。1.3术语表定义系统或产品中涉及的重妾术语9为读者在阅读文档时提供必耍的参考信息°序号术语或缩略语说明性定义1PMProjectManager,项目经理21.4参考资料列出有关资料的名琢、作者、文件编号或版本等。参考资料包乐乩需求说绸书、架构设计说明书等;b.本项目的其他已发表的文件:C.引用文件、资科、软件开发 标准 excel标准偏差excel标准偏差函数exl标准差函数国标检验抽样标准表免费下载红头文件格式标准下载 等。紅料名称作者文件编号、版本遥料存放地点1.5使用的文字处理和绘图工貝文字处理软件:〔编写设计文档使用的文字处理软件，如RedOffice]维图工具:（使用的U仏工具-・iSRose.环、Visio]设计概述2.1任务和目标2.1.1需求概述2.1.2运行坏境概述2.1.3条件与限制2.1.4详细设计方法和工具系统详细需求分析主要对系统级的霊求逬行分析。苣先殛对需求分析提出的企业需求进一歩确儿并对由于情况变化而帝来的需求变化選行较为详细的分析。3.1详细需求分析3.1.1详细功能需求分析3.1.2详细性能需求分析3.1.3详细资源需求分析3.1.4详细接口需求分析3.1.5详细系统运行环境及限制条件分析总体 方案 气瓶 现场处置方案 .pdf气瓶 现场处置方案 .doc见习基地管理方案.doc关于群访事件的化解方案建筑工地扬尘治理专项方案下载 确认着重解决乘统总体结檢确认及界面创分问 题 快递公司问题件快递公司问题件货款处理关于圆的周长面积重点题型关于解方程组的题及答案关于南海问题 。4.1系统总体结构确认对系统组成、逻辑结构及层次遂行确认,对应用系统、支样系统及各自实现的功能进行确认,细化集成设计及爲统 工作流程 财务工作流程表财务工作流程怎么写财务工作流程图财务工作流程及制度公司财务工作流程 ,特别要注意因软件的引进造成的系统本身结捣和公司英他奈统餡结构变化。包括:4.1.1系统组成、逻辑结构及层次确认4.1.2应用系统结构确认4.1.3支撑系统结构确认4.1.4系统集成确认4.1.5系统工作流程确认4.2系统详细界面划分4.2.1应用系统与支撑系统的详细界面划分应用系统与支撐系统之间的界廊包括系统主眾务器与其他服务器的服务范围及访问方式,网络及数据库对应用爲统的支撐方式,全局数据的管理与存取方式等。4.2.2系统内部详细界面划分系统各訪能之间的界血包括覆竈范围,模块间豹能调用涉及到的系统模块及方法，全局数据格式j系统性能要求等。全局数据结构说明本章说明本程序系统中使用的全局数据常量、变量和数据结构。5.1常量包括数据文件名琢及其所在且录,功能说阴,具体常量说頤等。5.2变量本章说明本程序系统中使用的全局数据常量、变量和数据结构。5.3数据结构包括数据结构名隸,功能说明，具体数擾结构说明〔定文、注释、取值〉氛系统详细设计6.1功能结构图6.2系统结构设计及子系统划分对系统的组成及逻辑结构迸行设计前确认。划分系统功能模块或子系统（如果有或者有必要,特别是大型的软件系统）°6.3系统功能模块详细设计按结构化设计方法,在系统功能逐层分解的基础上,貳系统各功能模块或子黍统进行设计A曲为详细设计的主妥部分之一°用层次酉擔述系统的总悴结构、功能分解及各个漠块之间的相互调用关系和宿息交互,用IPQ图或其他方法描述各模块完成的功能。以上建议采用HIFO图进斎幼能分烬与模块箱述，更髙的妾求建议采用IDEH）方法逬行为j能模型设计「详细设计应用系统的各个构成模块完成的功能及其相互之间的关系，用］P0或结构图描述各模块的组成结构、算法、樓块间的接口关萦,以及需求、迷能和模块三者之间的交叉参照关系。每个模块的描述说明可参照以下格式:模块编号:棧块色隸处理:算法描述:输出:其中处理和算法描述部分主要采用伪码或具体的程序语言完成。对详细设计更高餡要求建议用IDEFO图进行各功能模块的设计。如果对歎件蛊迸行二次开发（包括功能扩慝、功能改造、用户界面改适等）,则相应的设计工作应该设立子课题完成。6.4系统界•面详细设计系统界面说明应用泵统软件的各种樓口。整个系统的其他樓口（如系统硬件緩口、通讯接口等）在相应餉部分说明。6.4.1外部界面设计根根系统寮廊划分进行系统夕卜部界面设计,对系统的所有处部接口（包括功能和数裾凄口）进行设计。6.4.2内部界面设计设计系统内部各功能模块间的调用关系和数据接口。643用户界面设计 规定 关于下班后关闭电源的规定党章中关于入党时间的规定公务员考核规定下载规定办法文件下载宁波关于闷顶的规定 人机賽面的內容、界面风格、调舟方式等,包括颅谓的表单设计、报表设计和用户需要的打印綸岀筆设计。此部分内容可能比较多。开发和测试生产环境说明7.1开发环境7.2测试及产品坏境-Developmentevnironment:programminglanuague,databaseVs2010-svn-iss6.1+-mysql/sqlserver2005/2008-.netframwork4.0-Testing&productionenvironmentOS,database・.netframwork4.0Windwos2003,iis6.0,MySQL&模块设计8.1用例图8.2功能设计说明&2.1模块1模块1主要分为以于几个子模块;子模块A子模块2和子模块也&2.1.1子模块18.2.1.1.1设计图8.2.1.1.2功能描述简要損述子模块1的业务功能。8.2.1.1.3输入数扌居详细描述用户魏入的数裾〔包括任何输入设备）以及这些数榻的有效性检验规则。详细描述从物锂模型中的哪些表农取数視以及获取这些数視的条件。8.2.1.1.4输出数据详细撞述子功能1所产生的数梅以及这些数据的表现形式。8.2.1.1.5业务算法和流程从业务角度详细描述根裾输入数据产生輸出数据餡业务算法和潦程。8.2.1.1.6数据设计给出本程序中的局部数据结构说頤,包括数据结构名称,功能说明,具体数据结构说明传戈、注释设计、取值）等•相关数据库表,数据存鎧设计C具体说明需要張文件方式保存的数据文件名、数握存储格式、数据项及属性等。）3.2.1.1.7源程序文件说明绐出本程序的各源程序文件的说明,包括源程序文件名称及其质在目录,功能说明,包含的前导文件及函数名称等。8.2.1.1.8更数说明具体说明本程序中的各个函数,包括函数名称及其撚在文件,功能,格式,参数・全局变量，局部变呈,返回值「算法说明°使用约束等。8.2.1.1.9限制条件8.2.1.1.10其他说明8.2.2模块2模块1主要分为以下几个子模块:予模块1＞子模块2和子模块M8.2.2.1子模块18.2.2.1.1设计图8.2.2.1.2功能描述简要描述子模块1的业务功能.8.2.2.1.3输入数据详细描述用户輸入的数榻（包括任何输入设备）以及这些数榻的有效性检验规详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。8.221.4输出数据详细描述子功能1所产生的数提以及这些数粧的表现形式。8.2.2.1.5业务算法和流程从业务角度详细描述根据綸入数据产生輸出数据的业务算法和流程。8.2.2.1.6数据设计给出本程序中的局部数据结构说绸,包括数据结构屯称,功能说明,具体数据结构说明（定义、注释设计、取值）等。相关数据库表,数据存腿设计（具体说明需要以文件方式保存的数据文件名、数据存储格式、数根项及属性等.）8.2.2.1.7源程序文件说明给出•本程序的各源程序文件的说绸,包括源程序文件名称及其所在目录,功能说阴,包含的聽导文件及函数名称等。8.2.2.1.8函数说明具体说明本程序中的各个函数,包話函数名称及其所在文件,功能,格式,参哉，全局变壹.局部变亶返回值』算法说明,使用约束等。8.2.2.19限制条件8.2.2.1.10其他说明接口设计9.1内部接口9.2外部接口9.2.1接口说明洌如:XX干熹统通过XX从XX子系统取得^等,相关标准,调用示鴻可根梶気妥増加章节播述接口。922调用方式例如：内部接口调月:例:/沁*通过用户眾务号码取得该客户认证密码等信息*如果该客户存在返回为0,其他情况参考错误编码VpublicRUserlnfogeWserlnfo(StringaserNo);数据库设计详见［xxx数据库设计说貂书］如果数裾库设计内容比较少,刚直接在此处描述0系统安全保密设计11.1说明例如:由于存在与外部棄统的樓口，更以需要考虑访问安全的问题、112设计例如:分为数据钱娥部分,丹过滤部分,身份验证部分.［章节可补充］11.2.1数据传输部分洌如,在部分数据传递的时候,考虑以h忧ps松议,需妥在部署的时候作相关处理.11.2.2IP过滤分部例如:可在系统前端通过Filter实现,该Filler实砚对该地址访问的IP过滤作用、可信任IP地址通过文件迸行配置.11.2.3身份验证部分例如:对信任的用户,颁发身份验证码,通过该标识进行身份识别.系统性能设计系统出错处理例如:为了在系统出现异常情况下给用户哄明确的提示,可采用两种方式予以提不:人使用的abN()函数直接谨示,这主妥在輸入或條改的情况下使用;、2・使用统一的错误界面提示,该賽面对应于应口沖超e.jsp页血。错误界面样式如下图所示:错渓提示：“错误提示内容"错误捉示畀面设计和开发规范I可以列表方式列出设计开发的参考文档的索引,内容较少/关键内容可以童填呵14.1数据库设计规范14.2-NET编码规范特别强调：令详细请参刃《ASP.Net文档规范》§这里只做简单阐述，如有变动，会及时冋事整个顶□纟且相关人员。不要给类名加前缀。使用PascalCasing风格，不便用匈牙利命名法。要用名词词组来给类型命名。使用PascalCasing风格°类名少用缩写，不要使用下划线字符()。基类CBase的文件名为：FileBase.cs;泛型类命名：考虑用T来命名参数类型，类如：publicclassList。接口(Interface)命名规范和类命名规范相同，唯一区别是接口在名字前加上"I"前缀。枚举命名：以戻数结尾，表明这是一个枚举，例如：EnumColorButtons结构命名：表明这是一个结构休，例如：StructureCustomerInfoRecord'以Record结尾令除使用工旦直接生成的类外，其它所有炎的功能要有注释，即使只是一个数据对象；非常见功能的API必须要有功能描述的注释。独立的要被应用具他功能所调用的模块的接口和公共API的注释耍完备，即包括功能说明、参数和返回值说明。具它情况的API的注释尽量完备，但不强制要求。令一次性的流打开后必须关闭和释放。一般地，在流打开后，都有一个trycatch语句，务必加上finally块释放流资源。令即使IF,While是单语句，也要使用"{}"来划分程序块。令不要有完全为调试使用的日志信息，如xxxx.info("1");如要使用，在调试完成后请及时删除。令一些常识性代码，不需要写没必耍的注释。令不要用工具生成没用的注释。14.3代码目录结构【刃解决方案Authority12个项目）X脚本文普日・£田田系统架构目录结构设计图,如下:!Authority21Properties空引用_App_Data乙ContentIt口ImagesQ—Scripts曰L-7jquery-easyui-1・2.6ffi匚Jlocale51口plugins(2C3themes仝】easyloader.jsjquery-1.7.2.min.jsjquery,easyui・min・js匕口口巳盘fflfflffla田田QSUJjquery-ui-18.20曲_IjthoLuiiUthemesControllersModelsScriptsVievsGlobal,asaxVebconfig结构说明:作用范圉包名描述整个程序ContentImages存放图片ScriptsJquery以及样式表等Scripts/jquery-easyui-1.2.6jquery-easyui包数字为版本Scripts/jqueryui-1.8.20jqueryui包数字为版本Scripts/jthok-ui自定义的js格式文件Scripts/themesIcon格式图片以及样式Controllers../Controller控制器处理来口浏览器的输入，并返回相应页面给用户。Data../Data放自走义的json文件Models../Models存放模型Scripts../Scripts引入的各种外部js文件Views../Views存放各种类型的试图Globalasax../Globalasax注意定义路由规则等Web.config../Web.config配置文件