精品最新软件开发技术手册.docx

精品最新软件开发技术手册.docx

《精品最新软件开发技术手册.docx》由会员分享，可在线阅读，更多相关《精品最新软件开发技术手册.docx（12页珍藏版）》请在冰点文库上搜索。

精品最新软件开发技术手册

最新软件开发技术手册

软件开发技术手册

作者：

XXX

版本号：

x.xx

发布时间：

200x-xx-xx

文档编号

软件名称

软件简介

相关系统

参与人员

金安技术版权所有

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

版本历史

版本号

作者

参与者

修改说明

日期

1.00

Damy

2004-06-5---27

一、软件介绍

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

2、本软件与整个系统中其它相关软件关系介绍。

软件名称

主要功能

在整个系统中与其它软件关系

（相关协议文档的说明）

例如：

软件名称

AJ－M01GIS软件（煤矿端）V1.0

主要功能

a、地图的导入（mapinfo格式）

b、图元添加，修改，删除

c、图元显示、操作、查询

d、图层管理

e、用户管理

通信处理：

对因地图操作而生成的特征向量的保存，管理，发送等。

在整个系统中与其它软件关系

此软件是通过安全卫士程序，将地图特征向量数据传输到中心，与安全卫士程序有通信协议。

使用时需要安全卫士程序配合。

二、软件开发环境

操作系统

名称

版本

说明

数据库

名称

版本

说明

开发语言

名称

版本

说明

使用控件

名称

版本

说明

引用关键算法

名称

版本

备注

1、软件开发平台:

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

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

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

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

例如：

操作系统

名称

Win2000

版本

Win2000professional+SP4

说明

软件在win2000开发，可运行于win2000\XP系统

数据库

名称

SQLServer

版本

Professional2000

说明

--

开发语言

名称

Delphi

版本

6.0+SP2

说明

使用控件1

名称

GISDLL.dll

版本

V1.0、

说明

GIS开发平台

使用控件2

名称

REGDLL.dll

版本

V1.0

说明

软件注册控件

引用关键算法

名称

--

版本

备注

三、软件框架与流程

1、软件框架结构描述。

2、软件主要流程图。

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

例如：

1、软件框架结构图

2、主要流程图

（略）

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

四、关键函数与功能说明

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

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

编号

函数名称

功能描述

参数说明

返回值

备注

1

2

3

4

5

函数1：

流程或算法。

函数2：

流程或算法。

例如:

1、函数列表

序号

函数名称

功能描述

参数描述

返回值

其他

1

GetCoalFromDBToArray

从数据库取煤矿信息到数组中

（ADOQuery:

TADOQuery;

varCoalArray:

TCoalArray）

正常返回真

2

GetSensorFromDBToArray

从数据库取传感器信息到数组中

（ADOQuery:

TADOQuery;

var　SensorArray:

TSensorArray）

Boolean类型，正常返回真

3

GetSensorTypeArrayFromDB

从数据库取传感器类型到数组中

（ADOQuery:

TADOQuery;VarSensorTypeArray:

TSensorTypeArray）

Boolean类型，正常返回真

4

GetMapArray

从地图文件中取地图信息到MapArray数组

无参数

过程

无返回值

*

5

CheckSensorStatus

根据传感器状态数据，判断传感器状态

（Status:

String;i:

integer）

过程

无返回值

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向数据交换程序发送特征向量

在主窗中实现，采用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,主要包含单元文件35个，如下表：

序号

名称

主要功能

备注

1

Main

主窗体

含.pas、.dfm文件

2

Login

登陆窗体

含.pas、.dfm文件

3

EditSensor

传感器编辑窗体

含.pas、.dfm文件

4

EditLine

线类对象编辑窗体

含.pas、.dfm文件

5

Funproc

自定义函数单元文件

6

structunit

自定义结构单元文件

…..

…..

…..

…

35

WriteTxt

记录信息到文本

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

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

五、软件存在缺陷及建议

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

略