《软件详细设计文档模板要点》由会员分享，可在线阅读，更多相关《软件详细设计文档模板要点（13页珍藏版）》请在金锄头文库上搜索。
1、软件详细设计文档模板要点文档编号 版本 A1 密级 商密 A 研发生产中心 项目名称 Xx 系统 项目来源QR-RD-022(Ver1.2)Xxx 系统 详细设计说明书 ( 内部资料 请勿外传 ) 编 写: 日 期: 检 查: 日 期: 审 核: 日 期 : 批 准: 日 期:XX公司版权所有 不得复制文档变更记录序号 作者 版本号 日期 批准 变更 (+/-) 说明1 2目录1. 引51.1 编写目的和范围 51.2 术语表 51.3 参考资料 51.4 使用的文字处理和绘图工具 / 、 5 2. 全局数据结构说 明 52.1 常量 62.2 变量 62.3 数据结模块设构 6 3.计 3.
2、1 用例图 63.2 功能设计说明 63.2.1 模块1 63.2.2 模块2 7 4.接口设计 84.1 内部接口 84.2 外部接口 84.2.1 接口说明 8系统安全保密设系统出错处4.2.2 调用方式 8 5. 数据库设计8 6.计 96.1 说明 96.2 设计 96.2.1 数据传输部分 96.2.2 IP 过滤分部 96.2.3 身份验证部分 9 7. 系统性能设计 9 8.理 91. 引言1.1 编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输 入/ 输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说
3、明书的预期 读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。1.2 术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信 息。 序号 术语或缩略语 说明性定义1 PM Project Manager, 项目经理21.3 参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括 : a( 需求说明书、架构设计说明书等 ;b( 本项目的其他已发表的文件 ;c( 引用文件、资料、软件开发标准等。资料名称 作者 文件编号、版本 资料存放地点1.4 使用的文字处理和绘图工具 文字处理软件 : 编写设计文档使用的文字处理软件，如 RedOffice 绘图工具：
4、使用的UML工具，女口 Rose Jude、Visio2. 全局数据结构说明本章说明本程序系统中使用的全局数据常量、变量和数据结构。2.1 常量包括数据文件名称及其所在目录，功能说明，具体常量说明等。2.2 变量本章说明本程序系统中使用的全局数据常量、变量和数据结构。2.3 数据结构包括数据结构名称，功能说明，具体数据结构说明 （定义、注释、取值 ） 等。 3. 模块设计3.1 用例图3.2 功能设计说明3.2.1 模块 1模块 1 主要分为以下几个子模块 : 子模块 1、子模块 2 和子模块 N。 3.2.1.1 子模块 13.2.1.1.1 设计图3.2.1.1.2 功能描述简要描述子模块
5、 1 的业务功能。3.2.1.1.3 输入数据详细描述用户输入的数据 （包括任何输入设备 ） 以及这些数据的有效性检验规 则。详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。3.2.1.1.4 输出数据详细描述子功能 1 所产生的数据以及这些数据的表现形式。 3.2.1.1.5 业务 算法和流程从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。3.2.1.1.6 数据设计给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据 结构说明 （定义、注释设计、取值 ） 等。相关数据库表，数据存储设计 （具体说明需 要以文件方式保存的数据文件名、数据存储格式、数据项
6、及属性等。 ）3.2.1.1.7 源程序文件说明 给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功能 说明，包含的前导文件及函数名称等。3.2.1.1.8 函数说明 具体说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参 数，全局变量，局部变量，返回值，算法说明，使用约束等。3.2.1.1.9 限制条件3.2.1.1.10 其他说明3.2.2 模块 2模块 1主要分为以下几个子模块 :子模块 1、子模块 2和子模块 N。 3.2.2.1 子模块 13.2.2.1.1 设计图3.2.2.1.2 功能描述简要描述子模块 1 的业务功能。3.2.2.1.3 输入数据详
7、细描述用户输入的数据 （包括任何输入设备 ） 以及这些数据的有效性检验规 则。详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。3.2.2.1.4 输出数据详细描述子功能 1 所产生的数据以及这些数据的表现形式。3.2.2.1.5 业务算法和流程从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。3.2.2.1.6 数据设计 给出本程序中的局部数据结构说明，包括数据结构名称，功能说明，具体数据 结构说明 （定义、注释设计、取值 ） 等。相关数据库表，数据存储设计 （具体说明需 要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。 ）3.2.2.1.7 源程序文件说明
8、给出本程序的各源程序文件的说明，包括源程序文件名称及其所在目录，功能 说明，包含的前导文件及函数名称等。3.2.2.1.8 函数说明 具体说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参 数，全局变量，局部变量，返回值，算法说明，使用约束等。3.2.2.1.9 限制条件3.2.2.1.10 其他说明4. 接口设计4.1 内部接口4.2 外部接口4.2.1 接口说明例如 :xx 子系统通过 xx 从 xx 子系统取得 xx 等，相关标准，调用示例，可根据 需要增加章节描述接口。4.2.2 调用方式例如: 内部接口调用 :例:/* 通过用户服务号码取得该客户认证密码等信息，如果该客
9、户存在返回为0，其他情况参考错误编码*/public RUserInfo getUserInfo (String userNo);5. 数据库设计详见 xxx 数据库设计说明书 如果数据库设计内容比较少，则直接在此处描述。6. 系统安全保密设计6.1 说明例如: 由于存在与外部系统的接口 ,所以需要考虑访问安全的问题 . 6.2 设计 例如:分为数据传输部分 ,IP 过滤部分 ,身份验证部分 . 章节可补充 6.2.1 数 据传输部分例如: 在部分数据传递的时候 ,考虑以 https 协议,需要在部署的时候作相关处 理. 6.2.2 IP 过滤分部例如:可在系统前端通过 Filter 实现,该
10、 Filter 实现对该地址访问的 IP 过滤 作用.可信任 IP 地址通过 xml 文件进行配置 .6.2.3 身份验证部分例如:对信任的用户 ,颁发身份验证码 ,通过该标识进行身份识别 .7. 系统性能设计8. 系统出错处理例如: 为了在系统出现异常情况下给用户以明确的提示，可采用两种方式予以 提示:1( 使用 Javascript 的 alert() 函数直接提示，这主要在输入或修改的情况下使 用;2( 使用统一的错误界面提示，该界面对应于 errorpage.jsp 页面。错误界面样 式如下图所示:错误提示 : “错误提示内容”返回错误提示界面 古今名言敏而好学，不耻下问孔子业精于勤，
11、荒于嬉 ; 行成于思，毁于随韩愈 兴于诗，立于礼，成于 乐孔子 己所不欲，勿施于人孔子读书破万卷，下笔如有神杜甫读书有三到，谓心到，眼到，口到朱熹 立身以立学为先，立学以读书为 本欧阳修 读万卷书，行万里路刘彝黑发不知勤学早，白首方悔读书迟颜真卿 书卷多情似故人，晨昏忧乐每 相亲于谦 书犹药也，善读之可以医愚刘向莫等闲，白了少年头，空悲切岳飞 发奋识遍天下字，立志读尽人间书 苏轼 鸟欲高飞先振翅，人求上进先读书李苦禅立志宜思真品格，读书须尽苦功夫阮元 非淡泊无以明志，非宁静无以致远诸葛亮 熟读唐诗三百首，不会作诗也会吟孙洙唐诗三百首序 书到用时方恨少，事非经过不知难陆游 问渠那得清如许，为有源头活水来朱熹 旧书不厌百回读，熟读精思子自知苏轼书痴者文必工，艺痴者技必良一一蒲松龄声明访问者可将本资料提供的内容用于个人学习、研究或欣赏，以及其他非商业性 或非盈利性用途，但同时应遵守著作权法及其他相关法律的规定，不得侵犯本文档 及相关权利人的合法权利。谢谢合作
