1、 軟件開發技術手冊<XXXXX軟件>XXX版本號：x.xx發布時間：200x-xx-xx文檔編號軟件名稱軟件簡介相關系統參與人員金安技術所有嚴禁在金安公司以外公開或使用!版本歷史版本號作者參與者修改說明日期1.00Damy2004-06-5-27 一、軟件介紹1、介紹軟件名稱、實現主要功能。2、本軟件與整個系統中其它相關軟件關系介紹。軟件名稱主要功能在整個系統中與其它軟件關系(相關協議文檔的說明)例如：軟件名稱AJM01 GIS軟件（煤礦端）V1.0主要功能a、地圖的導入（mapinfo格式）b、圖元添加，修改，刪除c、圖元顯示、操作、查詢d、圖層管理e、用戶管理通信處理：對因地圖

2、操作而生成的特征向量的保存，管理，發送等。在整個系統中與其它軟件關系此軟件是通過安全衛士程序，將地圖特征向量數據傳輸到中心，與安全衛士程序有通信協議。使用時需要安全衛士程序配合。二、軟件開發環境操作系統名稱版本說明數據庫名稱版本說明開發語言名稱版本說明使用控件名稱版本說明引用關鍵算法名稱版本備注1、軟件開發平臺:詳細說明軟件開發所用操作系統、數據庫等版本。2、使用開發語言以與版本。3、使用相關控件名稱、版本（如組件、DLL等）。4、軟件中引用關鍵算法說明。例如：操作系統名稱Win2000版本Win2000 professional+SP4 說明軟件在win2000開發，可運行于win2000X

3、P系統數據庫名稱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與安全衛士部分。四、關鍵函數與功能說明(一)、軟件關鍵函數（自定義、系統、引用）、窗體事件、模塊存儲過程等的列

4、表。關鍵函數或算法請寫出流程圖或用偽代碼描述。編號函數名稱功能描述參數說明返回值備注12345函數1：流程或算法。函數2：流程或算法。例如:1、函數列表序號函數名稱功能描述參數描述返回值其他1GetCoalFromDBToArray從數據庫取煤礦信息到數組中(ADOQuery: TADOQuery; var CoalArray: TCoalArray)正常返回真2GetSensorFromDBToArray從數據庫取傳感器信息到數組中(ADOQuery: TADOQuery; varSensorArray: TSensorArray)Boolean類型，正常返回真3GetSensorTypeA

5、rrayFromDB從數據庫取傳感器類型到數組中(ADOQuery: TADOQuery; Var SensorTypeArray: TSensorTypeArray)Boolean類型，正常返回真4GetMapArray從地圖文件中取地圖信息到MapArray數組無參數過程無返回值*5CheckSensorStatus根據傳感器狀態數據，判斷傳感器狀態(Status:String;i:integer)過程無返回值6RefreshSensorStatus刷新傳感器狀態(CoalID:string)過程無返回值2、函數的算法描述（流程圖或偽代碼描述）函數4：GetMapArray ()5 打開地

6、圖文件。10 設置地圖數量變量n。15 讀取地圖文件中地圖數量保存到n中。20 設置MapArray數組長度為n。25 再讀取地圖文件，將各地圖信息存到MapArray數組中。30 關閉地圖文件。(二)、軟件主要功能列表關鍵功能的流程要寫出流程圖或用偽代碼描述。序號功能功能描述使用函數、窗體、存儲過程、數據庫表、文件等備注12345功能1：流程或算法描述。功能2：流程或算法描述。例如：2、功能列表序號功能功能描述使用函數、窗體、存儲過程、數據庫表、文件等備注1發送特征向量(煤礦端)煤礦端GIS向數據交換程序發送特征向量在主窗中實現，采用TCP/IP方式。用到數據庫SenderList表，cre

7、ateID,objID,CreateTime,data字段。2取井下系統配置數據煤礦端GIS向數據交換程序請求井下監控系統配置數據。在主窗中實現，采用TCP/IP方式。用到數據庫configsensor。SensorID、SensorType、SubStationDesc、Position字段。用到ParseReceiveText函數。3配置數據處理處理井下監控系統配置數據包StoreSensorCfg、AddSensorCfg功能流程： 功能1: 發送特征向量流程2: 取井下系統配置數據流程3: 配置數據處理四、軟件產品說明1、對歸檔程序說明軟件產品名稱，以與使用到相關配置文件參數等說明。2

8、、軟件如何進行安裝、參數配置、使用。需要進行注冊或安裝數據庫等環境的要進行詳細說明，或指出參考文檔。3、軟件項目文件說明：各單元文件（類）之間關系，說明各單元文件功能.4、軟件開發環境配置說明。例如：1、煤礦端GIS軟件名稱如：CoalEditGIS.exe，使用到GIS.ini配置文件和GIS.UDL數據連接文件，另外使用到兩種自定義字體。2、軟件安裝、參數配置、使用請參考此軟件安裝使用說明手冊。3、軟件為Delphi6.0開發，工程文件在歸檔程序目錄下，名稱為CoalEditGIS.dpr,主要包含單元文件35個，如下表：序號名稱主要功能備注1Main主窗體含.pas、.dfm文件2Login登陸窗體含.pas、.dfm文件3EditSensor傳感器編輯窗體含.pas、.dfm文件4EditLine線類對象編輯窗體含.pas、.dfm文件5Funproc自定義函數單元文件6structunit自定義結構單元文件.35WriteTxt記錄信息到文本4、軟件開發環境配置說明：程序開發環境安裝，在windows2000 professional系統下，先安裝Delphi