详细设计说明书的框架

一个典型的详细设计说明书的框架如下所示:

1、引言

1.1、编写目的

说明编写详细说明书的目的,并说明所面向的读者对象。

1.2、项目背景

包括项目的来源和主管部门等。

1.3、定义

列出文档中所用的专门术语的定义和缩写词的原意。

1.4、参考资料

类出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。它可包括:项目计划任务书、合同或批文、项目开发计划、需求规格说明书、总体设计说明书、测试计划、用户操作手册、文档中所引用的其他资料、软件开发标准或规范。

2、总体设计

2.1、需求概述

2.2、软件结构

给出软件系统的结构图

3、程序描述

对每个模块给出以下说明:

3.1、功能

3.2、输入项目

3.3、输出项目

3.4、算法

给出模块所选用的算法

3.6、程序逻辑

详细描述模块实现的算法

3.7、接口

3.8、存储分配

3.9、限制条件

3.10、测试要点

给出测试模块的主要测试要求。

 

 

你可能感兴趣的:(设计文档,框架,测试,算法,文档,出版,任务)