软件开发技术手册

软件开发技术手册

XXX 版本号： 发布时间：200x-xx-xx

文档编号 软件名称 软件简介 相关系统 参与人员

金安技术版权所有

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

版本历史

版本号

作者 Damy 参与者 修改说明 日期 2004-06-5---27 一、软件介绍

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

2、本软件与整个系统中其它相关软件关系介绍。 软件名称 主要功能 在整个系统中与其它软件关系 (相关协议文档的说明)

例如： 软件名称 主要功能 AJ－M01 GIS软件〔煤矿端〕 a、地图的导入〔mapinfo格式〕 b、图元添加，修改，删除 c、图元显示、操作、查询 d、图层管理 e、用户管理 通信处理：对因地图操作而生成的特征向量的保存，管理，发送等。 在整个系统中与其它软此软件是通过平安卫士程序，将地图特征向量数据传输到中心，件关系 与平安卫士程序有通信协议。使用时需要平安卫士程序配合。 二、软件开发环境

名称 操作系统 版本 说明 名称 数据库 版本 说明 名称 开发语言 版本 说明 名称 使用控件 版本 说明 引用关键算法 名称 备注 版本

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

3、使用相关控件名称、版本〔如组件、DLL等〕。 4、软件中引用关键算法说明。

例如： 名称 操作系统 版本 说明 名称 数据库 版本 说明 名称 开发语言 版本 说明 名称 使用控件1 版本 说明 名称 使用控件2 引用关键算法 备注

版本 说明 名称 版本 Win2000 Win2000 professional+SP4 软件在win2000开发，可运行于win2000\\XP系统 SQL Server Professional 2000 -- Delphi 6.0+SP2 V1.0、 GIS开发平台 软件注册控件 -- 三、软件框架与流程

1、软件框架构造描述。 2、软件主要流程图。

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

例如： 1、软件框架构造图 Mapinfo格式地图安全卫士数据终端地图数据转入功能模块：1、将Mapinfo格式地图导入到GIS自己格式文件中，同时将图中对象相关的其属性存放到本地数据库中。（煤矿地图要严格按照地图制作规范进行绘制，同一煤矿只生产一个图，每一层导入到该图的相应图层）2、生产自己格式的地图文件，供程序调用。地图文件特征向量包返回确定信息用户管理模块：1、修改密码2、新增用户3、删除用户（信息存库）地图编辑、修改功能模块（设定用户权限）：1、可对地图中的点、线、面三大类对象进行位置、属性、节点进行编辑、修改，并保存到本地地图文件和数据库中。2、在地图上可增加点、线、面三类对象及对象属性数据，保存到本地地图文件和数据库中。3、对上面的编辑、修改每一个对象产生的相关数据生成一条特征向量，保存到特征向量文件中，供通信模块调用。通信处理功能模块：数据库1、根据用户提交保存地图（煤矿端－监控中心）操作,一次将多条特征向量进行组包，发送给安全卫士。2、收到正确返回后，清除特征向量待发列表中的已经传送过的特征向量，并将其移至历史列表。3、通信过程中的出错处理功能特征向量保存在本地数据库中地图显示、操作、查询功能模块：1、显示全图、地图放大、缩小、移动、选择等；2、分层显示的功能，用户可选择显示/隐藏相关图层。3、各图层对象查找功能（主要是巷道层、工作面层、传感器层、分站层），并闪烁提示用户。煤矿端GIS功能模块和数据流程图

2、主要流程图 〔略〕

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

四、关键函数与功能说明

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

关键函数或算法请写出流程图或用伪代码描述。 编号 1 2 3 4 5 函数名称 功能描述 参数说明 返回值 备注

函数1：

流程或算法。 函数2：

流程或算法。

例如: 1、函数列表 序号 1 函数名称 GetCoalFromDBToArray GetSensorFromDBToArray GetSensorTypeArrayFromDB 功能描述 从数据库取煤矿信息到数组中 从数据库取传感器信息到数组中 从数据库取传感器类型到数组中 从地图文件中取地图信息到MapArray数组 根据传感器状态数据，判断传感器状态 刷新传感器状态 参数描述 (ADOQuery: TADOQuery; var CoalArray: TCoalArray) (ADOQuery: TADOQuery; var SensorArray: TSensorArray) (ADOQuery: TADOQuery; Var SensorTypeArray: TSensorTypeArray) 无参数 返回值 正常返回真 Boolean类型，正常返回真 Boolean类型，正常返回真 过程 无返回值 过程 无返回值 过程 无返回值 其他 2 3 4 GetMapArray * (Status:String;i:integer) 5 CheckSensorStatus 6 RefreshSensorStatus (CoalID:string) 2、函数的算法描述〔流程图或伪代码描述〕 函数4： GetMapArray ( )

5 翻开地图文件。

10 设置地图数量变量n。

15 读取地图文件中地图数量保存到n中。 20 设置MapArray数组长度为n。

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

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

关键功能的流程要写出流程图或用伪代码描述。 序号 1 2 3 4 5 功能 功能描述

使用函数、窗体、存储过程、数据库表、文件等 备注

功能1：

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

流程或算法描述。

例如：

2、功能列表

序号 功能 1 功能描述 发送特煤矿端GIS向数据交征向量 换程序发送特征向量 (煤矿端) 取井下煤矿端GIS向数据交系统 换程序请求井下监控配置数系统配置数据。 据 配置数处理井下监控系统配据处理 置数据包 2 3

使用函数、窗体、存储过程、数据库表、文件等 在主窗中实现，采用TCP/IP方式。 用到数据库SenderList表，createID,objID,CreateTime,data字段。 在主窗中实现，采用TCP/IP方式。 用到数据库configsensor。 SensorID、SensorType、SubStationDesc、Position字段。用到ParseReceiveText函数。 StoreSensorCfg、AddSensorCfg 备注 功能流程：

功能1: 发送特征向量

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

流程3: 配置数据处理

四、软件产品说明

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

需要进展注册或安装数据库等环境的要进展详细说明，或指出参考文档。 3、软件工程文件说明：各单元文件〔类〕之间关系，说明各单元文件功能. 4、软件开发环境配置说明。

例如：

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

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

3、软件为Delphi6.0开发，工程文件在归档程序目录下，名称为CoalEditGIS.dpr,主要包含单元文件35个，如下表： 序号 1 2 3 4 5 6 ….. 35 名称 Main Login EditSensor EditLine Funproc structunit ….. WriteTxt 主要功能 主窗体 登陆窗体 传感器编辑窗体 线类对象编辑窗体 自定义函数单元文件 自定义构造单元文件 ….. 备注 含.pas、.dfm文件 含.pas、.dfm文件 含.pas、.dfm文件 含.pas、.dfm文件 … 记录信息到文本 4、软件开发环境配置说明： 程序开发环境安装，在windows2000 professional系统下，先安装Delphi6.0+SP2，再安装MS SQL server2000,再根据安装手册中数据安装局部，将数据库进展复原，再启动Delphi6.0翻开软件归档目录中工程文件，CoalEditGIS.dpr。

五、软件存在缺陷及建议

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

略