第二講：研發(fā)項(xiàng)目概要設(shè)計(jì)說明書模板講解與案例分析 V1

研發(fā)項(xiàng)目需求、概設(shè)說明書模板講解與案例分析北京合眾偉奇科技有限公司設(shè)計(jì)部王亮（第二講）目錄CONTENTPART

ONEPART

TWOPART

THREEPART

FOUR預(yù)備知識(shí)概設(shè)模板編寫原則案例分析北京合眾偉奇科技有限公司PART

ONE預(yù)備知識(shí)北京合眾偉奇科技有限公司PARTONE數(shù)據(jù)庫基礎(chǔ)DBMS基礎(chǔ)主鍵

指的是一個(gè)列或多列的組合，其值能唯一地標(biāo)識(shí)表中的每一行，通過它可強(qiáng)制表的實(shí)體完整性。主鍵主要是用于其他表的外鍵關(guān)聯(lián)，以及本記錄的修改與刪除。外鍵

外鍵表示了兩個(gè)關(guān)系之間的相關(guān)聯(lián)系。以另一個(gè)關(guān)系的外鍵作主關(guān)鍵字的表被稱為主表，具有此外鍵的表被稱為主表的從表。外鍵又稱作外關(guān)鍵字。實(shí)體

是客觀存在并可相互區(qū)別的事物。就數(shù)據(jù)庫而言，實(shí)體往往指某類事物的集合。把每一類數(shù)據(jù)對象的個(gè)體稱為實(shí)體。關(guān)系

主要有：1對1、1對多、多對多。三種關(guān)系類型。

DBMS是DataBaseManagementSystem的首字母縮寫，中文全稱“數(shù)據(jù)庫管理系統(tǒng)”。是處理數(shù)據(jù)庫訪問的軟件，提供數(shù)據(jù)庫的用戶接口。

DBMS的目的：提供一個(gè)可以方便地、有效地存取數(shù)據(jù)庫信息的環(huán)境。PARTONE數(shù)據(jù)庫基礎(chǔ)文件管理系統(tǒng)（FMS）與數(shù)據(jù)庫管理系統(tǒng)（DBMS）文件系統(tǒng)數(shù)據(jù)庫管理系統(tǒng)文件系統(tǒng)用文件將數(shù)據(jù)長期保存在外存上數(shù)據(jù)庫系統(tǒng)用數(shù)據(jù)庫統(tǒng)一存儲(chǔ)數(shù)據(jù)文件系統(tǒng)中的程序和數(shù)據(jù)有一定的聯(lián)系數(shù)據(jù)庫系統(tǒng)中的程序和數(shù)據(jù)分離文件系統(tǒng)用操作系統(tǒng)中的存取方法對數(shù)據(jù)進(jìn)行管理數(shù)據(jù)庫系統(tǒng)用DBMS統(tǒng)一管理和控制數(shù)據(jù)文件系統(tǒng)實(shí)現(xiàn)以文件為單位的數(shù)據(jù)共享數(shù)據(jù)庫系統(tǒng)實(shí)現(xiàn)以記錄和字段為單位的數(shù)據(jù)共享二者的共同點(diǎn)均為數(shù)據(jù)組織的管理技術(shù)均由數(shù)據(jù)管理軟件管理數(shù)據(jù)，程序與數(shù)據(jù)之間用存取方法進(jìn)行轉(zhuǎn)換數(shù)據(jù)庫系統(tǒng)是在文件系統(tǒng)的基礎(chǔ)上發(fā)展而來的

PowerDesigner是Sybase的企業(yè)建模和設(shè)計(jì)解決方案，采用模型驅(qū)動(dòng)方法，將業(yè)務(wù)與IT結(jié)合起來，可幫助部署有效的企業(yè)體系架構(gòu)，并為研發(fā)生命周期管理提供強(qiáng)大的分析與設(shè)計(jì)技術(shù)。PowerDesigner將多種標(biāo)準(zhǔn)數(shù)據(jù)建模技術(shù)（UML、業(yè)務(wù)流程建模以及市場領(lǐng)先的數(shù)據(jù)建模）集成一體，并與.NET、WorkSpace、PowerBuilder、Java?、Eclipse等主流開發(fā)平臺(tái)集成起來，為軟件開發(fā)周期管理提供業(yè)務(wù)分析和規(guī)范的數(shù)據(jù)庫設(shè)計(jì)解決方案。此外，它支持60多種RDBMS版本。PARTONEPowerDesigner基礎(chǔ)PowerDesignerCDM表現(xiàn)數(shù)據(jù)庫的全部邏輯結(jié)構(gòu),與任何的軟件或數(shù)據(jù)儲(chǔ)藏結(jié)構(gòu)無關(guān)。是最終用戶對數(shù)據(jù)存儲(chǔ)的看法，反映用戶的綜合性信息需求。CDM是適合于系統(tǒng)分析階段的工具。概念模型LDM幫助分析信息系統(tǒng)的結(jié)構(gòu)，獨(dú)立于任何具體物理數(shù)據(jù)庫實(shí)現(xiàn)。已經(jīng)涉及到實(shí)體的標(biāo)識(shí)符，但沒有CDM那么抽象，并不允許設(shè)計(jì)視圖、索引和其他更具體的物理數(shù)據(jù)模型元素。邏輯模型PDM幫助分析表、視圖、和其他數(shù)據(jù)庫對象，包括數(shù)據(jù)倉庫所需的多維度對象。PDM比CDM和LDM都更為具體。可以進(jìn)行建模、逆向工程、和生成所有最為流行的數(shù)據(jù)庫物理模型PARTONEPowerDesigner基礎(chǔ)為什么要用LDMLDM能夠清晰表示實(shí)體及實(shí)體間的關(guān)系：1對1、1對多、多對多。比PDM更適合用到設(shè)計(jì)文檔中PDMLDMCDM、LDM、PDM相互轉(zhuǎn)換轉(zhuǎn)換CDM快捷鍵：Ctrl+Shift+C轉(zhuǎn)換LDM快捷鍵：Ctrl+Shift+L轉(zhuǎn)換PDM快捷鍵：Ctrl+Shift+PPARTONEPowerDesigner基礎(chǔ)PARTONE總體架構(gòu)圖的由來總體架構(gòu)圖的由來

一般基于當(dāng)前項(xiàng)目的基礎(chǔ)項(xiàng)目平臺(tái)架構(gòu)繪制。例如：現(xiàn)場作業(yè)終端安全管理平臺(tái)基于“閉環(huán)管理”的基礎(chǔ)平臺(tái)架構(gòu)繪制。PARTONE概設(shè)說明書的必要性概設(shè)說明書的用途降低溝通成本，提高溝通準(zhǔn)確率，改善團(tuán)隊(duì)協(xié)作效率項(xiàng)目管理過程控制的依據(jù)編寫測試用例的基礎(chǔ)指導(dǎo)開發(fā)活動(dòng)的重要資料設(shè)計(jì)文檔與測試用例的關(guān)系管理過程知識(shí)積累的重要資料PARTTWO概設(shè)模板北京合眾偉奇科技有限公司PARTTWO概設(shè)說明書總目標(biāo)確保工作經(jīng)驗(yàn)少的開發(fā)人員能夠輕松看懂，并依照概要設(shè)計(jì)文檔進(jìn)行開發(fā)工作PARTTWO填寫概設(shè)說明書模板的思路（口訣）概述主要內(nèi)容包括：項(xiàng)目背景、編寫目的、編寫原則、術(shù)語定義。開宗明義先概述總體設(shè)計(jì)主要內(nèi)容包括：設(shè)計(jì)目標(biāo)、技術(shù)路線、系統(tǒng)架構(gòu)（含：總體架構(gòu)、功能架構(gòu)）總體設(shè)計(jì)分三步概設(shè)說明書的組件章節(jié)分類：功能界面控制組件（UIC）、功能邏輯組件（LC）。其中，功能界面控制組件（UIC）：用于說明系統(tǒng)界面、交互流程及約束等內(nèi)容；功能邏輯組件（LC）：用于說明支撐“功能界面控制組件”所需的邏輯功能組件?？刂?邏輯辨分明概設(shè)說明書功能層級(jí)劃分：分為三層，即，【模塊】、【組件】、【子組件】。示例：UIC01、UIC01_01、UIC01_01_01功能層級(jí)全理清UIC與LC對應(yīng)關(guān)系要明確：一般地，UIC中包含的子組件及其交互流程定義，必然對應(yīng)的有相關(guān)LC子組件提供的邏輯功能支撐。對應(yīng)關(guān)系要確定接口定義及調(diào)用：要明確接口定義及相關(guān)調(diào)用過程。調(diào)用脈絡(luò)需暢通123456PARTTWO概要設(shè)計(jì)說明書文檔結(jié)構(gòu)重點(diǎn)注意事項(xiàng)：模板中的文檔結(jié)構(gòu)不允許隨意刪除。如需修改，先上報(bào)到部門，經(jīng)部門評審?fù)ㄟ^后，由部門反饋到質(zhì)管部統(tǒng)一更新、維護(hù)、發(fā)布文檔模板PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)【編寫內(nèi)容】在此處描述項(xiàng)目背景信息，例如項(xiàng)目來源、建設(shè)現(xiàn)狀、存在問題、必要性說明等內(nèi)容?！菊母袷健恳螅菏仔锌s進(jìn)2字符，宋體，小四，行距1.5【描述方法】整段描述

計(jì)量防護(hù)計(jì)量箱管理平臺(tái)通過在WEB端搭建計(jì)量防護(hù)計(jì)量箱管理系統(tǒng)和掌機(jī)計(jì)量箱管理APP的方式實(shí)現(xiàn)了對智能計(jì)量箱的精細(xì)化檔案管理和運(yùn)行情況監(jiān)控業(yè)務(wù)，實(shí)現(xiàn)了針對專變用戶智能計(jì)量箱的在線狀態(tài)及開關(guān)鎖監(jiān)控、竊電分析、溫濕度情況、遠(yuǎn)程調(diào)試等業(yè)務(wù)需求。智能計(jì)量箱防護(hù)系統(tǒng)二期建設(shè)內(nèi)容包含：計(jì)量箱檔案管理、計(jì)量箱遠(yuǎn)程調(diào)試、計(jì)量箱在線監(jiān)控、計(jì)量箱異常事件分析、溫濕度變化曲線、實(shí)時(shí)數(shù)據(jù)采集、數(shù)據(jù)召測等功能。PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)【編寫內(nèi)容】編寫這份概要設(shè)計(jì)說明書的目的、適用范圍。如不存在集成設(shè)計(jì)或安全設(shè)計(jì)需在此處說明。【正文格式】要求：首行縮進(jìn)2字符，宋體，小四，行距1.5【描述方法】<序號(hào)>、<目的描述>1.2.1目的

本文旨在對計(jì)量防護(hù)計(jì)量箱管理系統(tǒng)進(jìn)行總體規(guī)劃設(shè)計(jì)，其目的在于對系統(tǒng)總體架構(gòu)、系統(tǒng)功能架構(gòu)、功能界面控制組件、功能邏輯組件、業(yè)務(wù)組件的輸入/輸出接口、數(shù)據(jù)的邏輯模型等全局特征進(jìn)行描述，確保開發(fā)團(tuán)隊(duì)在特定技術(shù)環(huán)境下滿足功能需求和非功能需求。1.2.2使用范圍本階段對計(jì)量防護(hù)計(jì)量箱管理系統(tǒng)作概要設(shè)計(jì)。主要解決實(shí)現(xiàn)該系統(tǒng)需求的程序模塊設(shè)計(jì)問題。包括如何把該系統(tǒng)劃分成若干個(gè)模塊、決定各個(gè)模塊之間的接口、模塊之間傳遞的信息，以及數(shù)據(jù)結(jié)構(gòu)、模塊結(jié)構(gòu)的設(shè)計(jì)等。在詳細(xì)設(shè)計(jì)階段軟件，設(shè)計(jì)人員可參考此說明書中所做的模塊結(jié)構(gòu)設(shè)計(jì)，對系統(tǒng)進(jìn)行詳細(xì)設(shè)計(jì)。在軟件測試和軟件維護(hù)階段，測試人員可參考此說明書，了解概要設(shè)計(jì)過程中所完成的各模塊設(shè)計(jì)結(jié)構(gòu)。當(dāng)項(xiàng)目出現(xiàn)偏差時(shí)，參考此說明書找出項(xiàng)目過程中存在的不足或錯(cuò)誤。PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)【編寫內(nèi)容】在此處說明文檔的編寫要求，非系統(tǒng)建設(shè)原則。例如：1、文檔僅限四級(jí)標(biāo)題?！菊母袷健恳螅菏仔锌s進(jìn)2字符，宋體，小四，行距1.5【描述方法】<序號(hào)>、<目的描述>PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)【編寫內(nèi)容】在此處說明文檔的術(shù)語定義。例如：1、業(yè)務(wù)架構(gòu)：是信息化總體架構(gòu)的起點(diǎn)，業(yè)務(wù)架構(gòu)定義了在總體企業(yè)戰(zhàn)略指導(dǎo)下希望實(shí)現(xiàn)的業(yè)務(wù)能力及其關(guān)系。【正文格式】要求：首行縮進(jìn)2字符，宋體，小四，行距1.5【描述方法】<序號(hào)>、<術(shù)語名稱>：<術(shù)語描述>序號(hào)術(shù)語名稱術(shù)語描述1計(jì)量防護(hù)計(jì)量箱管理系統(tǒng)該項(xiàng)目的web端管理系統(tǒng)，文中簡稱“管理系統(tǒng)”2智能計(jì)量箱管理APP該項(xiàng)目的APP客戶端，文中簡稱“APP”3智能計(jì)量箱該項(xiàng)目的管理對象為專變用戶的智能計(jì)量箱，低壓普通用戶的普通計(jì)量箱不在該項(xiàng)目管理范圍，文中簡稱“計(jì)量箱”PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)【編寫內(nèi)容】在此處言簡意賅的說明本系統(tǒng)的設(shè)計(jì)目的?！菊母袷健恳螅菏仔锌s進(jìn)2字符，宋體，小四，行距1.5【描述方法】<序號(hào)>、<目標(biāo)描述>系統(tǒng)建設(shè)從終端、系統(tǒng)、應(yīng)用和數(shù)據(jù)著手，建設(shè)完成達(dá)到以下4目標(biāo)：目標(biāo)一：實(shí)現(xiàn)對智能計(jì)量箱檔案的精細(xì)化管理，所有智能計(jì)量箱檔案登記在冊，精確管理維護(hù)計(jì)量箱與SIM卡的綁定關(guān)系、計(jì)量箱與電能表的綁定關(guān)系。目標(biāo)二：實(shí)現(xiàn)對計(jì)量箱的實(shí)時(shí)在線監(jiān)控及遠(yuǎn)程調(diào)試，對問題計(jì)量箱及時(shí)發(fā)現(xiàn)、及時(shí)處理，確保計(jì)量箱運(yùn)行質(zhì)量，提高運(yùn)維效率。目標(biāo)三：實(shí)現(xiàn)對計(jì)量箱異常事件的監(jiān)控分析能力，對常見的異常事件如開關(guān)鎖、磁場異常、疑似竊電、溫濕度越限等實(shí)現(xiàn)實(shí)時(shí)跟蹤和分析，及時(shí)定位問題處理問題。提升計(jì)量箱運(yùn)行的安全性、采集數(shù)據(jù)的準(zhǔn)確性防止竊電行為的發(fā)生。目標(biāo)四：開通智能計(jì)量箱管理的掌機(jī)APP應(yīng)用，實(shí)現(xiàn)對智能計(jì)量箱的現(xiàn)場標(biāo)準(zhǔn)化作業(yè)技術(shù)支撐。PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)分類選型原則技術(shù)選型界面展現(xiàn)技術(shù)：HTML、JSP、Flex、JavaScript服務(wù)器開發(fā)技術(shù)：JDK1.5、JavaEE5.0數(shù)據(jù)訪問技術(shù)：JDBC部署模式公司總部與?。ㄊ校┕緝杉?jí)部署開發(fā)平臺(tái)國家電網(wǎng)公司統(tǒng)一應(yīng)用平臺(tái)中間件應(yīng)用服務(wù)器：Weblogic分析決策工具：CognosETL工具：Informatica數(shù)據(jù)倉庫、數(shù)據(jù)集市：SybaseIQ流程監(jiān)控：國家電網(wǎng)公司BAM流程集成：國家電網(wǎng)公司BPM企業(yè)服務(wù)總線：OSB數(shù)據(jù)庫Oracle10g操作系統(tǒng)Windows、Linux、UnixPARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)分類選型原則技術(shù)選型界面展現(xiàn)技術(shù)：HTML、JSP、JavaScript服務(wù)器開發(fā)技術(shù)：JDK1.6數(shù)據(jù)訪問技術(shù)：JNDIAPP開發(fā)技術(shù)：AndroidSDK（版本4.0以上）部署模式省級(jí)部署開發(fā)平臺(tái)SSI中間件應(yīng)用服務(wù)器：Weblogic消息服務(wù)：ActiveMQ數(shù)據(jù)庫Oracle11g操作系統(tǒng)Linux、Android（版本4.0以上）PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)組件編號(hào)/組件名稱組件說明UIC01_001/登錄本組件是對用戶的登錄信息進(jìn)行驗(yàn)證和進(jìn)行記住用戶名操作。UIC01_002/終端信息本組件是對設(shè)備檔案信息和掌機(jī)監(jiān)控?cái)?shù)據(jù)進(jìn)行管理，包含設(shè)備清單、智能卡檔案管理、SIM卡檔案管理、掌機(jī)監(jiān)控管理四個(gè)子組件。UIC01_003/采集規(guī)則本組件是對終端設(shè)備進(jìn)行數(shù)據(jù)采集規(guī)則項(xiàng)的配置和展示。UIC01_004/告警管理本組件是對告警規(guī)則進(jìn)行配置，和對告警記錄進(jìn)行處理，包含：告警規(guī)則和告警記錄兩個(gè)子組件。UIC01_005/標(biāo)準(zhǔn)庫管理本組件是對標(biāo)準(zhǔn)庫進(jìn)行管理，一期包含應(yīng)用庫管理一個(gè)子組件。UIC01_006/系統(tǒng)管理本組件是對系統(tǒng)進(jìn)行配置和管理，包含機(jī)構(gòu)人員管理、角色管理、權(quán)限管理和資源管四個(gè)子組件。UIC02_001/安全中心（APP）本組件是一個(gè)安裝在掌機(jī)上的APP，該APP隨掌機(jī)啟動(dòng)，為終端設(shè)備提供監(jiān)控服務(wù)、告警管理、清理加速、安全檢測等功能PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)業(yè)務(wù)項(xiàng)需求功能模塊界面控制組件備注BM08_001_001/需求計(jì)劃管理F03_001/編制年度需求計(jì)劃UIC01_001_001/編制年度需求計(jì)劃

………………PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)填寫后的效果PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)

該組件是對終端設(shè)備信息進(jìn)行展示，主要包含：設(shè)備列表、設(shè)備概況、安裝應(yīng)用詳情、設(shè)備性能監(jiān)控、未處理告警、流量監(jiān)控等六個(gè)子組件PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)子組件組件描述UIC01_002_001/設(shè)備列表本組件提供終端信息查詢、導(dǎo)出功能。UIC01_002_002/設(shè)備概況本組件展示終端外觀圖片、檔案信息、智能卡信息、SIM卡信息以及設(shè)備狀態(tài)。UIC01_002_003/安裝應(yīng)用詳情本組件展示終端安裝的應(yīng)用列表及應(yīng)用卸載功能。UIC01_002_004/設(shè)備性能監(jiān)控本組件展示過去24小時(shí)終端的CPU使用率、內(nèi)存使用率、電池溫度的折線圖信息。UIC01_002_005/未處理告警本組件展示終端設(shè)備未處理的告警的列表以及處理告警信息的功能。UIC01_002_006/流量監(jiān)控本組件展示終端設(shè)備中過去24小時(shí)SIM卡的發(fā)送流量、接收流量、總流量的折線圖信息。PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)組件名稱UIC01_002_001/設(shè)備列表英文名UIC_HandSetInfo組件說明本組件提供終端信息查詢、導(dǎo)出功能。原型圖約束無方法交互場景設(shè)計(jì)初始化1．顯示終端信息列表。其中展示屬性包含：終端資產(chǎn)編號(hào)、終端序列號(hào)、終端類別、終端廠家、終端型號(hào)、子型號(hào)、在線狀態(tài)、領(lǐng)用人和數(shù)據(jù)來源。2．查詢條件下拉選項(xiàng)為默認(rèn)狀態(tài)“全部”。3．關(guān)鍵字輸入框?yàn)榭?。查詢輸入查詢條件。點(diǎn)擊“查詢”，顯示“設(shè)備列表”查詢結(jié)果。重置點(diǎn)擊“重置”，當(dāng)前輸入的查詢條件被清空，設(shè)備列表顯示默認(rèn)信息。導(dǎo)出點(diǎn)擊“導(dǎo)出”默認(rèn)選中終端信息列表中的所有頁、所有字段。選擇文件存放的位置。執(zhí)行導(dǎo)出操作，默認(rèn)格式為csv鏈接詳情點(diǎn)擊“終端資產(chǎn)編號(hào)”和“終端序列號(hào)”打開終端信息詳情頁面；PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)填寫后的效果PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)組件編號(hào)/組件名稱組件說明LC01_001/登錄本組件是后臺(tái)管理平臺(tái)登錄組件，對用戶名和密碼進(jìn)行驗(yàn)證操作，并進(jìn)入后臺(tái)管理平臺(tái)。LC01_002/設(shè)備管理本組件是對終端設(shè)備及附件進(jìn)行管理。LC01_003/告警管理本組件是對終端設(shè)備的“設(shè)備告警”、“應(yīng)用列表”等“掌機(jī)監(jiān)控”業(yè)務(wù)的項(xiàng)管“告警規(guī)則”、“白名單”等信息進(jìn)行管理。LC01_004/標(biāo)準(zhǔn)庫管理本組件是對終端設(shè)備允許安裝的“白名單”APP應(yīng)用信息進(jìn)行管理。LC01_005/系統(tǒng)管理本組件是對使用“安全管理平臺(tái)”操作人員的“角色”、“權(quán)限”、“機(jī)構(gòu)人員”、“資源”等業(yè)務(wù)項(xiàng)進(jìn)行管理。LC02_001/掌機(jī)監(jiān)控本組件提供終端設(shè)備告警功能，包含：非白名單應(yīng)用安裝、SIM卡插拔、SIM卡一致性功能。PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)界面控制組件邏輯組件備注UIC01_001/登錄LC01_001/登錄

UIC01_002/終端信息LC01_002/終端信息

UIC01_003/采集規(guī)則LC01_003/采集規(guī)則

UIC01_004/告警管理LC01_004/告警管理

UIC01_005/標(biāo)準(zhǔn)庫管理LC01_005/標(biāo)準(zhǔn)庫管理

UIC01_006/系統(tǒng)管理LC01_006/系統(tǒng)管理

UIC02_001/安全中心（APP）LC02_001/安全中心（APP）PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)

本組件是包含六個(gè)子組件，分別為：設(shè)備列表、設(shè)備詳情、安裝應(yīng)用詳情、設(shè)備性能監(jiān)控、未處理告警、流量監(jiān)控PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)組件編號(hào)/組件名稱組件說明LC01_002_001/設(shè)備列表本組件查詢、展示終端設(shè)備列表信息，提供查詢、重置、導(dǎo)出功能。LC01_002_002/設(shè)備詳情本組件展示設(shè)備外觀、設(shè)備檔案、智能卡關(guān)聯(lián)、SIM卡關(guān)聯(lián)、設(shè)備狀態(tài)等信息，并提供SIM卡解綁操作。LC01_002_003/安裝應(yīng)用詳情本組件展示終端設(shè)備安裝應(yīng)用數(shù)量、白名單數(shù)量、非白名單數(shù)量，以及終端設(shè)備上的應(yīng)用列表。LC01_002_004/設(shè)備性能監(jiān)控本組件提供過去24小時(shí)CPU使用率、內(nèi)存使用率、電池溫度折線圖功能。LC01_002_005/未處理告警本組件提供終端設(shè)備未處理告警列表信息及操作“處理告警”功能。LC01_002_006/流量監(jiān)控本組提供過去24小時(shí)SIM卡的發(fā)送流量、接收流量及總流量的折線圖功能。PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)實(shí)體英文名/中文名稱簡要說明SC_HANDSET_INFO/手持機(jī)檔案信息存放手持終端標(biāo)識(shí)、終端序列號(hào)、終端類別、終端生產(chǎn)廠家、終端型號(hào)、終端子型號(hào)、硬件版本、軟件版本、到貨批次號(hào)、到貨日期、終端狀態(tài)、所屬單位、接收人、接收時(shí)間、登記人、登記時(shí)間、終端資產(chǎn)編號(hào)等屬性。該實(shí)體通過閉環(huán)系統(tǒng)同步產(chǎn)生記錄。SC_HANDSET_INFO_EXPAND/終端檔案信息擴(kuò)展表存放終端標(biāo)識(shí)、終端數(shù)據(jù)來源、操作系統(tǒng)、安全單元版本號(hào)等屬性。該實(shí)體通過初始化產(chǎn)生記錄。HBAQ_HANDSET_MORE_INFO/掌機(jī)監(jiān)控信息表存放終端標(biāo)識(shí)、終端在線狀態(tài)、電池溫度、電池電量、CPU使用率、運(yùn)行內(nèi)存總量、運(yùn)行內(nèi)存使用量、存儲(chǔ)空間總量、存儲(chǔ)空間使用量、WIFI是否關(guān)閉、藍(lán)牙是否關(guān)閉、USB調(diào)試模式是否關(guān)閉、終端定位是否開啟、是否ROOT、最后更新時(shí)間等屬性。該實(shí)體通過“掌機(jī)采集信息上傳接口（103）”接口產(chǎn)生記錄。PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)組件名稱LC01_002_001/設(shè)備列表英文名LC_HandSetInfo組件說明本組件查詢、展示終端設(shè)備列表信息，提供查詢、重置、導(dǎo)出功能。方法名稱組件方法精化設(shè)計(jì)初始化【方法說明】加載查詢條件及終端設(shè)備信息列表?！据斎?yún)?shù)】無【處理過程】（1）讀取SELECT數(shù)據(jù)表：SC_HANDSET_INFO/手持機(jī)檔案信息；HBAQ_HANDSET_MORE_INFO/掌機(jī)監(jiān)控信息表；SYS_CODE/字典表。【輸出參數(shù)】“終端信息”結(jié)果集。查詢【方法說明】查詢“終端設(shè)備信息列表”?！据斎?yún)?shù)】終端類別；終端廠家；數(shù)據(jù)來源；終端型號(hào)；終端狀態(tài)；關(guān)鍵字?！咎幚磉^程】（1）獲取查詢條件：終端類別=“全部/現(xiàn)場抄表終端/采集維護(hù)終端/全功能終端”；（2）終端廠家=“全部/SELECT*FROMSYS_CODEWHERECODE_TYPE=’HAND_SUPPLIER’”；（3）數(shù)據(jù)來源=“全部/閉環(huán)系統(tǒng)”；（4）終端型號(hào)=“全部/SELECT*FROMSYS_CODEWHERECODE_TYPE=’MODEL_CODE’”；（5）終端狀態(tài)=“全部/在線/離線”。執(zhí)行查詢操作：查詢SELECT數(shù)據(jù)表：HBAQ_HANDSET_MORE_INFO/掌機(jī)監(jiān)控信息表；SC_HANDSET_INFO/手持機(jī)檔案信息?！据敵鰠?shù)】“終端設(shè)備信息”查詢結(jié)果集；重置【方法說明】重置終端設(shè)備查詢條件及列表信息。【輸入?yún)?shù)】【處理過程】（1）獲取查詢條件：終端類別=“全部”；（2）終端廠家=“全部”（3）數(shù)據(jù)來源=“全部”（4）終端型號(hào)=“全部”（5）終端狀態(tài)=“全部”；（6）關(guān)鍵字=“”。執(zhí)行查詢操作：查詢SELECT數(shù)據(jù)表：HBAQ_HANDSET_MORE_INFO/掌機(jī)監(jiān)控信息表；SC_HANDSET_INFO/手持機(jī)檔案信息。【輸出參數(shù)】“終端設(shè)備信息”查詢結(jié)果集。PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)填寫后的效果PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)

安全中心（APP）監(jiān)聽消息服務(wù)，在收到告警規(guī)則變更后，請求此接口，從現(xiàn)場作業(yè)終端安全管理平臺(tái)下載“告警規(guī)則信息”。安全中心（APP）根據(jù)本地SQLite存儲(chǔ)的“告警規(guī)則配置信息”進(jìn)行對比做增量更新PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)（2）交互流程說明1、

安全中心（APP）監(jiān)聽消息服務(wù)，如收到告警規(guī)則配置發(fā)生變化的消息后，調(diào)用“終端下載告警規(guī)則配置信息”接口服務(wù)。2、

現(xiàn)場作業(yè)終端安全管理平臺(tái)收到請求后,從數(shù)據(jù)庫中提取“告警規(guī)則配置信息”。3、

安全中心（APP）請求數(shù)據(jù)接口的serviceCode判斷以何種形式組織返回的數(shù)據(jù)集。4、

現(xiàn)場作業(yè)終端安全管理平臺(tái)將組織好的結(jié)果數(shù)據(jù)集返回給安全中心（APP）。（1）交互流程圖PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)接口名稱終端下載告警規(guī)則配置信息接口接口方式HTTP方法名稱ApiDo數(shù)據(jù)頻度實(shí)時(shí)輸入?yún)?shù)中文名稱輸入?yún)?shù)英文名稱參數(shù)格式含義業(yè)務(wù)號(hào)serviceCodeInt取值：100參數(shù)信息paramJson參數(shù)，JSON格式

updateTimeString更新時(shí)間返回?cái)?shù)據(jù)中文名稱返回?cái)?shù)據(jù)英文名數(shù)據(jù)格式含義返回碼codeInt1：接收成功；0：接收失敗返回信息msgString信息描述?？蔀榭辗祷亟Y(jié)果集resultJsonJSON格式結(jié)果集?？蔀榭?/p>

idInt告警規(guī)則ID

monitorRoleIdInt告警項(xiàng)ID

nameString告警項(xiàng)名稱

maxValueInt閾值

levelInt安全等級(jí)

isEnableInt是否啟用

appIsExecIntAPP是否執(zhí)行

conditionString告警條件PARTTWO模板文檔結(jié)構(gòu)定義概設(shè)說明書文檔結(jié)構(gòu)針對需通過中間庫完成數(shù)據(jù)交互的接口方式，需提供接口交互中間表信息列表，如果未采用中間庫方式交互信息，可忽略此章節(jié)。具體示意如下：接口數(shù)據(jù)類中文名數(shù)據(jù)類英文名配送申請接口配送申請DIST_APP_INFO配送申請明細(xì)DIST_APP_DET訂單響應(yīng)跟蹤ORDER_REPLY_TRACK單位與操作標(biāo)識(shí)關(guān)系表ORG_OPER_ID_RELA注意：如果沒有交互數(shù)據(jù)，請寫“無”PART

THREE編寫原則北京合眾偉奇科技有限公司PARTTHREE編寫概要設(shè)計(jì)說明書的注意事項(xiàng)注意事項(xiàng)約束定義從約束的概念、約束需求兩方面說明約束的基本含義。LC邏輯設(shè)計(jì)LC邏輯設(shè)計(jì)的用途，內(nèi)容，以及設(shè)計(jì)過程的注意事項(xiàng)。LDM模型使用LDM模型的必要性；實(shí)體關(guān)系的完整性；LC實(shí)體列表中信息描述清晰準(zhǔn)確。需求、概設(shè)相呼應(yīng)用戶需求說明胡、產(chǎn)品需求說明書以及概要設(shè)計(jì)說明書之間應(yīng)該能互查。

約束不是行為，是設(shè)計(jì)或項(xiàng)目的某些限制條件，這些限制條件也屬于需求，但通常被稱為“約束”來強(qiáng)調(diào)其限制性，例如：i.必須使用Oracle（我們硬件簽署過使用許可證了）；ii.必須在Linux上運(yùn)行（成本低）。PARTTHREE約束定義——約束的概念1、架構(gòu)師必須充分考慮客戶對上線時(shí)間的要求、預(yù)算限制、以及集成需要等非功能需求。2、客戶所處的業(yè)務(wù)領(lǐng)域?yàn)槟男?？有什么業(yè)務(wù)規(guī)則和業(yè)務(wù)限制？3、是否需要關(guān)注相應(yīng)的法律法規(guī)、專利限制？……業(yè)務(wù)環(huán)境因素1、軟件將人提供給何階層用戶？2、用戶的年齡及使用偏好是哪些？3、用戶是否遍及多個(gè)國家？4、使用期間的環(huán)境有電磁干擾、車船移動(dòng)等國因素嗎？……使用環(huán)境因素1、開發(fā)團(tuán)隊(duì)的技術(shù)水平如果有限（有些軟件企業(yè)甚至希望通過招聘便宜的程序員來降低成本）、磨合程度不高、分布在不同城市，會(huì)有何影響？2、開發(fā)管理方面、源代碼保密方面，是否需要顧及？……構(gòu)建環(huán)境因素1、技術(shù)平臺(tái)、中間件、編程語言等的流行度、認(rèn)同度、優(yōu)缺點(diǎn)等。2、技術(shù)發(fā)展的趨勢如何？……技術(shù)環(huán)境因素1234PARTTHREE約束定義——約束需求約束需求=業(yè)務(wù)環(huán)境因素+使用環(huán)境因素+構(gòu)建環(huán)境因素+技術(shù)環(huán)境因素使用LDM的必要性

概設(shè)說明書必須使用LDM作為數(shù)模設(shè)計(jì)的依據(jù)。LDM能夠清晰表示實(shí)體及實(shí)體間的關(guān)系：1對1、1對多、多對多。比PDM更適合用到設(shè)計(jì)文檔中。PARTTHREELDM模型PDMLDM

構(gòu)建LDM模型時(shí)，如果實(shí)體間存在關(guān)系，必須使用PowerDesigner的LDM模型“Relationship”組件，正確連接表示兩（多）個(gè)實(shí)體間的關(guān)系。PARTTHREELDM模型LDM模型實(shí)體間的關(guān)系要完整LC設(shè)計(jì)中的“實(shí)體列表”主要用于逐個(gè)說明“實(shí)體關(guān)系”圖中所涉及到的每個(gè)表的詳細(xì)信息，包括：表中存放的字段、該表的數(shù)據(jù)來源（即，誰或者什么業(yè)務(wù)產(chǎn)生的該表數(shù)據(jù)記錄）。概設(shè)說明書中的LC實(shí)體列表示例PARTTHREELDM模型實(shí)體英文名/中文名稱簡要說明SC_HANDSET_INFO/手持機(jī)檔案信息（1）存放手持終端標(biāo)識(shí)、終端序列號(hào)、終端類別、終端生產(chǎn)廠家、終端型號(hào)、終端子型號(hào)、硬件版本、軟件版本、到貨批次號(hào)、到貨日期、終端狀態(tài)、所屬單位、接收人、接收時(shí)間、登記人、登記時(shí)間、終端資產(chǎn)編號(hào)等屬性。（2）該實(shí)體通過閉環(huán)系統(tǒng)同步產(chǎn)生記錄。SC_HANDSET_INFO_EXPAND/終端檔案信息擴(kuò)展表（1）存放終端標(biāo)識(shí)、終端數(shù)據(jù)來源、操作系統(tǒng)、安全單元版本號(hào)等屬性。（2）該實(shí)體通過初始化產(chǎn)生記錄。HBAQ_HANDSET_MORE_INFO/掌機(jī)監(jiān)控信息表（1）存放終端標(biāo)識(shí)、終端在線狀態(tài)、電池溫度、電池電量、CPU使用率、運(yùn)行內(nèi)存總量、運(yùn)行內(nèi)存使用量、存儲(chǔ)空間總量、存儲(chǔ)空間使用量、WIFI是否關(guān)閉、藍(lán)牙是否關(guān)閉、USB調(diào)試模式是否關(guān)閉、終端定位是否開啟、是否ROOT、最后更新時(shí)間等屬性。（2）該實(shí)體通過“掌機(jī)采集信息上傳接口（103）”接口產(chǎn)生記錄。PARTTHREELC邏輯設(shè)計(jì)LC邏輯組件設(shè)計(jì)要點(diǎn)組件名稱LC01_002_001/設(shè)備列表英文名LC_HandSetInfo組件說明本組件查詢、展示終端設(shè)備列表信息，提供查詢、重置、導(dǎo)出功能。方法名稱組件方法精化設(shè)計(jì)初始化【方法說明】加載查詢條件及終端設(shè)備信息列表。【輸入?yún)?shù)】無【處理過程】（1）讀取SELECT數(shù)據(jù)表：SC_HANDSET_INFO/手持機(jī)檔案信息；HBAQ_HANDSET_MORE_INFO/掌機(jī)監(jiān)控信息表；SYS_CODE/字典表。【輸出參數(shù)】“終端信息”結(jié)果集。查詢【方法說明】查詢“終端設(shè)備信息列表”?！据斎?yún)?shù)】終端類別；終端廠家；數(shù)據(jù)來源；終端型號(hào)；終端狀態(tài)；關(guān)鍵字?！咎幚磉^程】（1）獲取查詢條件：終端類別=“全部/現(xiàn)場抄表終端/采集維護(hù)終端/全功能終端”；（2）終端廠家=“全部/SELECT*FROMSYS_CODEWHERECODE_TYPE=’HAND_SUPPLIER’”；（3）數(shù)據(jù)來源=“全部/閉環(huán)系統(tǒng)”；（4）終端型號(hào)=“全部/SELECT*FROMSYS_CODEWHERECODE_TYPE=’MODEL_CODE’”；（5）終端狀態(tài)=“全部/在線/離線”。執(zhí)行查詢操