详细设计说明书模版

{公司名＋项目名} 详细设计说明书

当前版本： 发布日期：

摘要

简要描述该文档的内容。

{公司名＋项目名}详细设计说明书

修改历史

日期 版本 作者 修改内容

{公司名＋项目名}详细设计说明书

目录 1 2 3 4 5

概述 ............................................................................................................................ 4 结构图 ........................................................................................................................ 4 数据结构 .................................................................................................................... 4 功能模块详细描述 .................................................................................................... 4 需求以及设计跟踪表 ................................................................................................ 4

{公司名＋项目名}详细设计说明书

1 概述

本章描述详细设计将实现的内容，以及受影响的子系统。假如用了软件图形工具，本章必须包含完整的软件图形模块目录的路径名。

2 结构图

软件系统功能模块的图形描述，它可以让读者对功能模块有一个全面的了解。同时，它也提供了一个有用的索引及一个有意义的调试和维护指南。

数据必须显示在结构图中，同时，流程线应指明模块访问存储区的目的（读、写或修改）。

必须解释所有的用符号表示的内容（包括模块、参数和数据存储区等）。

3 数据结构

• • •

如果某一数据类型由其它的数据类型组成，要保持信息上的一致性。 如果使用一特殊结构，请指明使用原因或优于其它结构的方面。 在选择一个有效的结构时，要考虑以下几个方面：

-- 在目标上执行的操作类型 -- 访问目标的类型和频度 -- 结构的有效性

4 功能模块详细描述

首先请简要介绍模块的目的。可以用以下格式描述功能模块的详细设计：

• • • • • • • • • • •

模块名称 主要功能描述

模块的输入参数的名称、数据类型、顺序位置、格式等

模块的输出参数的名称、数据类型、顺序位置、格式，以及错误标记等 过程和功能调用

数据引用（全局，本地，结构）

模块的处理流程（采用流程图、判定表辅以必要的说明来表示逻辑流程）

模块的界面设计（可以采用图片和表格的形式，具体内容包括：界面格式；界面要素的位置、类型和特殊约定；操作及步骤等必要的说明）

接口（用图的形式说明本程序所隶属的上一层模块及隶属本模块的下一层模块，说明参数赋值和调用方式，说明与本程序直接关联的数据结构） 限制条件（说明本模块运行所受到的限制条件） 伪代码

5 需求以及设计跟踪表

详细设计章节 概要设计章节 软件功能说明书中的需求号