软件详细设计文档模板概要.docVIP

湖北文理学院文档编号版本 A1 密级商密 A 项目名称系统 项目根源 Xxx 系统 详尽设计说明书 编写 :日期 :检查 :日期 :审核 :日期 :批准 :日期 : 湖北文理学院 版权所有不得复制 文档变更记录 序号变更 (+/-说明作者版本号日期批准 1 2 目录 1.引言 (4 1.1 编写目的和范围 (4 1.2 术语表 (4 1.3 参照资料 (4 1.4 使用的文字办理和画图工具 (4 2.全局数据构造说明 (4 2.1 常量 (5 2.2 变量 (5 2.3 数据构造 (5 3.模块设计 (5 3.1 用例图 (5 3.2 功能设计说明 (5 模块 1 (5 模块 2 (6 4.接口设计 (7 4.1 内部接口 (7 4.2 外部接口 (7 接口说明 (7 调用方式 (7 5.数据库设计 (7 6.系统安全保密设计 (8 6.1 说明 (8 6.2 设计 (8 数据传输部分 (8 过滤分部 (8 身份考证部分 (8 7.系统性能设计 (8 8.系统出错办理 (8 1.1 编写目的和范围 说明写这份详尽设计说明书的目的。 本详尽设计说明书编写的目的是说明程序模块的设计考虑 ,包括程序描绘、输 入 /输出、算法和流程逻辑等 ,为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.2 术语表 1.3 参照资料 列出有关资料的名称、作者、文件编号或版本等。参照资料包括 : a.需求说明书、架构设计说明书等 ; b.本项目的其他已发表的文件 ; 1.4 使用的文字办理和画图工具 文字办理软件 :[ 编写设计文档使用的文字办理软件 ,如 RedOffice] 画图工具 :[ 使用的 UML 工具 ,如 Rose、Jude、 Visio] 2.全局数据构造说明 本章说明本程序系统中使用的全局数据常量、变量和数据构造。 包括数据文件名称及其所在目录 ,功能说明 ,详细常量说明等。 2.2 变量 本章说明本程序系统中使用的全局数据常量、变量和数据构造。 2.3 数据构造 包括数据构造名称 ,功能说明 ,详细数据构造说明 (定义、说明、取值等。 3.模块设计 3.1 用例图 3.2 功能设计说明 模块 1 模块 1 主要分为以下几个子模块 :子模块 1、子模块 2 和子模块 N。 子模块 1 设计图 功能描绘 简要描绘子模块 1 的业务功能。 输入数据 详尽描绘用户输入的数据 (包括任何输入设施以及这些数据的有效性查验规 则。 详尽描绘从物理模型中的哪些表获取数据以及获取这些数据的条件。 输出数据 详尽描绘子功能 1 所产生的数据以及这些数据的表现形式。 业务算法和流程 从业务角度详尽描绘根据输入数据产生输出数据的业务算法和流程。 数据设计 给出本程序中的局部数据构造说明，包括数据构造名称，功能说明，详细数据构造说明（定义、 说明设计、取值）等。有关数据库表，数据 存储设计（详细说明需要以文件方式保留的数据文件名、 数据存储格式、数据项及属性等。 ）源程序言件说明 给出本程序的各源程序言件的说明，包括源程序言件名称及其所在目录，功能说明，包含的前 导文件及函数名称等。 函数说明 详细说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参数，全局变量， 局部变量，返回值，算法说明，使用拘束等。 限制条件其他说明模块 2 模块 1 主要分为以下几个子模 块：子模块 1、子模块 2 和子模块 N。子模块设计图功能描绘 简要描绘子模块 1 的业务功能。输入数据 详尽描绘用户输入的数 据 (包括任何输入设施以及这些数据的有效性查验规则。 详尽描绘从物理模型中的哪些表获取数据以及获取这些数据的条件。输出数据 详尽描绘子功能 1 所产生的数据以及这些数据的表现形式。业务算法和流程 从业务角度详 细描绘根据输入数据产生输出数据的业务算法和流程。数据设计 给出本程序中的局部数据构造说明，包括数据构造名称，功能说明，详细数据构造说明 （定义、 说明设计、取值）等。有关数据库表，数据存储设计（详细说明需要以文件方式保留的数据文件名、 数据存储格式、数据项及属性等。 ） 源程序言件说明 给出本程序的各源程序言件的说明，包括源程序言件名称及其所在目录，功能说明，包含的前 导文件及函数名称等。函数说明 详细说明本程序中的各个函数，包括函数名称及其所在文件，功能，格式，参 数，全局变量， 局部变量，返回值，算法说明，使用拘束等。 限制条件 其他说明 4. 接口设计 4.1 内部接口 4.2 外部接口接口说明 比如： xx 子系统通过 xx 从 xx 子系统取得 xx 等，有关标准，调用示例，可根据需要增加章节 描绘接口。调用方式 比如：内部接口调用： 例: /** * 通过用户服务