软件开发文档-详细设计文档

引言

引言也称前言、序言或概述经常作为科技论文的开端,提出文中要研究的问题,引导读者阅读和理解全文


编写目的

帮助开发人员理解项目的业务逻辑


术语描述


执行标准与相关文档

编码标准,文件管理标准,版本管理标准


项目概述

1、背景
2、现状

项目目标

最终要实现的目标

编码规范

前端规范,后台规范,数据库规范,中间件使用规范


系统功能概述

系统功能总图

系统总体介绍

描述下系统的总体情况

系统模块设计

模块结构图,模块汇总表,功能简述


模块功能点

【功能描述:说明该程序应具有的功能,功能结构图,原型界面,可采用IPO图(即输入一处理一输出图),类图,用例图等。】

1、输入项

【给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。】

2、输出项

【给出对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。】

3、算法

【详细说明本程序所选用的算法,具体的计算公式和计算步骤。】

4、逻辑流程

【用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。】

5、接口

【用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构。】

6、存储分配

【根据需要,说明本程序的存储分配。】

7、注释设计

【说明准备在本程序中安排的注释,如:

a. 加在模块首部的注释;

b. 加在各分枝点处的注释;

c. 对各变量的功能、范围、缺省条件等所加的注释;

d. 对使用的逻辑所加的注释等等。】

8、限制条件

【说明本程序运行中所受到的限制条件】

9、测试计划

【说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定】

猜你喜欢

转载自blog.csdn.net/u012869196/article/details/73694827