详细设计说明书(模板)

东软机密

文件编号：D05-PDT073

详细设计说明书模板

版本：0.0.0-1.2.0

2009-6-30

东软集团股份有限公司 软件开发事业部

(版权所有，翻版必究)

文件修改控制

东软机密

文件编号：项目编号DDR顺序号 第 版 分册名称： 第 册/共 册

项目名称（项目编号） 详细设计说明书

(软件开发事业部)

东软集团股份有限公司

修改记录

目 录

1引言 ........................................................................ 1

1.1 目的 ............................................................................... 1 1.2 背景 ............................................................................... 1 1.3 词汇表 ............................................................................. 1 1.4 参考资料 ........................................................................... 1 2系统结构 .................................................................... 1 2.1 需求概述 ........................................................................... 1 2.2 总体设计 ........................................................................... 2 3.系统详细设计说明 ............................................................ 2 3.1 包及类结构设计 ..................................................................... 2 3.2 模块设计 ........................................................................... 2 3.3 Message文件管理Module ............................................................. 2 3.4 LOG管理Module ..................................................................... 2 3.5 配置文件管理Module ................................................................. 2 3.6 异常模块说明 ....................................................................... 3 4.其他设计要求 ................................................................ 3 4.1 单元测试 ........................................................................... 3 4.2 注释及代码风格 ..................................................................... 3 4.3 尚未解决问题 ....................................................................... 3

5附件说明 .................................................................... 3

编写指南：

本模板力图给出软件详细设计阶段可能包括的基本信息。如果某个章节在项目或当前阶段中无法描述，则可保留其标题，注明“不适用”；如果需要对本模板的个别章节详细描述，也可将其形成单独的文档，成为本文档附件。

若文档中的某个章节已经在其他项目文档中加以描述，可保留标题，注明“参见（文档编号）（文档名称）（条款）”。

形成正式文档后须删除斜体字内容。

1引言

1.1目的

说明编写这份详细设计说明书的目的，指出预期的读者。

1.2背景

叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。

1.3词汇表

列出本软件详细设计中专门术语的定义、英文缩写词的原词组和意义、项目组内达成一致意见的专用词汇，同时要求继承全部的先前过程中定义过的词汇，一般不包括需求或概要设计中已经定义的部分，通过参见方式表示其他地方定义内容。

1.4参考资料

列出编写本报告时参考的文件、资料、技术标准以及他们的作者、标题、编号、出版日期和出版单位。

列出编写本报告时查阅的Internet上杂志、专业著作、技术标准以及其网址。

2系统结构

2.1 需求概述

引用需求规格说明书中系统软件概述部分内容

2.2 总体设计

该系统的目的，该系统的用途，功能。对系统的业务概要性叙述，并对系统的扩展性及重用性要求

进行描述。提供系统使用的技术路线，包括使用2次开发平台、系统重用组件内容、应用框架等。可配合概要设计进行描述。

提供系统架构设计，对于使用Rose、Visio等UML工具编制内容，同时可以将关键或外部接口类图及说明贴入并附以简单描述，具体内容描述可以直接提出参见UML文档的“XXX模块”内容。

可引用系统概要设计报告内容进行描述

3.系统详细设计说明

3.1 包及类结构设计

参见UML设计图中“logic View/DD/Layer”包中说明

3.2 模块设计

参见UML设计图中“logic View/DD/ Use-Case Realizations”包中说明

3.3 Message文件管理Module

有指导意义的说明，开发人员进行细化，有系统信息提示处理要求的系统可在此处对系统提示信息和关键内容进行定义（可选）

3.4 LOG管理Module

可在此处定义系统日志的记录方法和文件格式要求（可选，功能日志通过需求提出）

3.5 配置文件管理Module

列举系统的可配置内容，并指定系统配置文件格式及相关处理机制，例如：使用XX组件进行文件解析，配置文件的文件类型等等。（可选）

对配置文件内容的浏览（表格）

3.6 异常模块说明

定义系统异常处理机制，一般分为系统级异常处理要求和业务类异常处理要求，并指定处理异常后的相应业务需求和处理方法，针对不同的框架结构提出可实现的异常处理办法，可在UML图中对系统异常处理详细描述。

4.其他设计要求

4.1单元测试

在用户无特殊规定时，可使用部门统一约束要求（可选）。 在用户无特殊规定时，可使用部门统一约束要求（可选）。 列举出本设计中无法解决或处于待定阶段的问题及对策。

4.2 注释及代码风格 4.3 尚未解决问题

5附件说明

为了理解设计思想而提供的相关资料文档说明及UML详细设计说明。