軟件概要設(shè)計(jì)說明書模板V

PAGE目錄1范圍 11.1標(biāo)識 11.2系統(tǒng)概述 11.3文檔概述 12引用文檔 13CSCI級設(shè)計(jì)決策 13.1需求概述 23.2系統(tǒng)任務(wù)和目標(biāo) 23.3系統(tǒng)功能 23.4指標(biāo)要求 23.5設(shè)計(jì)思路 23.6技術(shù)環(huán)境 23.7外部接口關(guān)系 24CSCI體系結(jié)構(gòu)設(shè)計(jì) 24.1部件組成 24.2體系結(jié)構(gòu) 24.3系統(tǒng)流程 24.4應(yīng)用部署 24.5關(guān)鍵技術(shù) 24.6關(guān)鍵指標(biāo)分析 35CSCI部件設(shè)計(jì) 35.1[部件] 35.1.1功能描述 35.1.2部件組成 35.1.3處理過程 35.1.4數(shù)據(jù)流圖 35.1.5界面設(shè)計(jì) 35.1.6接口關(guān)系 35.2執(zhí)行方案 35.3接口設(shè)計(jì) 45.3.1接口標(biāo)識和接口圖 45.3.2[接口] 46需求可追蹤性 67注釋 6[軟件名稱]軟件設(shè)計(jì)說明編號：[軟件編號]范圍標(biāo)識本文檔標(biāo)識號：[文檔標(biāo)識號]；本文檔標(biāo)題：[文檔標(biāo)題]；本文檔適用于[軟件名稱]，軟件標(biāo)識為：[項(xiàng)目標(biāo)識號]，軟件版本號為[軟件版本號],發(fā)行號為[軟件發(fā)行號]；本文檔版本號為[文檔版本號]；縮略語列表表SEQ表\*ARABIC1縮略語列表序號縮略語含義系統(tǒng)概述本條應(yīng)概述本文檔所適用系統(tǒng)和軟件的用途。它還應(yīng)描述系統(tǒng)與軟件的一般特性；概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史；標(biāo)識項(xiàng)目的需方、用戶、開發(fā)方和保障機(jī)構(gòu)等：標(biāo)識當(dāng)前和計(jì)劃的運(yùn)行現(xiàn)場；列出其他有關(guān)文檔。文檔中的斜體描述為說明文字，請?zhí)钊胲浖脑O(shè)計(jì)內(nèi)容，并根據(jù)標(biāo)準(zhǔn)化大綱定義修改字體的大小等文本格式。文檔中的斜體描述為說明文字，請?zhí)钊胲浖脑O(shè)計(jì)內(nèi)容，并根據(jù)標(biāo)準(zhǔn)化大綱定義修改字體的大小等文本格式。文檔概述本條應(yīng)概述本文檔的用途和內(nèi)容，并描述與它的使用有關(guān)的保密性方面的要求。引用文檔本章應(yīng)列出引用文檔的編號、標(biāo)題、編寫單位、修訂版及日期，還應(yīng)標(biāo)識不能通過正常采購活動(dòng)得到的文檔的來源。表SEQ表\*ARABIC2引用文檔列表序號標(biāo)題編號標(biāo)識版本日期編制單位CSCI計(jì)算機(jī)軟件配置項(xiàng)級設(shè)計(jì)決策計(jì)算機(jī)軟件配置項(xiàng)本章應(yīng)根據(jù)需要分條給出CSCI級設(shè)計(jì)決策，即CSCI行為設(shè)計(jì)的決策(忽略其內(nèi)部實(shí)現(xiàn)，從用戶角度出發(fā)描述系統(tǒng)將怎樣運(yùn)轉(zhuǎn)以滿足需求)和其他影響組成該CSCI的軟件單元的選擇與設(shè)計(jì)的決策。如果在需求中所有這些決策是明確的，或者這些決策要推遲到CSCI的軟件單元的設(shè)計(jì)時(shí)指出，則本章應(yīng)如實(shí)陳述。針對關(guān)鍵性需求(例如對安全性或保密性關(guān)鍵的需求)作出的設(shè)計(jì)決策，應(yīng)在專門的章條中加以敘述。如果設(shè)計(jì)決策依賴于系統(tǒng)狀態(tài)或方式，則應(yīng)指明這一依賴性。本條應(yīng)給出或引用理解這些設(shè)計(jì)所需的設(shè)計(jì)約定。需求概述概括描述軟件的總體需求。該項(xiàng)內(nèi)容必須和“研制任務(wù)書”、“需求規(guī)格說明書”保持一致。系統(tǒng)任務(wù)和目標(biāo)描述軟件的建設(shè)任務(wù)、建設(shè)目標(biāo)。系統(tǒng)功能描述軟件實(shí)現(xiàn)的主要功能。指標(biāo)要求描述軟件的技術(shù)、功能等指標(biāo)要求。設(shè)計(jì)思路提出軟件設(shè)計(jì)的總體思路和方法。技術(shù)環(huán)境描述軟件的開發(fā)環(huán)境、運(yùn)行環(huán)境、測試環(huán)境。外部接口關(guān)系描述與本軟件相關(guān)的外部接口關(guān)系。如果存在獨(dú)立的總體接口設(shè)計(jì)文檔，應(yīng)該與相關(guān)文檔保持一致。CSCI體系結(jié)構(gòu)設(shè)計(jì)本章應(yīng)分為以下幾條描述CSCI體系結(jié)構(gòu)設(shè)計(jì)。如果設(shè)計(jì)的全部或部分依賴于系統(tǒng)的狀態(tài)或方式，用此依賴性應(yīng)予指明。如果設(shè)計(jì)信息在多于一個(gè)條中出現(xiàn)，它只需被提供一次，而在其他條中；本條應(yīng)提供或引用為了理解設(shè)計(jì)所需要的設(shè)計(jì)約定。部件組成用圖和文字說明軟件的組成結(jié)構(gòu)，細(xì)化到部件一級。體系結(jié)構(gòu)用圖和文字說明軟件的技術(shù)體系結(jié)構(gòu)。系統(tǒng)流程用圖和文字說明系統(tǒng)流程，必要時(shí)逐條描述。應(yīng)用部署說明軟件的部署形式，必要時(shí)按照邏輯部署和物理部署分別說明。關(guān)鍵技術(shù)提出軟件的關(guān)鍵技術(shù)和解決途徑。關(guān)鍵指標(biāo)分析分析軟件關(guān)鍵指標(biāo)，提出關(guān)鍵指標(biāo)的設(shè)計(jì)落實(shí)思路。CSCI部件設(shè)計(jì)[部件]請改為實(shí)際部件名稱請改為實(shí)際部件名稱功能描述描述部件實(shí)現(xiàn)的功能。部件組成以組成結(jié)構(gòu)圖和文字描述相結(jié)合的方式描述部件的組成結(jié)構(gòu)。標(biāo)識部件單元。表SEQ表\*ARABIC3單元描述表序號軟件單元標(biāo)識符用途開發(fā)狀態(tài)/類型[改進(jìn)/重用/新增]處理方法描述部件的基本處理方法。數(shù)據(jù)流圖描述（畫圖參考UML符號規(guī)范）：輸入的數(shù)據(jù)流―>關(guān)鍵的處理過程和工具－>得到輸出結(jié)果界面設(shè)計(jì)用圖表示整體界面布局，必要時(shí)提出界面設(shè)計(jì)風(fēng)格、使用習(xí)慣等具體要求。接口關(guān)系用圖和文字的形式描述部件與其他部件、系統(tǒng)、子系統(tǒng)的關(guān)系。執(zhí)行方案此部分概要描述；在詳細(xì)設(shè)計(jì)中的4.1節(jié)此部分概要描述；在詳細(xì)設(shè)計(jì)中的4.1節(jié)具體展開。本條應(yīng)說明軟件單元間的執(zhí)行方案，可采用圖表和描述，來說明軟件單元間的動(dòng)態(tài)關(guān)系，即CSCI運(yùn)行期間軟件單元間的相互作用情況，(若適用)應(yīng)包括執(zhí)行控制流程、數(shù)據(jù)流、動(dòng)態(tài)控制序列、狀態(tài)轉(zhuǎn)換圖、時(shí)序圖、單元間的優(yōu)先關(guān)系、中斷處理、時(shí)序/排序關(guān)系、例外處理、并發(fā)執(zhí)行、動(dòng)態(tài)分配與去除分配、對象/進(jìn)程，任務(wù)的動(dòng)態(tài)創(chuàng)建/刪除、以及動(dòng)態(tài)行為的其他方面。接口設(shè)計(jì)接口標(biāo)識和接口圖本條應(yīng)說明賦予每個(gè)接口的項(xiàng)目唯一的標(biāo)識符，(若適用)應(yīng)通過名稱、編號、版本及文檔引用來標(biāo)識接口實(shí)體(軟件單元、系統(tǒng)、配置項(xiàng)、用戶等)。該標(biāo)識應(yīng)說明哪些實(shí)體具有固定的接口特性(從而把接口需求分配給這些接口實(shí)體)：說明哪些實(shí)體正在開發(fā)或修改(這些實(shí)體已有各自的接口需求)。（若適用）應(yīng)通過接口圖來描述這些接口。表SEQ表\*ARABIC4接口關(guān)系描述表接口名稱接口標(biāo)識接口實(shí)體接口實(shí)體特性接口需求分配接口含義及用途發(fā)送方接收方發(fā)送方接收方[接口]請改為實(shí)際接口名稱。此外，軟件的外部調(diào)用接口及具體參數(shù)請通過附件詳細(xì)說明，如有未確定項(xiàng)目請指出。請改為實(shí)際接口名稱。此外，軟件的外部調(diào)用接口及具體參數(shù)請通過附件詳細(xì)說明，如有未確定項(xiàng)目請指出。本條(從4.3.2開始)應(yīng)通過項(xiàng)目唯一的標(biāo)識符來標(biāo)識接口，應(yīng)簡要地標(biāo)識接口實(shí)體，根據(jù)需要可分條描述單方或雙方接口實(shí)體的特性。如果一指定的接口實(shí)體未包含在本SDD中(例如，一個(gè)外部系統(tǒng))，而描述接口實(shí)體需要提到其接口特性時(shí)，這些特性應(yīng)作為假設(shè)予以陳述、或以“當(dāng)[未涵蓋的實(shí)體]這樣做時(shí)，[所指定的實(shí)體]將……”的形式描述。本條可引用其他文檔(例如數(shù)據(jù)字典、協(xié)議標(biāo)準(zhǔn)、用戶接口標(biāo)準(zhǔn))代替在此所描述的信息。本設(shè)計(jì)說明應(yīng)包括以下內(nèi)容(若適用)，以任何適合于所提供的信息的順序提供，并應(yīng)從接口實(shí)體角度說明這些特性之間的區(qū)別(例如關(guān)于數(shù)據(jù)元素的大小、頻率或其他特性的不同期望值)：接口實(shí)體分配給接口的優(yōu)先級。要實(shí)現(xiàn)的接口類型(例如實(shí)時(shí)數(shù)據(jù)傳輸、數(shù)據(jù)的存儲和檢索等)。接口實(shí)體將提供、存儲、發(fā)送、訪問、接收的各個(gè)數(shù)據(jù)元素的特征，例如：名稱/標(biāo)識符：項(xiàng)目唯一的標(biāo)識符；非技術(shù)(自然語言)名稱：數(shù)據(jù)元素名稱：技術(shù)名稱(如在代碼或數(shù)據(jù)庫中的變量名或字段名)：縮略名或同義名。數(shù)據(jù)類型(字母、數(shù)字、整數(shù)等)。大小與格式(如：字符串的長度和標(biāo)點(diǎn)符號)。計(jì)量單位(如：m等)?？赡苤档姆秶蛎杜e(如：O一99)。準(zhǔn)確性(正確程度)和精度(有效數(shù)位數(shù))。優(yōu)先級、定時(shí)、頻率、容量、序列以及其他約束條件(例如數(shù)據(jù)元素是否可以被更新、業(yè)務(wù)規(guī)則是否適用)。保密性約束。來源(建立/發(fā)送的實(shí)體)和接受者(使用，接收的實(shí)體)。接口實(shí)體將提供、存儲、發(fā)送、訪問、接收的數(shù)據(jù)元素組合體(記錄、消息、文件、數(shù)組、顯示、報(bào)表等)的特征，例如：名稱/標(biāo)識符：項(xiàng)目唯一的標(biāo)識符；非技術(shù)(自然語言)名稱；技術(shù)名稱(如在代碼或數(shù)據(jù)庫中的記錄名或數(shù)據(jù)結(jié)構(gòu)名)：縮略名或同義名。數(shù)據(jù)元素組合體中的數(shù)據(jù)元素及其結(jié)構(gòu)(編號、順序和分組情況)。介質(zhì)(例如磁盤)以及介質(zhì)上數(shù)據(jù)元素/數(shù)據(jù)組合體的結(jié)構(gòu)。顯示和其他輸出的視聽特性(例如顏色、布局、字體、圖標(biāo)和其他顯示元素、蜂鳴聲和亮度)。數(shù)據(jù)組合體之間的關(guān)系，如排序/存取特性。優(yōu)先級、定時(shí)、頻率、容量、序列及其他約束，例如數(shù)據(jù)組合體是否可被更新、業(yè)務(wù)規(guī)則是否適用。保密性約束。來源(建立/發(fā)送的實(shí)體)和接受者(使用/接收的實(shí)體)。接口實(shí)體用于接口的通信方法的特征。如：項(xiàng)目唯一的標(biāo)識符；通信鏈接/帶寬/頻率/介質(zhì)及其特征；消息格式；流控制(如：序列編號和緩沖區(qū)分配)；數(shù)據(jù)傳輸率、周期或非周期、傳輸間隔；路由、尋址及命名約定；傳輸服務(wù)，包括：優(yōu)先級和等級；安全性，保密性考慮，如：加密、用戶鑒別、隔離和審核。接口實(shí)體用于接口的協(xié)議的特征，如：項(xiàng)目唯一的標(biāo)識符；協(xié)議的優(yōu)先級別/層次：打包，包括分段與重組、路由和尋址：合法性檢