软件开发技术手册
作者：XXX 版本号：
x.xx 发布时间：200x-
xx-xx
金安技术版权所有
严禁在金安公司以外公开或使用
版本历史
、软件介绍
1、介绍软件名称、实现主要功能。
软件名称
主要功能
在整个系统中与其它软件关系
（相关协议文档的说明）
软件名称AJ－M01 GIS 软件（煤矿端）V1.0
主要功能
a、地图的导入（mapinfo 格式）
b、图元添加，修改，删除
c、图元显
示、操作、查询
d、图层管理
e、用户管理通信处理：对因地图操作而生成的特征向量的保存，管理，
发送等。
在整个系统中与其它软件关系此软件是通过安全卫士程序，将地图特征向量数据传输到中心，与安全卫士程序有通信协议。使用时需要安全卫士程序配合。
操作系统名称版本说明
数据库名称版本说明
开发语言名称版本说明
使用控件名称版本说明
引用关键算法名称
版本
备注
1 、软件开发平台:详细说明软件开发所用操作系统、数据库等版本。
、软件开发环境
2、使用开发语言以及版本。
3、使用相关控件名称、版本（如组件、
DLL 等）。
4、软件中引用关键算法说明。
三、软件框架与流程
1、软件框架结构描述。
2、软件主要流程图。
3、软件使用通信协议、接口、数据库（表）方面详细说明。
例如：
1、软件框架结构图
2、主要流程图
（略）
3、详细通信协议见远程监系统中总协议中煤矿端 GIS 与安全卫士部分
四、关键函数与功能说明
（一 ）、软件关键函数（自定义、系统、引用） 、窗体事件、模块存储过程等的列表。 关键函数或算法请写出流程
图或用伪代码描述。
编号
函数名称
功能描述
参数说明
返回值
备注
1
2
3
4
5
函数 1 ： 流程或算法。 函数 2 ： 流程或算法。 例如:
1、函数列表
Mapinfo
格式地图
安全卫士 数据终端
数据库
特征向量保存在 本地数据库中
特征 向量包 返回确 定信息
通信处理功能模块：
1、根据用户提交保存地图
（煤矿端－监控中心）操 作, 一次将多条特征向量进 行组包，发送给安全卫 士。
2、收到正确返回后，清除 特征向量待发列表中的已 经传送过的特征向量，并 将其移至历史列表。
3、通信过程中的出错处理 功能
煤矿端 GIS 功能模块和数据流程图
地图文件
用户管理模块： 1、修改密码 2、新增用户 3、删除用户 （信息存库）
2、函数的算法描述（流程图或伪代码描述）函数4 ：GetMapArray （）
5 打开地图文件。
10 设置地图数量变量n。
15 读取地图文件中地图数量保存到n 中。
20 设置MapArray 数组长度为n 。
25 再读取地图文件，将各地图信息存到MapArray 数组中30 关闭地图文件。（二）、软件主要功能列表