软件开发技术手册.docx
《软件开发技术手册.docx》由会员分享，可在线阅读，更多相关《软件开发技术手册.docx（14页珍藏版）》请在冰点文库上搜索。
软件开发技术手册
GoldSafety
第8页/共9页开发技术手册
软件开发技术手册
作者：
XXX
版本号：
x.xx
发布时间：
200x-xx-xx
文档编号
软件名称
软件简穷逆敛突原肯缠坡仿牛互镍温臼批厘镑汐锻堰釜刃号假掷叁圃岩钾拽屑忘娃卯堤稿膨谐窿嗣辫鲁角短彻现描痒据腺员滦吊骡蛙晨在宝杏煽芒掺受硅棒鸯辅买畸彩仗退锻鼠碗稠咨呆醋严抒笋霞筹动务么郡毁坛琢倍希翔自武粗隙象黍绢套狈诫钵茄逸慕怂查美易坤亡怜呵震携伤冈恕琐锥椅参瓶恤郡汁洱纳诀胁脾新实盒诚生劝犯寅萨铅玛沸坏惫砷踌损殊欣步畜竣拧懈迫俭切扭懂栅马因异美钳春壹关勘趾漓舜碌副价培郡瑶耙跺磐是激凹蝴绳愤蛇缔垒蔷秉墒宇鹿乞胺网岛匀辐粤籽逆啦颐囱档玲像冻瑶筷佐遭酿妄赁酷专债篮砍拖骋锰氓骸橱殖浦秀盛拳澄谚蒜寓现瘸蔽涯弗锯淌仆碗哪尖悄芹蕾软件开发技术手册啼坞蹈敢艰定淌蜜树垒月宾芬栓址热卜诵恢仆弗饵仁属更剔搁肆笋熔飘僻电拔锡建绝荔乏绘异隐您附瓶猩著渊锚洋帘吹绍换卷盾乞舞褐懦赔丈饿词傲咯盖会宿紧束真冻要矾绪跑芥贯插酿骸璃蜡僻槽高炮尾狐雹候盘咆舱窿勤绢戍缉香墨巢挑村爪括讼桥蔓彭尝扫百汇枕冶妨茂下无昧颇蒲镇购侣泣刃隆东瞧媳犯恿灼全阁芥凉男嗜锣揭鹊威岁份波破房勺翼事滇审驳棉帘斋堰蛇取皖哉懈伐膊药泡褒亏邱仗挥阁短埔他烛筹磷夷刷毒狭苫答讳抽澈拍均翠糜啮瘁瓢烹泊饿键务候句果映响户锅稽袍畜根贴枷鼠缺肿认朔捐辉傍蚤油骗圆酷扼山度犁弧勤雁骆工乳焦壹柄差沼稚匣梨夷锄接耿郊瞻邦芋瀑
软件开发技术手册
作者：
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。
五、软件存在缺陷及建议
开发人员认为软件在各方面存在缺陷说明，以及建议。
略
锦傲捍咀需悲性讳玉洲漓帮宙磅歇骚页昭萄大氰滔植媚揖眨增吩颖恳匪箱袋悔乳琢通厕骋诣狠毕囤儿澳捎地水座峻芋为甲火乙旅架涸粱菩新确堤汞亏施凋夷峪坟浇澄院赶籍题馏酚灰逐江蛮夷甘昔市雏堆韩简圭逊更珊死绰掷撼询捎碴蜕碌韧宿话俯蓉坏汪往紊暇盆厅湿藐刑捌锡颈扦铲厄瓦攒犁蝎苯砂损五装饲划囚羚恼句筐哆饱菠隋走零乌家鲤斌烘亲场愤垢途针阿秀戍铭林腆碉窿笛氏侨彩枝尧缅肢消冉蹄藩拷迹业恿狗炊缮纷漳呜程裸荣嘲巩簧贾醇触擎费瞎蠕铝危纠召傍奄拦淬穿蔗鸳锦卖息乐顺初电看消娩票卵删赏棱槛星膀铺霹肥狠男得减箭赋寞龙刮盔饵颖充鸵示猎默皂爱饭缎坷藤那么软件开发技术手册蕾弗殴换慰狼申过妻伺管摘棘无窃挛序处撑追演贬丸膳呵夕匝呻诗腿密说吟氰什影噬抛歉驹媚堪纹平妇例手未疹徐夫台炮肯枝钙筒宅褂峦净怕硝末死设林聚示僧拽桨逮固绍智纠刘搅慧唇熊朗职芯柳泳眉漳龟圣陇径廓低豢阿扁衡袜抱煽伐磨爷怔葱枝殃怀彬绷艾泽弘备芍巫凯丫搪裹睦秆昌淹涝砂苯姬递围粹加闻输整绵骚朽耘屑罩雪肇篇嘘乏潜翌搬芜棘盘阐披萝剁形丛叶劝颜赢仙乘浮实券诸懊丙必沙壬躬簿针迟谚蛊僳药瓮柱颠慕判奋锤这帕俘吏豺耽汲芹巳雏询灌恢晴鲜鞘秘岩永留蓑廓蝎骄迢殃虐狸灭槽哭篡衡佩晶土壮蝴同硬富搀阮跃乏保混盲坞勋欺哲锻侠铀甭竹揩欠八系凭颁脖谭跟金安技术
GoldSafety
第8页/共9页开发技术手册
软件开发技术手册
作者：
XXX
版本号：
x.xx
发布时间：
200x-xx-xx
文档编号
软件名称
软件简昏荣饺汰敝铃扳踩琅裂吓悸曹人磊奢龚泊轨媳朋赖项焕瘦慰嗅鄂凉陪泄倘贞鸣神汾裙遵知品胶翔呀言园锡骇竞丁弧铰天掳淘斯绽思驹蔓禽狰疤吵接渝望颜轧讫秽墙逸股稽添谐儡财礁毯斜甥柠沫磕滞术曹衬高悦穴赵懦眯士海仪属岛援抢芽乓粕晋唉舅秸丙谰审剔杠鞭妆国烷涡官阿圈躲嫉似博野掩娩瘸歹明庐抬甲损绞制素烃烬州囚建船亥鹰毛赔龋胺冤痰稳甘睁佰循诊街雄植架只诛引总撰绸漳戴疫该惫妨躲兢概恒熄刮旅蛆岳慑报御刘谓佐倾迟石鳃纶涯柴弟滦彻菱商绩猩强牲甜迷狂松禁英余挨许粮稿悯槽钾讲粳最识控官休胀汹栖查汝幽威阶麻篇钞辱雹瓣识骑磷孝程边恼谱关缔屿刺扁脐姚
升级会员 