软件开发技术手册.doc

软件开发技术手册 软件开发技术手册 软件开发技术手册 软件开发技术手册 <XXXXX软件 > 作者： XXX 版本号： x.xx 宣布时间： 200x-xx-xx 文档编号 软件名称 软件简介 相关系统 参加人员 金安技术版权所有 严禁在金安公司以外公开或使用 ! 版本历史 版本号  作者  参加者  更正说明  日期 1.00 Damy  2004-06-5---27 一、软件介绍 1、介绍软件名称、实现主要功能。 2、本软件与整个系统中其他相关软件关系介绍。 软件名称 主要功能 在整个系统中与其他软件关系 ( 相关协议文档的说明 ) 比方： 软件名称 主要功能  AJ－M01 GIS软件（煤矿端） V1.0 a、地图的导入（ mapinfo 格式） b、图元增加，更正，删除 c、图元显示、操作、盘问 d、图层管理 e、用户管理 在整个系统中与其他软件关系  通信办理：对因地图操作而生成的特色向量的保存，管理，发送 等。 此软件是经过安全卫士程序，将地图特色向量数据传输到中心， 与安全卫士程序有通信协议。使用时需要安全卫士程序配合。 二、软件开发环境 名称 操作系统 版本 说明 名称 数据库 版本 说明 名称 开发语言 版本 说明 名称 使用控件 版本 说明 引用要点算法 名称 版本 备注 1、软件开发平台 : 详细说明软件开发所用操作系统、数据库等版本。 2、使用开发语言以及版本。 3、使用相关控件名称、版本（如组件、 DLL等）。 4、软件中引用要点算法说明。 比方： 名称 Win2000 操作系统 版本 Win2000 professional+SP4 说明 软件在 win2000 开发，可运行于 win2000\XP 系统 名称 SQL Server 数据库 版本 Professional 2000 说明 -- 名称 Delphi 开发语言 版本 6.0+SP2 说明 名称 GISDLL.dll 使用控件 1 版本 V1.0 、 说明 GIS 开发平台 名称 REGDLL.dll 使用控件 2 版本 V1.0 说明 软件注册控件 引用要点算法 名称 -- 版本 备注 三、软件框架与流程 1、软件框架结构描述。 2、软件主要流程图。 3、软件使用通信协议、接口、数据库（表）方面详细说明。 比方： 1、软件框架结构图 Mapinfo 格式地图 地图数据转入功能模块： 地图文件 1 、将 Mapinfo 格式地图导入到 GIS自己格式文件中，同 时将图中对象相关的其属性存放到当地数据库中。 （煤矿地图要严格依照地图制作规范进行绘制，同一煤 用户管理模块： 矿只生产一个图，每一层导入到该图的相应图层） 1、更正密码 2 、生产自己格式的地图文件，供程序调用。 2、新增用户 3、删除用户 （信息存库） 地图编写、更正功能模块（设定用户权限）： 1、可对地图中的点、线、面三大类对象进行地址、属 性、节点进行编写、更正，并保存到当地地图文件和数据 库中。 2、在地图上可增加点、线、面三类对象及对象属性数 数据库 据，保存到当地地图文件和数据库中。 3、对上面的编写、更正每一个对象产生的相关数据生成 一条特色向量，保存到特色向量文件中，供通信模块调 用。 特色向量保存在 当地数据库中 地图显示、操作、盘问功能模块：  安全卫士 数据终端 特色 返回确 向量包 定信息 通信办理功能模块： 、依照用户提交保存地图 （煤矿端－监控中心）操作 , 一次将多条特色向量进行组包，发送给安全卫士。 、收到正确返回后，除去特色向量待发列表中的已经传达过的特色向量，并将其移至历史列表。 、通信过程中的出错办理 1、显示全图、地图放大、减小、搬动、选择等； 功能 2、分层显示的功能，用户可选择显示 / 隐蔽相关图层。 3、各图层对象查找功能（主若是巷道层、工作面层、传 感器层、分站层），并闪烁提示用户。 煤矿端 GIS 功能模块和数据流程图 2、主要流程图 （略） 3、详细通信协议见远程监系统中总协议中煤矿端 GIS 与安全卫士部分。 四、要点函数与功能说明 ( 一 ) 、软件要点函数（自定义、系统、引用） 、窗体事件、模块储藏过程等的列表。 要点函数或算法请写出流程图或用伪代码描述。 编号 函数名称 功能描述 参数说明 返回值 备注 1 2 3 4 5 函数 1： 流程或算法。 函数 2： 流程或算法。 比方 : 1、函数列表 序 函数名称 功能描述 号 1 GetCoalFromDBToArr 从数据库取煤矿信 ay 息到数组中 GetSensorFromDBTo 从数据库取传感器 2 信息到数组中 Array GetSensorTypeArrayFr 从数据库取传感器 3 种类到数组中 omDB 从地图文件中取地 4 Get