软件开发技术手册范本

软件开发技术手册

作者：XXX

版本号：x.xx

发布时间：200x-xx-xx

金安技术版权所有

严禁在金安公司以外公开或使用!

版本历史

一、软件介绍

1、介绍软件名称、实现主要功能。

二、软件开发环境

1、软件开发平台: 详细说明软件开发所用操作系统、数据库等版本。

2、使用开发语言以及版本。

3、使用相关控件名称、版本（如组件、DLL等）。

4、软件中引用关键算法说明。

例如：

三、软件框架与流程

1、软件框架结构描述。

2、软件主要流程图。

3、软件使用通信协议、接口、数据库（表）方面详细说明。

例如：

1、软件框架结构图

2、主要流程图

（略）

3、详细通信协议见远程监系统中总协议中煤矿端GIS与安全卫士部分。

四、关键函数与功能说明

(一)、软件关键函数（自定义、系统、引用）、窗体事件、模块存储过程等的列表。

关键函数或算法请写出流程图或用伪代码描述。

函数1：

流程或算法。

函数2：

流程或算法。

例如:

1、函数列表

2、函数的算法描述（流程图或伪代码描述）

函数4：GetMapArray ( )

5 打开地图文件。

10 设置地图数量变量n。

15 读取地图文件中地图数量保存到n中。

20 设置MapArray数组长度为n。

25 再读取地图文件，将各地图信息存到MapArray数组中。

30 关闭地图文件。

(二)、软件主要功能列表

功能1：

流程或算法描述。功能2：

流程或算法描述。例如：

2、功能列表

序号功能功能描述使用函数、窗体、存储过程、数据

库表、文件等

备注

1 发送特

征向量

(煤矿端)

煤矿端GIS向数据交

换程序发送特征向量

在主窗中实现，采用TCP/IP方式。

用到数据库SenderList表，

createID,objID,CreateTime,data

字段。

2 取井下

系统

配置数

据

煤矿端GIS向数据交

换程序请求井下监控

系统配置数据。

在主窗中实现，采用TCP/IP方式。

用到数据库configsensor。

SensorID、SensorType、

SubStationDesc、Position字段。

用到ParseReceiveText函数。

3 配置数

据处理

处理井下监控系统配

置数据包

StoreSensorCfg、AddSensorCfg

功能流程：

功能1: 发送特征向量

流程2: 取井下系统配置数据

流程3: 配置数据处理

四、软件产品说明

1、对归档程序说明软件产品名称，以及使用到相关配置文件参数等说明。

2、软件如何进行安装、参数配置、使用。

需要进行注册或安装数据库等环境的要进行详细说明，或指出参考文档。

3、软件项目文件说明：各单元文件（类）之间关系，说明各单元文件功能.

4、软件开发环境配置说明。

例如：

1、煤矿端GIS软件名称如：CoalEditGIS.exe，使用到GIS.ini配置文件和GIS.UDL 数据连接文件，另外使用到两种自定义字体。

2、软件安装、参数配置、使用请参考此软件安装使用说明手册。

3、软件为Delphi6.0开发，工程文件在归档程序目录下，名称为CoalEditGIS.dpr,

程序开发环境安装，在windows2000 professional系统下，先安装Delphi6.0+SP2，再安装MS SQL server2000,再根据安装手册中数据安装部分，将数据库进行还原，再启动Delphi6.0打开软件归档目录中工程文件，CoalEditGIS.dpr。

五、软件存在缺陷及建议

开发人员认为软件在各方面存在缺陷说明，以及建议。

略