软件详细设计文档模板

项目编号：

（项目名称）

软件详细设计报告

同方锐安科技有限公司

目录

1. 引言 ............................................................................................................................................. 1 1.1 编写目的 ............................................................................................................................... 1 1.2 项目风险 ............................................................................................................................... 1 1.3 文档约定 ............................................................................................................................... 1 1.4 预期读者和阅读建议 ........................................................................................................... 1 1.5 参考资料 ............................................................................................................................... 2 2. 支撑环境 ..................................................................................................................................... 2 2.1 数据库管理系统 ................................................................................................................... 2 2.2 开发工具、中间件以及数据库接口 .................................................................................... 2 2.3 硬件环境 ............................................................................................................................... 2 2.4 网络环境 ............................................................................................................................... 3 2.5 多种支撑环境开发要点 ....................................................................................................... 3 3. 部件详细设计 ............................................................................................................................. 4 4. 词汇表 ......................................................................................................................................... 5 5. 部件表格式 ................................................................................................................................. 5 6. 界面表格式 ................................................................................................................................. 6

1. 引言

引言是对这份软件系统详细设计报告的概览，是为了帮助阅读者了解这份文档如何编写的，并且应该如何阅读、理解和解释这份文档。

1.1 编写目的

说明这份软件系统详细设计报告是基于哪份软件产品需求分析报告、哪份软件产品概要设计报告和哪份软件产品数据库设计说明书(如果该软件产品需要数据库支持)编写的，开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统详细设计报告详尽说明了该软件产品的编码结构，从而对该软件产品的物理组成进行准确的描述。

1.2 项目风险

具体说明本软件开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风险，首要风险承担者包括：

● 任务提出者； ● 软件开发者； ● 产品使用者。

1.3 文档约定

描述编写文档时所采用的标准(如果有标准的话)，或者各种编写约定。 编写约定包括：

● 部件编号方式； ● 界面编号方式； ● 命名规范： ●

1.4 预期读者和阅读建议

列举本软件系统详细设计报告所针对的各种不同的预期读者，描述文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档阅读建议。 读者包括：

● 开发人员； ● 项目经理； ● 测试人员； ● 文档编写人员； ●

1.5 参考资料

列举编写软件系统详细设计报告时所用到的参考文献及资料

● 在此输入 ●

2. 支撑环境

2.1 数据库管理系统

描述数据库管理系统、以及安装配置情况 ● 产品名称以及发行厂商： ● 版本号： ● 补丁包版本号： ● 语言或代码集： ● 安装位置： ● 配置参数： ●

2.2 开发工具、中间件以及数据库接口

描述所选用的工具软件和中间件的名称、版本号，以及开发工具与数据库或者中间件接口的情况。如果使用了多种开发工具、辅助开发工具、第三方软件部件、多种中间件、多种接口、等答应该逐项分别描述，并且说明每一项的适用范围

● 产品名称以及发行厂商： ● 版本号： ● 补丁包版本号： ● 语言或代码集： ● 数据库接口名称： ● 数据库接口方式： ● 数据库接口设置：

2.3 硬件环境

描述所选用的硬件环境，各种机型，例如：服务器、工作站，应该分别描述。 ● 机型； ● 主频； ● 内存容量； ● 磁盘容量； ● 特殊部件；

● 操作系统； ● 使用位置； ● 等等。

2.4 网络环境

描述可能影响应用软件访问数据库的各种网络环境，如果存在加密传输、VPN链路等情况，也必须描述。对于结构复杂的网络，还应该提供网络拓扑图和数据流向示意图。

● 网络结构； ● 网络操作系统； ● 网络带宽； ● 路由组织； ● 加密传输方式； ● VPN链路连接方式； ●

2.5 多种支撑环境开发要点

当软件产品将来可能遇到的多种运行环境时，应该分别按照3.1节至3.4节的内容列表描述。如果软件产品各个子系统的运行环境不完全一样时，应该分子系统按照3.1节至3.4节的内容列表描述。

3. 部件详细设计

● 部件编号： ● 部件名称： ● 所属子系统： ● 部件调用者： ● 部件被调用者： ● 部件入口参数： ● 部件出口参数： ● 算法： ● 流程描述： ● 部件表示形式：指该部件完成开发后的最终表示形式，具体形式取决于开发工具和

软件结构 ● 运行环境： ● 性能要求：指开发该部件时必须满足的专门要求

4. 词汇表

列出本文件中用到的专业术语的定义，以及有关缩写的定义(如有可能，列出相关的外文原词)。

5. 部件表格式

说明：如果软件不见使用一张表表述不完时，可以采用续表描述，但是必须注明是那张表的续表。6. 界面表格式

说明：如果软件不见使用一张表表述不完时，可以采用续表描述，但是必须注明是那张表的续表。