软件开发技术手册
VXXXX）软
件>
作者：XXX 版本号：X.XX 发布时间：200X-XX-XX
金安技术版权所有
严禁在金安公司以外公开或使用！
版本历史
、软件介绍
1、介绍软件名称、实现主要功能。

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

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

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

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

例如:
三、软件框架与流程
1、软件框架结构描述。

2、软件主要流程图。

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

例如：
1、软件框架结构图
Ma pinfo / 格式地图
/
地图编辑、修改功能模块（设定用户权限）：
2、主要流程图
（略）
3、详细通信协议见远程监系统中总协议中煤矿端 GIS 与安全卫士部分。

四、关键函数与功能说明
（一）、软件关键函数（自定义、系统、弓I 用） 关
键函数或算法请写出流程图或用伪代码描述。

函数1：
流程或算法。

函数2：
流程或算法。

例如: 1、函数列表
地图数据转入功能模块:
地图文件
特征 向量包
返回确 定信息
用户管理模块:
1、 修改密码
2、 新增用户
3、 删除用户 （信息存库）
1、 可对地图中的点、线、面三大类对象进行位置、属 性、节点进行编辑、修改，并保存到本地地图文件和数据 库中。

2、 在地图上可增加点、线、面三类对象及对象属性数 据，保存到本地地图文件和数据库中。

3、 对上面的编辑、修改每一个对象产生的相关数据生成 一条特征向量，保存到特征向量文件中，供通信模块调 用。

I-
I
通信处理功能模块:
地图显示、操作、查询功能模块:
1、 显示全图、地图放大、缩小、移动、选择等；
2、 分层显示的功能，用户可选择显示 /隐藏相关图层
3、 各图层对象查找功能（主要是巷道层、工作面层、传 感器层、分站层），并闪烁提示用户。

X
特征向量保存在
亠本地数据库中
■ ~~
煤矿端GIS 功能模块和数据流程图
、窗体事件、模块存储过程等的列表。

2、函数的算法描述（流程图或伪代码描述） 函数 4: GetMapArray （） 打开地图文件。

设置地图数量变量n 。

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

设置MapArray 数组长度为n 。

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

关闭地图文件。

（二）、软件主要功能列表
功能：
流程或算法描述。

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

5 10 15 20 25 30
例如：
2、功能列表
序号功能功能描述使用函数、窗体、存储过程、数据库
表、文件等
备注
1 发送特征
向量
（煤矿端）
煤矿端GIS向数据交换
程序发送特征向量
在主窗中实现，米用TCP /IP方式。

用
到数据库SenderList表，
createlD,objlD,CreateTime,data 字
段。

2 取井下系
统
配置数据
煤矿端GIS向数据交换
程序请求井下监控系统
配置数据。

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

用
到数据库configsensor。

Sen sorID 、Sen sorT ype 、
SubStationDesc、Position 字段。

用到
ParseReceiveText 函数。

3 配置数
据处理
处理井下监控系统配置
数据包
StoreSensorCfg、AddSensorCfg
功能流程：
功能1：发送特征向量
流程2:取井下系统配置数据
I结束
流程3:配置数据处理
〔开始;
■\ ______________________________ .
T
按协i义解
也
紂创数据彌
分
花数据祁莎宦位
-种分隔符的位
世
曲S模拟锻打肝关陕-. 于
C令隔符的偵-艸析肚否＜f-＞—
—- ----- t&yjiwn据”
四、软件产品说明
慣诃揆損肝融舉为宇，
从数据部彷楼取开关皤竽
救抓
♦汕别处理模拟吊.开关邸数抓
＜T
结束
1、对归档程序说明软件产品名称，以及使用到相关配置文件参数等说明。

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

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

3、软件项目文件说明：各单元文件（类）之间关系，说明各单元文件功能
4、软件开发环境配置说明。

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

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

3、软件为Delphi6.0开发，工程文件在归档程序目录下，名称为CoalEditGlS.dpr,主要包含单元文件35个，如下表：
4、软件开发环境配置说明：
程序开发环境安装，在windows2000 professional系统下，先安装Delphi6.0+SP2，再安装MS SQL server2000,再根据安装手册中数据安装部分，将数据库进行还原，再启动Delphi6.0 打开软件归档目录中工程文件，C o a l E d i t G I S.d p r。

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