[模板] 软件详细设计说明书编写指南

xxxxxx项目

详细设计说明书编写指南

编写单位

详细设计说明书编写指南变更履历

目录

第一章前言 (4)

1.1编写目的 (4)

1.2文档内容 (4)

第二章详细设计说明书的编写要求 (5)

2.1引言 (5)

2.1.1 编写目的 (5)

2.1.2 背景 (5)

2.1.3 定义 (5)

2.1.4 参考资料 (5)

2.2子系统设计 (5)

第一章前言

1.1 编写目的

本文旨在指导项目建设单位和承建单位编写详细设计说明书，详细设计是软件工程中软件开发的一个步骤，是对概要设计的细化过程。由于各承建单位采用的设计方法不尽相同，本文档提出详细设计阶段必须完成的工作内容，但不限制采用的设计方法和对详细设计成果的展现形式，各承建单位可以根据实际情况自行确定描述方法和展现形式。本文中的示例仅供参考。

1.2 文档内容

本指南主要包含以下内容：

一、描述详细设计说明书的编写要求。

二、举例说明详细设计说明书的编写方法。

第二章详细设计说明书的编写要求

本章节主要描述详细设计说明书的编写要求。详细设计说明书需满足“2.1引言”章节的内容和格式要求；详细设计说明书需满足“2.2章节”的内容要求，不限制格式。

各项目建设单位和承建单位编写详细设计说明书要满足本章的内容要求，不限制格式。

2.1 引言

2.1.1 编写目的

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

2.1.2 背景

描述详细设计阶段的目标、作用范围以及其他应向读者说明的理解本文档所需的背景，如与公司其它软件之间的联系等。

2.1.3 定义

列出本文件中用到专门术语的定义、英文缩写词的原词组和意义、项目组内达成一致意见的专用词汇，同时要求继承全部的先前过程中定义过的词汇。

2.1.4 参考资料

列出有关的参考资料，如：

1、本项目的经核准的计划任务书或合同、上级机关的批文；

2、属于本项目的其他已发表的文件；

3、本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。

2.2 子系统设计

本章描述详细设计阶段对每个模块的设计，包括实现算法、局部数据结构等内容。各项目可根据采用的详细设计方法，以说清楚对每个模块的设计为目的，

自行选择文档的展现内容和方式。但必须说清楚以下内容：

1、功能描述

2、与概要设计的对应关系

3、功能的设计实现方式，包括算法设计，用户界面设计、数据结构设计等等。