软件开发技术手册范本

专业整理共享专业整理共享软件开发技术手册<XXXXX软件>XXX公布时间：200x-xx-xx文档编号文档编号软件名称软件简介相关系统参与人员金安技术版权全部严禁在金安公司以外公开或使用!版本历史版本号作者参与者修改说明日期1.00Damy2023-06-5---27一、软件介绍1、介绍软件名称、实现主要功能。2、本软件与整个系统中其它相关软件关系介绍。软件名称主要功能软件名称主要功能在整个系统中与其它软件关系(相关协议文档的说明)例如：软件名称主要功能

〕V1.0、地图的导入mapinfo格式〕b、图元添加，修改，删除c、图元显示、操作、查询d、图层治理e、用户治理通信处理：对因地图操作而生成的特征向量的保存，治理，发送等。在整个系统中与其它软此软件是通过安全卫士程序，将地图特征向量数据传输到中心，件关系 与安全卫士程序有通信协议。使用时需要安全卫士程序协作。二、软件开发环境名称名称操作系统版本说明数据库版本说明开发语言版本说明使用控件版本引用关键算法名称版本备注1、软件开发平台:具体说明软件开发所用操作系统、数据库等版本。2、使用开发语言以及版本。3、使用相关控件名称、版本〔如组件、DLL。4、软件中引用关键算法说明。例如：名称Win2023操作系统版本Win2023professional+SP4说明软件在win2023开发，可运行于win2023\XP名称SQLServer数据库版本说明Professional2023--名称Delphi开发语言版本6.0+SP2说明名称GISDLL.dll1版本V1.0、说明GIS名称REGDLL.dll2版本V1.0说明软件注册控件引用关键算法名称--版本备注三、软件框架与流程1、软件框架构造描述。2、软件主要流程图。3、软件使用通信协议、接口、数据库〔表〕方面具体说明。例如：1、软件框架构造图MapinfoMapinfo格式地图安全卫士数据终端地图数据转入功能模块：地图文件1、将Mapinfo格式地图导入到GIS自己格式文件中，同时将图中对象相关的其属性存放到本地数据库中。〔煤矿地图要严格依据地图制作标准进展绘制，同一煤矿只生产一个图，每一层导入到该图的相应图层〕2、生产自己格式的地图文件，供程序调用。特征向量包返回确定信息用户治理模块：1、修改密码2、增用户3、删除用户〔信息存库〕地图编辑、修改功能模块〔设定用户权限〕：1、可对地图中的点、线、面三大类对象进展位置、属性、节点进展编辑、修改，并保存到本地地图文件和数据库中。2、在地图上可增加点、线、面三类对象及对象属性数据，保存到本地地图文件和数据库中。3、对上面的编辑、修改每一个对象产生的相关数据生成一条特征向量，保存到特征向量文件中，供通信模块调用。通信处理功能模块：数据库特征向量保存在本地数据库中地图显示、操作、查询功能模块：1、显示全图、地图放大、缩小、移动、选择等；2、分层显示的功能，用户可选择显示/隐蔽相关图层。3、各图层对象查找功能〔主要是巷道层、工作面层、传感器层、分站层〕，并闪耀提示用户。1、依据用户提交保存地图〔煤矿端－监控中心〕操作,一次将多条特征向量进展组包，发送给安全卫士。2、收到正确返回后，去除特征向量待发列表中的已经传送过的特征向量，并将其移至历史列表。3、通信过程中的出错处理功能煤矿端GIS功能模块和数据流程图2、主要流程图〔略〕3、具体通信协议见远程监系统中总协议中煤矿GIS四、关键函数与功能说明(一)、软件关键函数〔自定义、系统、引用、窗体大事、模块存储过程等的列表。关键函数或算法请写出流程图或用伪代码描述。编号函数名称功能描述参数说明返回值备注123451：流程或算法。2：流程或算法。例如:1、函数列表序号函数名称功能描述参数描述返回值其他序号函数名称功能描述参数描述返回值其他1GetCoalFromDBToArray从数据库取煤矿信息到数组中(ADOQuery:TADOQuery;varTCoalArray)CoalArray:正常返回真2GetSensorFromDBToArray从数据库取传感器信息到数组中(ADOQuery:TADOQuery;varSensorArray:从数据库取传感器类型到数组中TSensorArray)(ADOQuery: TADOQuery;3GetSensorTypeArrayFromDBVarSensorTypeArray:4GetMapArrayBoolean类型，正常返回真Boolean类型，正常返回真过程无返回值5CheckSensorStatus从地图文件中取地图信息到MapArray数组依据传感器状态数据，推断传感器状态刷传感器状态TSensorTypeArray)无参数*(Status:String;i:integer)过程无返回值6RefreshSensorStatus(CoalID:string)过程无返回值5翻开地图文件。10n。15n20设置MapArray数组长度为n。25再读取地图文件，将各地图信息存MapArray数组中。30(二)、软件主要功能列表关键功能的流程要写出流程图或用伪代码描述。序号序号功能功能描述据库表、文件等备注123451：流程或算法描述。2：流程或算法描述。例如：2、功能列表序号功能征向量(煤矿端)系统据

功能描述煤矿端GIS换程序发送特征向量煤矿端GIS换程序恳求井下监控系统配置数据。

使用函数、窗体、存储过程、数据备注库表、文件等TCP/IP方式。SenderList表，createID,objID,CreateTime,data字段。在主窗中实现，承受TCP/IP方式。用到数据库configsensor。SensorID、 SensorType、用到ParseReceiveText函数。配置数处理井下监控系统配据处理 置数据包

功能流程：功能1:流程2:专业整理共享流程3:四、软件产品说明专业整理共享1、对归档程序说明软件产品名称，以及使用到相关配置文件参数等说明。2、软件如何进展安装、参数配置、使用。需要进展注册或安装数据库等环境的要进展具体说明，或指出参考文档。3、软件工程文件说明：各单元文件〔类〕4、软件开发环境配置说明。例如：、煤矿端GISCoalEditGIS.ex，使用到GIS.ini配置文件和数据连接文件，另外使用到两种自定义字体。2、软件安装、参数配置、使用请参考此软件安装使用说明手册。Delphi6.开发，工程文件在归档程序名目下，名称CoalEditGIS.dpr35序号名称主要功能备注1Main主窗体2Login登陆窗体3EditSensor传感器编辑窗体4EditLine线类对象编辑窗体5Funproc自定义函数单元文件6struc