研究所軟件設(shè)計(jì)說(shuō)明

1、型代號(hào)/任務(wù)代號(hào)$配置項(xiàng)編號(hào)-SJ-V版本號(hào)軟件設(shè)計(jì)說(shuō)明共 頁(yè)文件號(hào)型代號(hào)/任務(wù)代號(hào)型(代)號(hào)中國(guó)工程物理研究院計(jì)算機(jī)應(yīng)用研究所分類號(hào)檔案號(hào)密級(jí)階段dua編寫(xiě)人參加人 校 對(duì)審 核會(huì) 簽標(biāo)準(zhǔn)化審 批批 準(zhǔn)說(shuō)明： 標(biāo)記處數(shù)更改文號(hào)簽 字日期標(biāo)記處數(shù)更改文號(hào)簽 字日期目次1 范圍11.1 標(biāo)識(shí)11.2 系統(tǒng)概述11.3 文檔概述12 引用文檔13 軟件設(shè)計(jì)決策13.2 設(shè)計(jì)原則23.3 設(shè)計(jì)規(guī)約23.4 開(kāi)發(fā)規(guī)范23.5 設(shè)計(jì)方法23.6 開(kāi)發(fā)模型24 軟件體系結(jié)構(gòu)設(shè)計(jì)24.1 軟件部件設(shè)計(jì)24.1.2 部署設(shè)計(jì)34.1.3 運(yùn)行設(shè)計(jì)34.1.4 技術(shù)架構(gòu)設(shè)計(jì)34.1.5 總體功能設(shè)計(jì)44.1.6

2、 領(lǐng)域?qū)ο笤O(shè)計(jì)44.1.7 包結(jié)構(gòu)設(shè)計(jì)44.1.8 數(shù)據(jù)訪問(wèn)機(jī)制設(shè)計(jì)44.1.9 界面設(shè)計(jì)44.2 執(zhí)行方案44.3 接口設(shè)計(jì)44.3.1 接口標(biāo)識(shí)和接口圖44.3.X (接口的項(xiàng)目唯一的標(biāo)識(shí)符)45 軟件詳細(xì)設(shè)計(jì)65.1 功能模塊設(shè)計(jì)（軟件單元的項(xiàng)目唯一標(biāo)識(shí)符）65.2 保密性設(shè)計(jì)75.3 六性設(shè)計(jì)75.4 性能設(shè)計(jì)76 需求可追蹤性77 注釋9 9型代號(hào)/任務(wù)代號(hào)$配置項(xiàng)編號(hào)-SJ-V版本號(hào)軟件設(shè)計(jì)說(shuō)明 1 范圍1.1 標(biāo)識(shí)本條應(yīng)描述本文檔所適用系統(tǒng)和軟件的完整標(biāo)識(shí)，適用時(shí)，包括其標(biāo)識(shí)號(hào)、名稱、縮略名、版本號(hào)和發(fā)布號(hào)。a) 本文檔已批準(zhǔn)的標(biāo)識(shí)號(hào)為：型代號(hào)/任務(wù)代號(hào)$配置項(xiàng)編號(hào)-SJ-V版本

3、號(hào)；b) 標(biāo)題為：XXX$X軟件設(shè)計(jì)說(shuō)明；c) 本文檔適用的軟件：XXX$X軟件。1.2 系統(tǒng)概述本條應(yīng)概述本文檔所適用的系統(tǒng)和軟件的用途。它還應(yīng)描述系統(tǒng)與軟件的一般特性；概述系統(tǒng)開(kāi)發(fā)、運(yùn)行和維護(hù)的歷史；標(biāo)識(shí)項(xiàng)目的需方、用戶、開(kāi)發(fā)方和保障機(jī)構(gòu)等；標(biāo)識(shí)當(dāng)前和計(jì)劃的運(yùn)行現(xiàn)場(chǎng)；列出其他有關(guān)文檔。1.3 文檔概述本條應(yīng)概述本文檔的用途和內(nèi)容，并描述與它的使用有關(guān)的保密性方面的要求。2 引用文檔本章應(yīng)列出引用文檔的編號(hào)、標(biāo)題、編寫(xiě)單位、修訂版及日期，還應(yīng)標(biāo)識(shí)不能通過(guò)正常采購(gòu)活動(dòng)得到的文檔的來(lái)源。3 軟件設(shè)計(jì)決策本節(jié)應(yīng)根據(jù)需要給出軟件設(shè)計(jì)決策，即從用戶角度出發(fā)描述系統(tǒng)將怎樣運(yùn)轉(zhuǎn)以滿足需求；同時(shí)給出和其他影

4、響該軟件單元的選擇與設(shè)計(jì)的決策。針對(duì)關(guān)鍵性需求(例如對(duì)安全性或保密性關(guān)鍵的需求)作出的設(shè)計(jì)決策，應(yīng)在專門(mén)的章條中加以敘述。如果設(shè)計(jì)決策依賴于系統(tǒng)狀態(tài)或方式，則應(yīng)指明這一依賴性。設(shè)計(jì)決策的例子如下：a) 關(guān)于軟件將接收的輸入和將產(chǎn)生的輸出的設(shè)計(jì)決策，包括與其他系統(tǒng)、硬件,軟件和用戶的接口。如果這一信息的全部或部分已在接口設(shè)計(jì)說(shuō)明(IDD)中給出，則可以直接引用。b) 有關(guān)響應(yīng)每個(gè)輸入或條件的軟件行為的設(shè)計(jì)決策，包括軟件要執(zhí)行的動(dòng)作、響應(yīng)時(shí)間和其他性能特性，模型化的物理系統(tǒng)的說(shuō)明，選定的方程式/算法/規(guī)則，以及對(duì)不允許的輸入或條件進(jìn)行的處理。c) 有關(guān)數(shù)據(jù)庫(kù)/數(shù)據(jù)文件如何呈現(xiàn)給用戶的設(shè)計(jì)決策。如果

5、這一信息的全部或部分在數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明(DBDD)中給出，則可直接引用。d) 為滿足安全性和保密性需求所選擇的方法。e) 為滿足需求所做的其他配置項(xiàng)級(jí)設(shè)計(jì)決策，例如為提供所需的靈活性、可用性和可維護(hù)性所選擇的方法。3.2 設(shè)計(jì)原則3.3 設(shè)計(jì)規(guī)約3.4 開(kāi)發(fā)規(guī)范3.5 設(shè)計(jì)方法3.6 開(kāi)發(fā)模型4 軟件體系結(jié)構(gòu)設(shè)計(jì)本章應(yīng)分為以下幾條描述軟件體系結(jié)構(gòu)設(shè)計(jì)。如果設(shè)計(jì)的全部或部分依賴于系統(tǒng)的狀態(tài)或方式，此依賴性應(yīng)予指明。如果設(shè)計(jì)信息在多于一個(gè)條中出現(xiàn)，它只需被提供一次，而在其他條中引本條應(yīng)提供或引用為了理解設(shè)計(jì)所需要的設(shè)計(jì)約定。4.1 軟件部件設(shè)計(jì)本條應(yīng)描述：a) 所有軟件單元。應(yīng)賦予每個(gè)軟件單元一個(gè)項(xiàng)

6、目唯一的標(biāo)識(shí)符。注：軟件單元是軟件設(shè)計(jì)中的元素；例如，軟件主要分支、軟件組成部分，類、對(duì)象、模塊、函數(shù)、例程或數(shù)據(jù)庫(kù)。軟件單元可以出現(xiàn)在層次結(jié)構(gòu)的不同層上，且又可以由其他軟件單元組成。在設(shè)計(jì)中，軟件單元與實(shí)現(xiàn)它們的代碼和數(shù)據(jù)實(shí)體(例程，過(guò)程，數(shù)據(jù)庫(kù)，數(shù)據(jù)文件等)，或與包含這些實(shí)體的計(jì)算機(jī)文件之間，可以有、也可以沒(méi)有一對(duì)一的對(duì)應(yīng)關(guān)系。一個(gè)數(shù)據(jù)庫(kù)可被處理為一個(gè)軟件配置項(xiàng)也可被處理為一個(gè)軟件單元。軟件設(shè)計(jì)說(shuō)明可以采用與所使用設(shè)計(jì)方法相一致的任何名字來(lái)稱呼軟件單元。b) 軟件單元的靜態(tài)關(guān)系。根據(jù)所選擇的軟件設(shè)計(jì)方法學(xué)，可以給出多種關(guān)系(例如，采用面向?qū)ο蟮脑O(shè)計(jì)方法時(shí)，本條既可給出類和對(duì)象結(jié)構(gòu)，也可給出

7、模塊和過(guò)程結(jié)構(gòu))。c) 每個(gè)軟件單元的用途，指明分配給它的軟件需求和配置項(xiàng)級(jí)設(shè)計(jì)決策。d) 每個(gè)軟件單元的開(kāi)發(fā)狀態(tài)/類型(如新開(kāi)發(fā)、按原樣重用已有的設(shè)計(jì)或軟件、為重用而要開(kāi)發(fā)的軟件等)。針對(duì)現(xiàn)有的設(shè)計(jì)或軟件，本說(shuō)明應(yīng)提供標(biāo)識(shí)信息，例如名字、版本、文檔引用、庫(kù)等。e) 軟件計(jì)劃使用的計(jì)算機(jī)硬件資源(例如處理機(jī)能力，內(nèi)存能力，輸入輸出設(shè)備能力，輔存能力以及通信/網(wǎng)絡(luò)設(shè)備能力)。本說(shuō)明應(yīng)覆蓋軟件的資源使用需求中、影響該軟件的系統(tǒng)級(jí)資源分配中、以及在軟件開(kāi)發(fā)計(jì)劃的資源使用測(cè)量策劃中包含的全部計(jì)算機(jī)硬件資源。如果針對(duì)指定計(jì)算機(jī)硬件資源的所有使用數(shù)據(jù)都在同一處提供，例如在軟件設(shè)計(jì)說(shuō)明中提供，那么本條可直接

8、引用。對(duì)每個(gè)計(jì)算機(jī)硬件資源，應(yīng)包括如下信息：軟件需求或系統(tǒng)級(jí)資源分配、使用數(shù)據(jù)基于的假設(shè)和條件、影響使用的特殊考慮(例如，虛存、多處理器的使用情況，操作系統(tǒng)、庫(kù)軟件的開(kāi)銷或其他實(shí)現(xiàn)開(kāi)銷的影響)、所使用的測(cè)度的單位(例如，處理器能力的百分比、周期/秒、內(nèi)存字節(jié)數(shù)、千字節(jié)/秒)，以及進(jìn)行評(píng)估或測(cè)量的級(jí)別(例如，軟件單元，軟件配置項(xiàng)或可執(zhí)行程序)。f) 標(biāo)識(shí)實(shí)現(xiàn)每個(gè)軟件單元的軟件放置在哪個(gè)程序庫(kù)中?？傮w業(yè)務(wù)框架設(shè)計(jì)4.1.2 部署設(shè)計(jì)4.1.3 運(yùn)行設(shè)計(jì)4.1.4 技術(shù)架構(gòu)設(shè)計(jì)4.1.5 總體功能設(shè)計(jì)4.1.6 領(lǐng)域?qū)ο笤O(shè)計(jì)4.1.7 包結(jié)構(gòu)設(shè)計(jì)4.1.8 數(shù)據(jù)訪問(wèn)機(jī)制設(shè)計(jì)4.1.9 界面設(shè)計(jì)4.2

9、 執(zhí)行方案本條應(yīng)說(shuō)明軟件單元間的執(zhí)行方案，可采用圖表和描述，來(lái)說(shuō)明軟件單元間的動(dòng)態(tài)關(guān)系，即軟件運(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)分配與去除分配、對(duì)象/進(jìn)程/任務(wù)的動(dòng)態(tài)創(chuàng)建/刪除、以及動(dòng)態(tài)行為的其他方面。4.3 接口設(shè)計(jì)4.3.1 接口標(biāo)識(shí)和接口圖本條應(yīng)說(shuō)明賦予每個(gè)接口的項(xiàng)目唯一的標(biāo)識(shí)符，(若適用)應(yīng)通過(guò)名稱、編號(hào)、版本及文檔引用來(lái)標(biāo)識(shí)接口實(shí)體(軟件單元、系統(tǒng)、配置項(xiàng)、用戶等)。該標(biāo)識(shí)應(yīng)說(shuō)明哪些實(shí)體具有固定的接口特性(從而把接口需求分配給這些接口實(shí)體)；說(shuō)明

10、哪些實(shí)體正在開(kāi)發(fā)或修改(這些實(shí)體己有各自的接口需求)。(若適用)應(yīng)通過(guò)接口圖來(lái)描述這些接口。4.3.X (接口的項(xiàng)目唯一的標(biāo)識(shí)符)本條(從4.3.2開(kāi)始)應(yīng)通過(guò)項(xiàng)目唯一的標(biāo)識(shí)符來(lái)標(biāo)識(shí)接口，應(yīng)簡(jiǎn)要地標(biāo)識(shí)接口實(shí)體。視需要可分條描述單方或雙方接口實(shí)體的特性。本條可引用其他文檔(例如數(shù)據(jù)字典、通信協(xié)議標(biāo)準(zhǔn)、用戶接口標(biāo)準(zhǔn))代替在此所描述的信息。(若適用)需求應(yīng)包括如下內(nèi)容，并以任何適合于需求的順序給出，還應(yīng)從接口實(shí)體的角度說(shuō)明這些特性之間的區(qū)別(例如對(duì)數(shù)據(jù)元素的大小、頻率或其他特性的不同期望值)：a) 軟件必須分配給該接口的優(yōu)先級(jí)。b) 對(duì)要實(shí)現(xiàn)的接口類型的要求(例如實(shí)時(shí)數(shù)據(jù)傳送、數(shù)據(jù)的儲(chǔ)存和檢索等)。

11、c) 軟件必須提供、儲(chǔ)存、發(fā)送、存取、接收的各個(gè)數(shù)據(jù)元素所要求的特征，例如：1)名稱/標(biāo)識(shí)符： a.項(xiàng)目唯一的標(biāo)識(shí)符； b.非技術(shù)(自然語(yǔ)言)名稱； c.數(shù)據(jù)元素名稱； d.技術(shù)名(如在代碼或數(shù)據(jù)庫(kù)中的變量名或字段名)； e.縮略名或同義名。2)數(shù)據(jù)類型(字母、數(shù)字、整數(shù)等)。3)大小和格式(如：字符串的長(zhǎng)度和標(biāo)點(diǎn)符號(hào))。4)計(jì)量單位(如：m等)。5)可能值的范圍或枚舉(如：0-99) 。6)準(zhǔn)確性(正確程度)和精度(有效數(shù)字位數(shù))。7)優(yōu)先級(jí)別、定時(shí)、頻率、容量、序列以及其他約束條件(例如數(shù)據(jù)元素是否可以被更新、業(yè)務(wù)規(guī)則是否適用)。8)保密性約束。9)來(lái)源(設(shè)置/發(fā)送實(shí)體)和接收者(使用、接

12、收實(shí)體)。d) 接口實(shí)體將提供、存儲(chǔ)、發(fā)送、訪問(wèn)、接收的數(shù)據(jù)元素組合體(記錄、消息、文件、數(shù)組、顯示、報(bào)表等)所要求的特征，例如：1)名稱/標(biāo)識(shí)符： a.項(xiàng)目唯一的標(biāo)識(shí)符； b.非技術(shù)(自然語(yǔ)言)名稱； c.技術(shù)名稱(如在代碼或數(shù)據(jù)庫(kù)中的記錄名或數(shù)據(jù)結(jié)構(gòu)名)； d.縮略名或同義名。2)數(shù)據(jù)元素組合體中的數(shù)據(jù)元素及其結(jié)構(gòu)(編號(hào)、順序和成組情況)。3)介質(zhì)(例如磁盤(pán))以及在介質(zhì)上數(shù)據(jù)元素/包的結(jié)構(gòu)。4)顯示和其他輸出的視聽(tīng)特性(例如顏色、布局、字體、圖標(biāo)和其他顯示元素、峰鳴音和亮度)。5)包之間的關(guān)系，如排序/存取特性。6)優(yōu)先級(jí)、時(shí)序、頻率、容量、序列及其他約束，例如包是否可以被更新、業(yè)務(wù)規(guī)則是

13、否適用。7)保密性約束。8）來(lái)源(設(shè)置/發(fā)送實(shí)體)和接收者(使用/接收實(shí)體)。e) 接口實(shí)體用于接口的通信方法所要求的特征。如：1）項(xiàng)目唯一的標(biāo)識(shí)符；2)通信鏈接/帶寬/頻率/介質(zhì)及其特性；3)消息格式；4)流控制(如：序列編號(hào)和緩沖區(qū)分配)；5)周期/非周期傳送的數(shù)據(jù)傳送速率，傳輸間隔；6)路由、尋址、命名約定；7)傳輸服務(wù)，包括：優(yōu)先權(quán)和等級(jí)；8)安全性/保密性考慮，如：加密、用戶鑒別、隔離和審核。f) 接口實(shí)體用于接口的協(xié)議所要求的特征，如：1)項(xiàng)目唯一的標(biāo)識(shí)符；2)協(xié)議的優(yōu)先級(jí)別/層次；3)打包，包括拆包和重新打包、路由和尋址；4)合法性檢查、錯(cuò)誤控制和恢復(fù)過(guò)程；5)同步，包括建立連接

14、、保持和終止；6)狀態(tài)、標(biāo)識(shí)及任何其他報(bào)告的特性。g) 其他特性，例如接口實(shí)體的物理兼容性(尺寸、公差、負(fù)載和接插件的兼容性等)、電壓等。5 軟件詳細(xì)設(shè)計(jì)5.1 功能模塊設(shè)計(jì)（軟件單元的項(xiàng)目唯一標(biāo)識(shí)符）本條應(yīng)通過(guò)項(xiàng)目唯一的標(biāo)識(shí)符來(lái)標(biāo)識(shí)軟件單元，并對(duì)該單元進(jìn)行說(shuō)明。(若適用)該說(shuō)明應(yīng)包括下列信息。本條也可以指定一組軟件單元，然后再分小條對(duì)它們分別進(jìn)行標(biāo)識(shí)和說(shuō)明，包含其他軟件單元的軟件單元可引用那些軟件單元的說(shuō)明，而無(wú)需在此重復(fù)。a) (若有)單元設(shè)計(jì)決策，例如所使用的算法(如果此前尚未選定)。b) 該軟件單元設(shè)計(jì)中的任何約束、限定或非常規(guī)特征。c) 如果使用的編程語(yǔ)言不同于本軟件所指定的語(yǔ)言，則

15、應(yīng)指出并說(shuō)明使用它的理由。d) 如果該軟件單元包含過(guò)程性命令或由過(guò)程性命令組成(例如數(shù)據(jù)庫(kù)管理系統(tǒng)(DBMS)中用于定義表單和報(bào)表的菜單選擇，用于數(shù)據(jù)庫(kù)訪問(wèn)和操縱的在線DBMS查詢，用于代碼自動(dòng)生成的圖形用戶接口(GUI)構(gòu)造器的輸入，操作系統(tǒng)的命令或Shell腳本)，應(yīng)列出這些過(guò)程性命令，并引用解釋它們的用戶手冊(cè)或其他文檔。e) 如果該軟件單元包含、接收或輸出數(shù)據(jù)，(若適用)應(yīng)對(duì)它的輸入、輸出及其他數(shù)據(jù)元素和數(shù)據(jù)元素組合體進(jìn)行說(shuō)明。本文檔的4.3.X條提供了(若適用)應(yīng)包括的主題。軟件單元的局部數(shù)據(jù)應(yīng)與軟件單元的輸入或輸出數(shù)據(jù)分開(kāi)來(lái)描述。如果該軟件單元是一個(gè)數(shù)據(jù)庫(kù)，應(yīng)弓!用相應(yīng)的數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)

16、明(DBDD)；接口特性可以在這里提供、也可以引用第4章或相應(yīng)的接口設(shè)計(jì)說(shuō)明(IDD)。f) 如果該軟件單元包含邏輯，則給出該軟件單元所用到的邏輯，(若適用)應(yīng)包括：1) 該軟件單元執(zhí)行啟動(dòng)時(shí)，其內(nèi)部起作用的條件。2) 將控制傳遞給其他軟件單元的條件。3) 對(duì)每個(gè)輸入的響應(yīng)以及響應(yīng)時(shí)間，包括數(shù)據(jù)轉(zhuǎn)換、重命名以及數(shù)據(jù)傳輸操作。4) 在軟件單元運(yùn)行期間的操作順序和動(dòng)態(tài)控制序列，包括：a. 順序控制的方法；b. 該方法的邏輯和輸入條件，例如時(shí)序變異、優(yōu)先級(jí)分配等；c. 進(jìn)出內(nèi)存的數(shù)據(jù)傳輸；d. 對(duì)離散輸入信號(hào)的感知，以及該軟件單元內(nèi)中斷操作之間的時(shí)序關(guān)系。5) 異常和錯(cuò)誤處理。5.2 保密性設(shè)計(jì)5.

17、3 六性設(shè)計(jì)5.4 性能設(shè)計(jì)6 需求可追蹤性本章應(yīng)描述：a) 從本軟件設(shè)計(jì)說(shuō)明所標(biāo)識(shí)的每個(gè)軟件單元，到分配給它的軟件需求的可追蹤性。b) 從每個(gè)軟件配置項(xiàng)需求，到被分配這些需求的軟件單元的可追蹤性。表1 正向追溯表序號(hào)軟件需求規(guī)格說(shuō)明軟件設(shè)計(jì)說(shuō)明13.2.2內(nèi)容編輯5.1.1內(nèi)容編輯23.2.2.1內(nèi)容編寫(xiě)5.1.1.1內(nèi)容編寫(xiě)33.2.2.2接口管理5.1.1.2接口管理43.2.3內(nèi)容管理5.1.2內(nèi)容管理53.2.3.1項(xiàng)目管理5.1.2.1項(xiàng)目管理63.2.3.2項(xiàng)目配置5.1.2.2項(xiàng)目配置73.2.3.3DM管理5.1.2.3DM管理83.2.3.4實(shí)體管理5.1.2.4實(shí)體管理9

18、3.2.3.5重用單元管理5.1.2.5重用單元管理103.2.3.6任務(wù)管理5.1.2.6任務(wù)管理113.2.3.7數(shù)據(jù)交換5.1.2.7數(shù)據(jù)交換123.2.3.8基礎(chǔ)庫(kù)管理5.1.2.8基礎(chǔ)庫(kù)管理133.2.4內(nèi)容發(fā)布5.1.3內(nèi)容發(fā)布143.2.4.1出版物管理5.1.3.1出版物管理153.2.4.2數(shù)據(jù)包管理5.1.3.2數(shù)據(jù)包管理163.2.5內(nèi)容交付5.1.4內(nèi)容交付173.2.6內(nèi)容瀏覽5.1.5內(nèi)容瀏覽183.2.6.1數(shù)據(jù)包管理5.1.5.1數(shù)據(jù)包管理193.2.6.2DM瀏覽控制模塊5.1.5.2DM瀏覽控制模塊203.2.6.3交互操作模塊5.1.5.3交互操作模塊213.2.7系統(tǒng)管理5.1.6系統(tǒng)管理223.2.8安全管理5.1.7安全管理233.2.9審計(jì)管理5.1.8審計(jì)管理表2 逆向追溯表序號(hào)軟件設(shè)計(jì)說(shuō)明軟件需求規(guī)格說(shuō)明15.1.1內(nèi)容編輯3.2.2內(nèi)容編輯25.1.1.1內(nèi)容編寫(xiě)3.2.2.1內(nèi)容編寫(xiě)35.1.1.2接口管理3.2.2.2接