软件开发技术手册.doc

金安技术
GoldSafety

软件开发技术手册

<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
说明

使用控件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;
var CoalArray: TCoalArray)
正常返回真

2
GetSensorFromDBToArray
从数据库取传感器信息到数组中
(ADOQuery: TADOQuery;
var　SensorArray: TSensorArray)
Boolean类型，正常返回真

3
GetSensorTypeArrayFromDB
从数据库取传感器类型到数组中
(ADOQuery: TADOQuery; Var SensorTypeArray: 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、软件开发环境配置说明：
程序开发环境安装，在windows2000 professional系统下，先安装Delphi6.0+SP2，再安装MS SQL server2000,再根据安装手册中数据安装部分，将数据库进行还原，再启动Delphi6.0打开软件归档目录中工程文件，CoalEditGIS.dpr。

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

略

其中专业理论知识内容包括：保安理论知识、消防业务知识、职业道德、法律常识、保安礼仪、救护知识。作技能训练内容包括：岗位操作指引、勤务技能、消防技能、军事技能。
二．培训的及要求培训目的
安全生产目标责任书
为了进一步落实安全生产责任制，做到“责、权、利”相结合，根据我公司2015年度安全生产目标的内容，现与财务部签订如下安全生产目标：
一、目标值：
1、全年人身死亡事故为零，重伤事故为零，轻伤人数为零。
2、现金安全保管，不发生盗窃事故。
3、每月足额提取安全生产费用，保障安全生产投入资金的到位。
4、安全培训合格率为100%。
二、本单位安全工作上必须做到以下内容：
1、对本单位的安全生产负直接领导责任，必须模范遵守公司的各项安全管理制度，不发布与公司安全管理制度相抵触的指令，严格履行本人的安全职责，确保安全责任制在本单位全面落实，并全力支持安全工作。
2、保证公司各项安全管理制度和管理办法在本单位内全面实施，并自觉接受公司安全部门的监督和管理。
3、在确保安全的前提下组织生产，始终把安全工作放在首位，当“安全与交货期、质量”发生矛盾时，坚持安全第一的原则。
4、参加生产碰头会时，首先汇报本单位的安全生产情况和安全问题落实情况；在安排本单位生产任务时，必须安排安全工作内容，并写入记录。
5、在公司及政府的安全检查中杜绝各类违章现象。
6、组织本部门积极参加安全检查，做到有检查、有整改，记录全。
7、以身作则，不违章指挥、不违章操作。对发现的各类违章现象负有查禁的责任，同时要予以查处。
8、虚心接受员工提出的问题，杜绝不接受或盲目指挥；
9、发生事故，应立即报告主管领导，按照“四不放过”的原则召开事故分析会，提出整改措施和对责任者的处理意见，并填写事故登记表，严禁隐瞒不报或降低对责任者的处罚标准。
10、必须按规定对单位员工进行培训和新员工上岗教育；
11、严格执行公司安全生产十六项禁令，保证本单位所有人员不违章作业。
三、 安全奖惩：
1、对于全年实现安全目标的按照公司生产现场管理规定和工作说明书进行考核奖励；对于未实现安全目标的按照公司规定进行处罚。
2、每月接受主管领导指派人员对安全生产责任状的落

第 11 页 / 共 11 页 开发技术手册