軟件架構設計說明書

<XXX>架構設計說明書的請在使用前驗證版本正確性龍杰科技版本說明作者審核修訂日期1。0發(fā)布Dick本識生效日期 本識生效日期 本識生效日期[對于由多個進程構成的復雜系統(tǒng)，系統(tǒng)設計階段可以分為：架構設計(構架設計)、組件高層設計、組件詳細設計.對于由單個進程構成的簡單系統(tǒng),系統(tǒng)設計階段可以分為:系統(tǒng)概要設計、系統(tǒng)詳細設計。本文檔適用于由多個進程構成的復雜系統(tǒng)的構架設計。][架構設計說明書是軟件產(chǎn)品設計中最高層次的文檔，它描述了系統(tǒng)最高層次上的邏輯結構、物理結構以及各種指南，相關組件(粒度最粗的子系統(tǒng))的內(nèi)部設計由組件高層設計提供。][系統(tǒng)：指待開發(fā)產(chǎn)品的軟件與硬件整體，其軟件部分由各個子系統(tǒng)嵌套組成，子系統(tǒng)之間具有粒度最粗的子系統(tǒng)；模塊：指組成組件的各層子系統(tǒng),模塊由下一層模塊或函數(shù)組成；]1)描述產(chǎn)品的邏輯結構,定義系統(tǒng)各組件(子系統(tǒng))之間的接口以及每個組件(子系統(tǒng))應該2)定義系統(tǒng)的各個進程以及進程之間的通信方式；3)描述系統(tǒng)部署，說明用來部署并運行該系統(tǒng)的一種或多種物理網(wǎng)絡(硬件)配置。對于每種配置，應該指出執(zhí)行該系統(tǒng)的物理節(jié)點(計算機、網(wǎng)絡設備)配置情況、節(jié)點之間的連接方式、采用何種通信協(xié)議、網(wǎng)絡帶寬。另外還要包括各進程到物理節(jié)點的映射;4)系統(tǒng)的整體性能、安全性、可用性、可擴展性、異常與錯誤處理等非功能特性設計；5)定義該產(chǎn)品的各個設計人員應該遵循的設計原則以及設計指南，各個編程人員應該遵循]與組件設計工程師共同完成此文檔。][架構設計說明書的引言應提供整個文檔的概述.它應包括此文檔的目的、范圍、定義、首字母縮eof本識生效日期1.1目的[簡要描述體系結構文檔的目的.]1.2范圍[簡要說明此文檔的范圍:它的相關項目以及受到此文檔影響的任何其它事物]預期的讀者和閱讀建議[說明此文檔的閱讀對象，簡要說明此文檔中其它章節(jié)包含的內(nèi)容與文檔組織方式，對于不同讀閱讀方式建議。目標讀者是系統(tǒng)最終用戶、系統(tǒng)分析員、項目經(jīng)理、產(chǎn)品經(jīng)理、市場人員等。本項目的組織架構和參與人員如下：參與開發(fā)策劃，負責批準項目開發(fā)計劃書；安排項目組成人員握；確定項目進度及檢驗標準了解開發(fā)中存在問題,并及時制定相應對策.負責制訂軟件標準.件的維護。評估將在其中部署項目最終產(chǎn)品的目標組織的情況。協(xié)調(diào)目標組織的建模工作。在必要時對業(yè)務工程工作進行討論和協(xié)調(diào).本識生效日期對目標組織中所建議的任何變更進行成本效益分析.負責獲取用戶最終需求，概括系統(tǒng)的功能和界定系統(tǒng)來領導和協(xié)調(diào)需求獲取及用例建模，編寫《XXX新版本軟件詳細設計》，制訂命名規(guī)范。軟件構架設計,劃分子模塊并詳細描述各模塊功能、要求,和測試要點。對軟件架構中重要的類做詳細說明,描述其屬性、方法、和相互之間的關系。數(shù)據(jù)庫設計，包括定義表、索引、視圖、約束條件、觸發(fā)器、存儲過程等.嚴格按照軟件詳細設計說明，負責自己開發(fā)的模塊的資料、軟件的備份及保管工作。在軟件開發(fā)中如發(fā)現(xiàn)系統(tǒng)分析設計時漏洞提出異議，提交問題報告至項目負責人。對各自編寫的內(nèi)容相互交換作單元測試。負責《用戶使用手冊》的編寫.負責編寫軟件《詳細設計說明書》、《數(shù)據(jù)庫設計說明書》、《測試方案文檔》。負責對各模塊的集成測試，和軟件的整體評估測試，在測試完后負責編寫《測試報告》.術語、首字母縮寫英英文說明AFCClearingCenterAccessControlListAdvancedConfigurationandPowerInterfaceAutomaticFareCollectionAutomaticGateMachineAdministrativeandLogisticsAFC清算管理中心訪問控制列表先進的配置和電源接口行政和后勤響應時間縮寫ACCACLACPIAFCAGMALDT序號123456本本生效日期序號縮寫英文說明序號縮寫DownTime算術邏輯部件適應的安全算法ArithmeticLogicUnit算術邏輯部件適應的安全算法ArithmeticLogicUnit789ALUASAAVMAddValueMachineBinaryCode進制數(shù)編碼表示的方法微機的基本輸入輸出系統(tǒng)市政交通一卡通半自動售票機進制數(shù)編碼表示的方法微機的基本輸入輸出系統(tǒng)市政交通一卡通半自動售票機循環(huán)冗余校驗數(shù)字音頻磁帶數(shù)據(jù)庫數(shù)據(jù)庫管理員數(shù)據(jù)定義語言數(shù)字數(shù)據(jù)存儲數(shù)據(jù)加密標準默認網(wǎng)關非軍事區(qū)拒絕服務動態(tài)路由協(xié)議MunicipleAdministration＆CommunicationCardCo。PURCPURCGatewayCentralProcessingUnitCyclicRedundancyCheckDigitalAudioTapeDatabaseDatabaseAdministratorDataDefinitionLanguageDigitalDataStorageDataEncryptionStandardDefaultGatewayDenialofServiceDynamicRoutingProtocolDifferentiatedServicesCode區(qū)分服務代碼本本生效日期序號縮序號縮寫車票編碼分揀機緊急按鈕錯誤檢查校正設備的主要控制單元Encoder/SorterMachineEmergencyButtonErrorCheckingandCorrectingEquipmentControlUnitElectricallyErasableEEPROM電可擦除只讀內(nèi)存ProgrammableRead-EEPROM電可擦除只讀內(nèi)存Memory進站自動檢票機出進站自動檢票機出站自動檢票機光纖通道仲裁環(huán)光纖通道交換機戶接口硬件高可用性硬盤硬盤驅動器熱備份單元輸入/輸出E工業(yè)標準結構總線I0123EntryGateExitGateFailOverFibreChannelArbitratedLoopFiberChannelSwitchFloppyDiskGraphicalUserInterfaceHardwareHighAvailabilityHardDiskHardDiskDriveHotStandby4HotStandby4Unit5678IdentificationIntegratedDriveElectronicsIndustryStandardArchitecture名稱標識版本生效日期序號縮寫英文說明中文說明49KbpsKilo(thousand)bitspersecond千比特/秒(速率)50KMSKeyManagementSystem密鑰管理系統(tǒng)51LANLocalAreaNetwork局域網(wǎng)52LCDLiquidCrystalDisplay液晶顯示器53LCLineCenter線路中央計算機系統(tǒng)54LCSLineComputerSystem線路計算機系統(tǒng)55LEDLowEmittingDiode發(fā)光二極管56LTOLinearTapeOpen線性磁帶開放協(xié)議57MACMessageAuthenticationCode消息認證碼58MAKMemoryAccessKey內(nèi)存存取密鑰59MbpsMega(Million)bitspersecond兆比特/秒(速率)60MCBFMean—CyclesBetweenFailure平均無故障時間61MCUMainControlUnit主控單元62MHzMegaHertz兆赫茲(頻率)63MTBFMean—TimeBetweenFailure平均無故障時間64MTTRMeanTimeToRepair平均故障恢復維修時間65N/WNetwork網(wǎng)絡66NICNetworkInterfaceCard網(wǎng)絡接口卡67NMSNetworkManagementSystem網(wǎng)絡管理系統(tǒng)68NTPNetworkTimeProtocol網(wǎng)絡時間協(xié)議69OAOfficeAutomation辦公自動化70OTTotalOperatingTime總運營時間71PCIProtocolControlInformation一種局部總線72PCI—XPeripheralComponent擴展的PCI本本端質量保證磁盤陣列數(shù)據(jù)庫管理系統(tǒng)射頻遠程監(jiān)控路由交換引擎車站現(xiàn)場設備安全存取模塊存儲網(wǎng)絡簡單網(wǎng)絡管理協(xié)議車站計算機系統(tǒng)小型計算機接口總待機時間傳輸控制協(xié)議/網(wǎng)際協(xié)議薄膜晶體管液晶顯示器每分鐘內(nèi)系統(tǒng)處理的交易個數(shù)RandomArrayofInexpensiveDatabaseManagementSystemRadioFrequencyRemoteMonitoringRoutingSwitchingEngineSoftwareStationLevelEquipmentSecureAccessModulestorageareanetworkSimpleNetworkManagementocolStationComputersystemSmallComputerSystemInterfaceTotalStandbyTimeTicketCheckingMachineTransmissionControlProtocol/InternetProtocolThinFilmTransistor-LiquidCrystalTransactionsPerMinuteTicketVendingMachine生效日期序號縮寫英文說明序號縮寫InterconnectExtended73Peer74QA75RAIDRDBMS77RFRMON79RSE80S/W1SLE82SAM83SAN84SNMP85SC86SCSI87ST88TCM89TCP/IP90TFT-LCD91Tom92TVM本本生效日期序號縮寫93序號縮寫93UPS94USB95VLAN96VRRPBase-FX98UsecaseviewImplementation99view100Activityview101ClassviewUML不間斷電源通用串行總線虛擬局域網(wǎng)虛擬路由器冗余協(xié)議Un—interruptiblePowerSupplyUniversalSerialBusVirtualLocalAreaNetworkVirtualRouterRedundancyProtocol(IETF)10/100Base－FX標準110/100Base－FX標準UsecaseviewImplementationviewActivityviewClassviewUnifiedModelingLanguage.5參考資料此軟件架構文檔引用文件如下：BB《計算機軟件質量保證計劃規(guī)范》《計算機軟件配置管理計劃規(guī)范》《計算機軟件測試文件編制規(guī)范》本識生效日期邏輯結構[本章描述系統(tǒng)的總體邏輯結構，包括組件(子系統(tǒng))的劃分與依賴關系定義、組件之間的接口定義、系統(tǒng)功能在組件之間的實現(xiàn)流程、組件功能定義]2.1總體結構[本節(jié)定義系統(tǒng)的總體邏輯結構，定義組件劃分以及組件之間的依賴關系。為了能夠使系統(tǒng)具有較好的可重用性以及能夠控制對第三方系統(tǒng)的依賴性(如第三方系統(tǒng)軟件、中間件等),在結構設計時可以采用分層方法。系統(tǒng)可以分為專用應用層、通用應用層、中間件層、為了統(tǒng)一與便于理解,當用圖形化表示組件(子系統(tǒng))、組件之間的依賴關系時,要求采用UML的符號與表示方法.]2.2系統(tǒng)功能實現(xiàn)[針對《產(chǎn)品需求說明書》中定義的功能特性，在此描述它們在相關組件(子系統(tǒng))之間是如何實現(xiàn)的,系統(tǒng)功能實現(xiàn)描述是定義組件之間的接口以及組件功能的基礎，選擇若干代表性的用例來說明。在此要求用兩種方式來描述功能實現(xiàn)：1)UML的順序圖;2)對順序圖的文字解釋需要注意的是UML順序圖中的生命線代表組件(子系統(tǒng))?！懂a(chǎn)品需求說明書》中各個功能特性的數(shù)據(jù)流圖或順序圖描述是此處設計的基礎.]2.3組件接口[本節(jié)明確定義：各個組件之間的接口(系統(tǒng)內(nèi)部接口)。如果組件之間采用通信協(xié)議作為接口，則需要詳細定義應用層協(xié)議以及低層通信方式。如果采用API作為接口，則需要詳細定義API接口函數(shù)(包括參數(shù)定義)。]本識生效日期[系統(tǒng)的所有對外接口在《產(chǎn)品需求說明書》中明確定義。]2.4組件功能[本節(jié)明確定義各個組件的軟件功能，其依據(jù)是《產(chǎn)品需求說明書》以及系統(tǒng)功能實現(xiàn)描述。本節(jié)通常按照組件進行組織.]2.5數(shù)據(jù)庫關系模型[本節(jié)在邏輯層面上定義系統(tǒng)所包含的主體數(shù)據(jù)庫模型，以及主要的實體關系，通常以E-R圖形式來表現(xiàn)。]tx_update_recvstatpw_card_specialpw_card_speciallist_batchpw_card_speciallistcardidvarchar(9)<pk>cardidphysicalvarchartx_update_recvstatpw_card_specialpw_card_speciallist_batchpw_card_speciallistcardidvarchar(9)<pk>cardidphysicalvarchar(16)cardtypevarchar(2)tradedatetimestampdealtypevarchar(1)registtypevarchar(2)pw_card_speciallist_datepw_fare_basicppw_card_storecardidvarchar(9)<pk>cardidfacevarchar(9)cardidphysicalvarchar(16)cardtypevarchar(2)cardsnintegersolddatetimestampforegiftintegerchargeintegerstartdatetimestampenddatetimestampcurrentvalueintegerpointintegerautoflagvarchar(2)cardstatusvarchar(2)updatedatetimestampcardidinouttypesystemlistprocessrulerelationlistfarerulenovarchar(9)<pk>varchar(1)<pk>varchar(800)<pk>varchar(2)varchar(2000)varchar(4)cardidstartcardidendtradedatedealtyperegisttypeoperatorvarchar(9)<pk>varchar(9)timestampvarchar(1)varchar(2)varchar(6)listdatecardidcardidphysicaldealtypetimestampvarchar(9)varchar(16)varchar(1)<pk><pk><pk><pk><pk>basicplannostationno1stationno2farebasicvarchar(4)varchar(10)varchar(10)integerbasicplabasicplabasicrulestartpriceunitpriceunitsdividenotd_clearflagcardidtradetypetradedatereceivedatestartflagstartdatestartaddressstartterminalvarchar(9)varchar(2)timestamptimestampintegertimestampvarchar(10)varchar(9)td_commoncardidvarchar(9)<pk>cardtypevarchar(2)tradetypevarchar(2)tradeaddressvarchar(10)tradedatetimestamp<pk>terminalidvarchar(9)<pk>operatorvarchar(6)trademoneyintegertradevalueintegercurrentvalueintegerforegiftintegerchargeintegercardsninteger<pk>terminalsnintegerterminalsumintegertacvarchar(8)receivedatetimestamptradesnintegerreceivesnintegerstartdatetimestampstartaddressvarchar(10)startterminalvarchar(9)dataresourcevarchar(1)td_customervarchar(9)varchar(2)timestamptimestampvarchar(16)varchar(1)varchar(20)varchar(2)varchar(16)varchar(100)cardidcardtypetradedatereceivedatecustomernamesexcustomerididtypepinaddressphonetd_exchangetradetypetradeaddresstradedateterminalidoperatorreceivedateterminalsnorgcurrencyorgamtexchangeratecurcurrencycuramtvarchar(2)varchar(10)timestampvarchar(9)varchar(6)timestampintegervarchar(3)integervarchar(8)varchar(3)integertd_fareendcardidtradetypetradedatereceivedatefarebasicstartdatestartaddressstartterminalvarchar(9)varchar(2)timestamptimestampintegertimestampvarchar(10)varchar(9)td_common_printvarchar(9)varchar(2)timestamp<pk>varchar(2000)cardidtradetypetradedatePrintMemotd_common_bakcardidcardtypetradetypetradedateterminalidoperatortrademoneycardsnstatereceivedatevarchar(9)varchar(2)varchar(2)timestampvarchar(9)varchar(6)integerintegervarchar(6)timestamp<pk><pk><pk><pk>carditradetradereceicustosexidtypcustopin本識生效日期txtx_db_recvstatustdtd_logvarchar(9)varchar(2)timestampvarchar(3)varchar(4000)varchar(9)varchar(6)cardidtradetypetradedatecommandidtradecontentterminalidoperator<pk><pk>tx_send_bakrow_idrow_id0command_idborn_timesend_timeresend_timevalid_timeaspectadd_addrdest_addrstatuscontentnumeric(10)numeric(10)varchar(3)timestamptimestampintegerintegervarchar(1)varchar(16)varchar(16)varchar(1)varchar(4000)tx_send_bak0row_idrow_id0command_idborn_timesend_timeresend_timevalid_timeaspectadd_addrdest_addrstatuscontentif_reprocessnumeric(10)numeric(10)varchar(3)timestamptimestampintegerintegervarchar(1)varchar(16)varchar(16)varchar(1)varchar(4000)varchar(1)tx_send_temprow_idrow_id0command_idborn_timesend_timeresend_timevalid_timeaspectadd_addrdest_addrstatuscontentnumeric(10)numeric(10)varchar(3)timestamptimestampintegerintegervarchar(1)varchar(16)varchar(16)varchar(1)varchar(4000)tz_account_list_detailsystemidseqnosubseqnooperatortypeclass1class2statusclass3differnumtradenumremainsumdiffermoneytrademoneyremainmoneyoperatorrelationerco_systemidoperatordatesendupflagvarchar(9)varchar(10)varchar(2)varchar(2)varchar(2)varchar(20)varchar(1)varchar(20)integerintegerintegerintegerintegerintegervarchar(6)varchar(6)varchar(9)timestampvarchar(1)<pk><pk><pk>tz_account_stocksystemidclass1class2statusdiffernumtradenumremainsumdiffermoneytrademoneyremainmoneyoperatoroperatordatevarchar(9)varchar(2)varchar(20)varchar(1)integerintegerintegerintegerintegerintegervarchar(6)timestamp<pk><pk><pk><pk>wh_coding_contentcodingcodecontentclass1class2class3varchar(100)<pk>varchar(255)<pk>varchar(2000)v