軟件開發(fā)技術(shù)手

1、金安技術(shù)軟件開發(fā)技術(shù)手冊vXXXX）軟件 >作者：XXX版本號(hào)：X.XX發(fā)布時(shí)間：200x-xx-xx文檔編號(hào)軟件名稱軟件簡介相關(guān)系統(tǒng)參與人員金安技術(shù)版權(quán)所有嚴(yán)禁在金安公司以外公開或使用版本歷史版本號(hào)作者參與者修改說明日期1.00Damy2004-06-5-27一、軟件介紹、軟件開發(fā)環(huán)境1、介紹軟件名稱、實(shí)現(xiàn)主要功能。2、本軟件與整個(gè)系統(tǒng)中其它相關(guān)軟件關(guān)系介紹。軟件名稱主要功能在整個(gè)系統(tǒng)中與其它軟件關(guān)系 （相關(guān)協(xié)議文檔的說明）例如:軟件名稱AJ M01 GIS軟件（煤礦端）V1.0主要功能a、地圖的導(dǎo)入（mapinfo格式）b圖元添加，修改，刪除C、圖元顯示、操作、查詢d、圖層管理e、用

2、戶管理通信處理：對(duì)因地圖操作而生成的特征向量的保存，管理，發(fā)送 等。在整個(gè)系統(tǒng)中與其它軟 件關(guān)系此軟件是通過安全衛(wèi)士程序，將地圖特征向量數(shù)據(jù)傳輸?shù)街行模?與安全衛(wèi)士程序有通信協(xié)議。使用時(shí)需要安全衛(wèi)士程序配合。操作系統(tǒng)名稱版本說明數(shù)據(jù)庫名稱版本說明1開發(fā)語言名稱版本說明使用控件名稱版本說明引用關(guān)鍵算法名稱版本備注金安技術(shù)GoldSafety1、軟件開發(fā)平臺(tái)：詳細(xì)說明軟件開發(fā)所用操作系統(tǒng)、數(shù)據(jù)庫等版本。2、使用開發(fā)語言以及版本。3、 使用相關(guān)控件名稱、版本（如組件、DLL等）。4、軟件中引用關(guān)鍵算法說明。例如:操作系統(tǒng)名稱Win2000版本W(wǎng)in2000 professio nal+SP4說明軟件

3、在win2000開發(fā)，可運(yùn)行于 win2000XP系統(tǒng)數(shù)據(jù)庫名稱SQL Server版本Professional 2000說明-開發(fā)語言名稱Delphi版本6.0+SP2說明使用控件1名稱GISDLL.dll版本V1.0、說明GIS開發(fā)平臺(tái)使用控件2名稱REGDLL.dll版本V1.0說明 軟件注冊控件引用關(guān)鍵算法名稱-版本備注三、軟件框架與流程1、軟件框架結(jié)構(gòu)描述。2、軟件主要流程圖。3、軟件使用通信協(xié)議、接口、數(shù)據(jù)庫（表）方面詳細(xì)說明。例如：1、軟件框架結(jié)構(gòu)圖Mapinfo格式地圖安全衛(wèi)士 數(shù)據(jù)終端地圖文件特征向量包返回確定信息用戶管理模塊:1、修改密碼2、新增用戶3、刪除用戶 （信息存庫

4、）1'11數(shù)據(jù)庫H/義f特征向量保存在 本地?cái)?shù)據(jù)庫中通信處理功能模塊：1、根據(jù)用戶提交保存地圖 （煤礦端監(jiān)控中心）操作,一次將多條特征向量進(jìn) 行組包，發(fā)送給安全衛(wèi) 士。2、收到正確返回后，清除 特征向量待發(fā)列表中的已 經(jīng)傳送過的特征向量，并 將其移至歷史列表。3、通信過程中的出錯(cuò)處理 功能煤礦端GIS功能模塊和數(shù)據(jù)流程圖2、主要流程圖（略）3、詳細(xì)通信協(xié)議見遠(yuǎn)程監(jiān)系統(tǒng)中總協(xié)議中煤礦端 GIS與安全衛(wèi)士部分四、關(guān)鍵函數(shù)與功能說明（一）、軟件關(guān)鍵函數(shù)（自定義、系統(tǒng)、弓I用）、窗體事件、模塊存儲(chǔ)過程等的列表。關(guān)鍵函數(shù)或算法請(qǐng)寫出流程圖或用偽代碼描述。編號(hào)函數(shù)名稱功能描述參數(shù)說明返回值備注12

5、345函數(shù)1:流程或算法。函數(shù)2:流程或算法。例如：1函數(shù)列表序 號(hào)函數(shù)名稱功能描述參數(shù)描述返回值其他1GetCoalFromDBToArray從數(shù)據(jù)庫取煤礦信 息到數(shù)組中(ADOQuery: TADOQuery; var CoalArray: TCoalArray)正常返回真2GetSe nsorFromDBToArray從數(shù)據(jù)庫取傳感器 信息到數(shù)組中(ADOQuery: TADOQuery;varSen sorArray:TSen sorArray)Boolea n類型，正 常返回真3GetSe nsorTypeArrayFr omDB從數(shù)據(jù)庫取傳感器 類型到數(shù)組中(ADOQuery:TA

6、DOQuery;VarSen sorTypeArray:TSen sorTypeArray)Boolea n類型，正 常返回真4GetMapArray從地圖文件中取地圖信息到MapArray數(shù)組無參數(shù)過程 無返回值*5CheckSe nsorStatus根據(jù)傳感器狀態(tài)數(shù) 據(jù)，判斷傳感器狀 態(tài)(Status:Stri ng;i:i nteger)過程 無返回值6RefreshSe nsorStatus刷新傳感器狀態(tài)(CoalID:stri ng)過程 無返回值2、函數(shù)的算法描述（流程圖或偽代碼描述）函數(shù) 4: GetMapArray （） 5打開地圖文件。10設(shè)置地圖數(shù)量變量n。15讀取地圖文件

7、中地圖數(shù)量保存到n中。20設(shè)置 MapArray數(shù)組長度為n。25再讀取地圖文件，將各地圖信息存到 MapArray數(shù)組中30關(guān)閉地圖文件。（二）、軟件主要功能列表關(guān)鍵功能的流程要寫出流程圖或用偽代碼描述。序號(hào)功能功能描述使用函數(shù)、窗體、存儲(chǔ)過程、數(shù) 據(jù)庫表、文件等備注12345功能1：流程或算法描述。功能2:流程或算法描述。例如：2、功能列表骨口. 序號(hào)功能功能描述使用函數(shù)、窗體、存儲(chǔ)過程、數(shù)據(jù) 庫表、文件等備注1發(fā)送特 征向量（煤礦端）煤礦端GIS向數(shù)據(jù)交 換程序發(fā)送特征向量在主窗中實(shí)現(xiàn)，米用 TCP/IP方式。 用到數(shù)據(jù)庫 SenderList表， createlD,objlD,Crea

8、teTime,data字段。2取井下 系統(tǒng)配置數(shù) 據(jù)煤礦端GIS向數(shù)據(jù)交 換程序請(qǐng)求井下監(jiān)控 系統(tǒng)配置數(shù)據(jù)。在主窗中實(shí)現(xiàn)，米用TCP/IP方式。 用 到數(shù)據(jù)庫 configsensor。Sen sorID 、Sen sorType 、SubStationDesc、Position 字段。用 至U ParseReceiveText 函數(shù)。3配置數(shù)據(jù)處理處理井下監(jiān)控系統(tǒng)配 置數(shù)據(jù)包StoreSensorCfg、AddSensorCfg功能流程：功能1：發(fā)送特征向量金安技術(shù)GoldSafety流程2:取井下系統(tǒng)配置數(shù)據(jù)流程3:配置數(shù)據(jù)處理金安技術(shù)GoldSafety四、軟件產(chǎn)品說明1、對(duì)歸檔程序說明

9、軟件產(chǎn)品名稱，以及使用到相關(guān)配置文件參數(shù)等說明。2、軟件如何進(jìn)行安裝、參數(shù)配置、使用。需要進(jìn)行注冊或安裝數(shù)據(jù)庫等環(huán)境的要進(jìn)行詳細(xì)說明，或指出參考文檔。3、軟件項(xiàng)目文件說明：各單元文件（類）之間關(guān)系，說明各單元文件功能4、軟件開發(fā)環(huán)境配置說明。例如：1、煤礦端GIS軟件名稱如：CoalEditGIS.exe，使用到GlS.ini配置文件和GIS.UDL數(shù)據(jù) 連接文件，另外使用到兩種自定義字體。2、軟件安裝、參數(shù)配置、使用請(qǐng)參考此軟件安裝使用說明手冊。3、軟件為Delphi6.0開發(fā)，工程文件在歸檔程序目錄下，名稱為 CoalEditGIS.dpr,主要 包含單元文件35個(gè)，如下表：骨口. 序號(hào)名稱主要功能備注1Mai n主窗體含.pas、.dfm文件2Login登陸窗體含.pas、.dfm文件3EditSe nsor傳感器編輯窗體含.pas、.dfm文件4EditL ine線類對(duì)象編輯窗體含.pas、.dfm文件5Fun proc自定義函數(shù)單元文件6struct un it自定義結(jié)構(gòu)單元文件35WriteTxt記錄信息到文本4、軟件開發(fā)環(huán)境配置說明:程序開發(fā)環(huán)境安裝，在 windows2000 profess