- 1、本文档共10页,可阅读全部内容。
- 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
文档编号
版本A1
密级
商密 A
研发生产中心
项目名称
XX系统
项目来源
QR-RD-022(Ver1.2)
Xxx 系统
详细设计说明书
( 内部资料 请勿外传 )
编
写:
日 期:
检
查:
日 期:
审
核:
日 期:
批
准:
日 期:
公司
版权所有 不得复制
文档变更记录
序号 变更( +/-)说明 作者 版本号 日期 批准
1
2
目 录
1. 引言 5
1.1 编写目的和范围 5
1.2 术语表 5
1.3 参考资料 5
1.4 使用的文字处理和绘图工具 5
2. 全局数据结构说明 6
2.1 常量 6
2.2 变量 6
2.3 数据结构 6
3. 模块设计 6
3.1 用例图 6
3.2 功能设计说明 6
3.2.1 模块 1 6
3.2.2 模块 2 7
4. 接口设计 8
4.1 内部接口 8
4.2 外部接口 8
4.2.1 接口说明 8
4.2.2 调用方式 8
5. 数据库设计 9
6. 系统安全保密设计 9
6.1 说明 9
6.2 设计 9
6.2.1 数据传输部分 9
6.2.2 IP 过滤分部 9
6.2.3 身份验证部分 9
7. 系统性能设计 10
8. 系统出错处理 10
引言
1.1 编写目的和范围
说明写这份详细设计说明书的目的。
本详细设计说明书编写的目的是说明程序模块的设计考虑, 包括程序描述、输入 / 输出、算法和流程逻辑等,为软件编程和系统维护提供基础。 本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。
1.2 术语表
定义系统或产品中涉及的重要术语,为读者在阅读文档时提供必要的参考信息。
序号
术语或缩略语
说明性定义
1
PM
Project Manager, 项目经理
2
1.3 参考资料
列出有关资料的名称、作者、文件编号或版本等。参考资料包括:
a.需求说明书、架构设计说明书等;
b.本项目的其他已发表的文件;
c.引用文件、资料、软件开发标准等。
资料名称 作者 文件编号、版本 资料存放地点
1.4 使用的文字处理和绘图工具
文字处理软件: [ 编写设计文档使用的文字处理软件,如 RedOffice ]
绘图工具: [ 使用的 UML工具,如 Rose、Jude、Visio]
全局数据结构说明
本章说明本程序系统中使用的全局数据常量、变量和数据结构。
2.1 常量
包括数据文件名称及其所在目录,功能说明,具体常量说明等。
2.2 变量
本章说明本程序系统中使用的全局数据常量、变量和数据结构。
2.3 数据结构
包括数据结构名称,功能说明,具体数据结构说明(定义、注释、取值)等。
模块设计
3.1 用例图
3.2 功能设计说明
3.2.1 模块 1
模块 1 主要分为以下几个子模块:子模块 1、子模块 2 和子模块 N。
子模块 1
.1 设计图
.2 功能描述
简要描述子模块 1 的业务功能。
.3 输入数据
详细描述用户输入的数据 ( 包括任何输入设备 ) 以及这些数据的有效性检验规则。
详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。
.4 输出数据
详细描述子功能 1 所产生的数据以及这些数据的表现形式。
.5 业务算法和流程
从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。
.6 数据设计
给出本程序中的局部数据结构说明, 包括数据结构名称, 功能说明,具体数据结构说明(定义、注释设计、取值)等。相关数据库表,数据存储设计(具体说明需要以文件方式保存的数据文件名、数据存储格式、数据项及属性等。 )
.7 源程序文件说明
给出本程序的各源程序文件的说明, 包括源程序文件名称及其所在目录, 功能说明,包含的前导文件及函数名称等。
.8 函数说明
具体说明本程序中的各个函数,包括函数名称及其所在文件,功能,格式,参数,全局变量,局部变量,返回值,算法说明,使用约束等。
.9 限制条件
.10 其他说明
3.2.2 模块 2
模块 1 主要分为以下几个子模块:子模块 1、子模块 2 和子模块 N。
子模块 1
.1 设计图
.2 功能描述
简要描述子模块 1 的业务功能。
.3 输入数据
详细描述用户输入的数据 ( 包括任何输入设备 ) 以及这些数据的有效性检验规则。
详细描述从物理模型中的哪些表获取数据以及获取这些数据的条件。
.4 输出数据
详细描述子功能 1 所产生的数据以及这些数据的表现形式。
.5 业务算法和流程
从业务角度详细描述根据输入数据产生输出数据的业务算法和流程。
.6 数据设计
给出本程序中的局部数据结构说明, 包括数据结构名称, 功能说明,具体数据结构说明(定义、注释设计、取值)等。相关数据库表,数据存储设计(具体说明需要以文件方式保存的数据文件名、
文档评论(0)