軟件概要設(shè)計(jì) 詳細(xì)設(shè)計(jì) 軟件設(shè)計(jì) 用戶手冊(cè)說(shuō)明全套_第1頁(yè)
軟件概要設(shè)計(jì) 詳細(xì)設(shè)計(jì) 軟件設(shè)計(jì) 用戶手冊(cè)說(shuō)明全套_第2頁(yè)
軟件概要設(shè)計(jì) 詳細(xì)設(shè)計(jì) 軟件設(shè)計(jì) 用戶手冊(cè)說(shuō)明全套_第3頁(yè)
軟件概要設(shè)計(jì) 詳細(xì)設(shè)計(jì) 軟件設(shè)計(jì) 用戶手冊(cè)說(shuō)明全套_第4頁(yè)
軟件概要設(shè)計(jì) 詳細(xì)設(shè)計(jì) 軟件設(shè)計(jì) 用戶手冊(cè)說(shuō)明全套_第5頁(yè)
已閱讀5頁(yè),還剩33頁(yè)未讀, 繼續(xù)免費(fèi)閱讀

付費(fèi)下載

下載本文檔

版權(quán)說(shuō)明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡(jiǎn)介

軟件概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)、軟件設(shè)計(jì)、用戶手冊(cè)說(shuō)明1簡(jiǎn)介1.1目的這部分要描述文檔的目的。應(yīng)該指明讀者。1.2范圍1.2.1軟件名稱對(duì)軟件命名1.2.2軟件功能解釋軟件產(chǎn)品將完成或不完成的功能(可以直接描述也可以參考相關(guān)文檔)1.2.3軟件應(yīng)用描述軟件的應(yīng)用領(lǐng)域(可直接描述也可以參考其他軟件文檔)2第0層設(shè)計(jì)描述2.1軟件系統(tǒng)上下文定義本節(jié)描述待開發(fā)軟件系統(tǒng)與外部實(shí)體的關(guān)系,可以使用系統(tǒng)結(jié)構(gòu)圖來(lái)描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系。外部實(shí)體屬性描述只限于軟件設(shè)計(jì)和描述相關(guān)的屬性??紤]到描述的完整性,可參考相關(guān)軟件實(shí)體文檔,如OS程序員手冊(cè)。2.2設(shè)計(jì)思路(可選)2.2.1設(shè)計(jì)可選方案對(duì)本軟件系統(tǒng)的幾種設(shè)計(jì)方案進(jìn)行分析、比較,并確定所采用的方案。2.2.2設(shè)計(jì)約束1.遵循標(biāo)準(zhǔn)描述本軟件所遵循的標(biāo)準(zhǔn)、規(guī)范2.硬件限制描述本軟件系統(tǒng)實(shí)現(xiàn)的硬件限制3.技術(shù)限制描述本軟件的技術(shù)限制2.2.3其他描述其他有關(guān)的設(shè)計(jì)考慮3第一層設(shè)計(jì)描述3.1系統(tǒng)結(jié)構(gòu)如果本文檔是針對(duì)增強(qiáng)開發(fā)/小特性的設(shè)計(jì),繼承了原有的系統(tǒng)結(jié)構(gòu),那么應(yīng)拷貝原有的系統(tǒng)結(jié)構(gòu)說(shuō)明,如系統(tǒng)結(jié)構(gòu)圖和相應(yīng)的文字說(shuō)明,然后在一層設(shè)計(jì)中明顯標(biāo)識(shí)出新增功能在原有系統(tǒng)結(jié)構(gòu)中的位置(屬于原來(lái)哪一個(gè)模塊的新增功能,與原有各模塊之間有什么交互)。在后續(xù)的業(yè)務(wù)流程說(shuō)明、模塊分解描述、依賴性描述和接口描述中,如果與本次增強(qiáng)開發(fā)/小特性無(wú)關(guān)的,可以不再重復(fù)描述,如果有關(guān)聯(lián)的,應(yīng)該拷貝原有的設(shè)計(jì)說(shuō)明,在此基礎(chǔ)上再說(shuō)明更改的內(nèi)容。3.1.1系統(tǒng)結(jié)構(gòu)描述這里要描述軟件系統(tǒng)的總體結(jié)構(gòu),可以使用結(jié)構(gòu)圖、層次分解圖或包圖來(lái)描述,并應(yīng)說(shuō)明系統(tǒng)結(jié)構(gòu)劃分的原則(例如,基于標(biāo)準(zhǔn)、協(xié)議所規(guī)定的體系結(jié)構(gòu),來(lái)自于分析模型的結(jié)果,或者基于原有體系結(jié)構(gòu)的結(jié)果)。對(duì)于使用分析模型的體系結(jié)構(gòu),應(yīng)說(shuō)明分析類的職責(zé)及相互關(guān)系。3.1.2業(yè)務(wù)流程說(shuō)明描述系統(tǒng)架構(gòu)模塊/分析類之間的動(dòng)態(tài)交互,來(lái)說(shuō)明用例模型中的典型用例場(chǎng)景,以體現(xiàn)系統(tǒng)功能是如何實(shí)現(xiàn)的。建議采用Sequence圖、Collaboration圖等來(lái)描述。3.2分解描述本節(jié)描述系統(tǒng)中的子系統(tǒng)和模塊。3.2.1模塊/子系統(tǒng)1描述不要直接寫“模塊/子系統(tǒng)1”,用簡(jiǎn)短的詞語(yǔ)命名模塊/子系統(tǒng)。按照以下格式描述:1.簡(jiǎn)介2.功能列表3.2.2數(shù)據(jù)設(shè)計(jì)本節(jié)描述系統(tǒng)中的數(shù)據(jù)結(jié)構(gòu)。外部數(shù)據(jù)實(shí)體不必描述。1.數(shù)據(jù)實(shí)體1描述按照以下格式描述:標(biāo)識(shí):類型:目的:3.3依賴性描述本節(jié)描述系統(tǒng)中的子系統(tǒng),數(shù)據(jù)結(jié)構(gòu),模塊,進(jìn)程等設(shè)計(jì)實(shí)體間的關(guān)系。依賴關(guān)系描述可以使用文字,結(jié)構(gòu)圖,(交互)事務(wù)圖。3.4接口描述本節(jié)描述軟件系統(tǒng)中設(shè)計(jì)實(shí)體(如子系統(tǒng),模塊,進(jìn)程)的接口.I接口描述可以使用接口文件,參數(shù)表。對(duì)于外部實(shí)體只有同被描述軟件相關(guān)的接口才需描述。接口可以是函數(shù)調(diào)用、事件、消息、信號(hào)等。3.4.1模塊/子系統(tǒng)1的接口描述對(duì)每個(gè)接口按照以下格式描述:名稱:(接口名稱)說(shuō)明:(對(duì)接口的簡(jiǎn)短說(shuō)明)定義:(接口原型定義,說(shuō)明接口類型及相關(guān)參數(shù))4第二層設(shè)計(jì)描述L1中定義的每個(gè)模塊的進(jìn)一步設(shè)計(jì)在下面的章節(jié)進(jìn)行描述。對(duì)層次比較多的模塊,可以增加設(shè)計(jì)層次,最終要說(shuō)明對(duì)應(yīng)于最小分解模塊的具體設(shè)計(jì)類(包括其public屬性和public方法)。對(duì)每個(gè)模塊重復(fù)使用下述的格式。4.1模塊1名稱不要直接寫“模塊1名稱”,用簡(jiǎn)短的詞語(yǔ)命名模塊。如果本文檔是針對(duì)增強(qiáng)開發(fā)/小特性的設(shè)計(jì),繼承了原有的二層模塊結(jié)構(gòu),那么應(yīng)拷貝原有的模塊結(jié)構(gòu)說(shuō)明,如包圖/類圖和相應(yīng)的文字說(shuō)明,然后在二層設(shè)計(jì)中明顯標(biāo)識(shí)出新增功能在原有模塊結(jié)構(gòu)中的位置(屬于原來(lái)哪一個(gè)子模塊/設(shè)計(jì)類的新增功能,與原有各子模塊/設(shè)計(jì)類之間有什么交互)。在后續(xù)的功能實(shí)現(xiàn)說(shuō)明和設(shè)計(jì)類定義中,如果與本次增強(qiáng)開發(fā)/小特性無(wú)關(guān)的,可以不描述,如果有關(guān)聯(lián)的,應(yīng)該拷貝原有的設(shè)計(jì)說(shuō)明,在此基礎(chǔ)上再說(shuō)明更改的內(nèi)容。對(duì)更改的設(shè)計(jì)類應(yīng)該給出類的完整定義,再標(biāo)識(shí)出更改的屬性和方法。4.1.1模塊設(shè)計(jì)描述描述模塊分解,例如每個(gè)子模塊的功能定義。定義出具體的設(shè)計(jì)類,用類圖來(lái)描述其相互關(guān)系,并說(shuō)明所采用的設(shè)計(jì)模式。對(duì)每個(gè)類重復(fù)使用下述的格式進(jìn)行描述。1.類名按下面的格式對(duì)每個(gè)設(shè)計(jì)類進(jìn)行說(shuō)明。1)CI標(biāo)識(shí)說(shuō)明該類的配置項(xiàng)標(biāo)識(shí)(用于需求跟蹤,配置項(xiàng)的命名方式在CMP中已定義。一般為:產(chǎn)品名_模塊名_類名,如果在類的命名中未包括前面兩部分)。2)簡(jiǎn)介簡(jiǎn)單介紹該類的功能。3)類定義(Optional)如果該類在前面沒有定義,使用類圖、偽代碼描述該類的類定義,需說(shuō)明該類的所有public屬性和public方法。4.1.2功能實(shí)現(xiàn)說(shuō)明使用Sequence圖、Collaboration圖等來(lái)說(shuō)明這些設(shè)計(jì)類之間如何交互,實(shí)現(xiàn)本模塊的典型功能。5數(shù)據(jù)庫(kù)設(shè)計(jì)(可選)本節(jié)列出所有的數(shù)據(jù)存儲(chǔ)類的實(shí)體(表、存儲(chǔ)過程、觸發(fā)器等),詳細(xì)描述實(shí)體的內(nèi)容和并列出全部屬性。對(duì)每個(gè)屬性,詳細(xì)描述其數(shù)據(jù)庫(kù)、數(shù)據(jù)大小、特定約束。實(shí)體的所有約束及實(shí)體間的關(guān)系也要注明。5.1實(shí)體定義5.1.1分解描述闡述設(shè)計(jì)思路及約束規(guī)則。詳細(xì)定義每個(gè)關(guān)鍵數(shù)據(jù)表、視圖中的各個(gè)字段屬性、存儲(chǔ)要求、完整性約束、功能、注意事項(xiàng),靜態(tài)數(shù)據(jù)表可考慮定義初始配置記錄。5.1.2內(nèi)部依賴性描述使用E-R圖描述實(shí)體間的關(guān)聯(lián)依賴關(guān)系,分析對(duì)存取空間、性能、完整性的要求。5.2行為定義5.2.1分解描述根據(jù)功能或其他方式對(duì)存儲(chǔ)過程/觸發(fā)器進(jìn)行歸類,便于進(jìn)一步細(xì)化和分解,并說(shuō)明每類存儲(chǔ)過程/觸發(fā)器主要功能。詳細(xì)定義每個(gè)存儲(chǔ)過程(觸發(fā)器)的功能、輸入輸出參數(shù)、返回值、返回的記錄集、依賴的數(shù)據(jù)表和存儲(chǔ)過程,以及一些特殊要求(比如需要啟用事務(wù)等)。5.2.2外部依賴性描述描述與其它模塊之間的依賴關(guān)系。5.2.3內(nèi)部依賴性描述描述存儲(chǔ)過程間、存儲(chǔ)過程和數(shù)據(jù)表/視圖間依賴關(guān)系。6組件視圖6.1系統(tǒng)運(yùn)行組件使用Component圖、deployment圖來(lái)描述系統(tǒng)的運(yùn)行組件(EXE文件、DLL等),及其網(wǎng)絡(luò)部署情況。6.2文件組織形式描述源代碼文件的目錄結(jié)構(gòu)(文件夾中各個(gè)目錄下應(yīng)存放什么文件)。7進(jìn)程視圖本節(jié)描述將系統(tǒng)分解為輕量級(jí)進(jìn)程(單個(gè)控制線程)和重量級(jí)進(jìn)程(成組的輕量級(jí)進(jìn)程)的過程。本節(jié)按照各個(gè)通信或交互的進(jìn)程組來(lái)加以組織。說(shuō)明進(jìn)程之間的主要通信模式,例如消息傳遞、中斷和會(huì)合。參考資料清單:請(qǐng)羅列本文檔所參考的有關(guān)參考文獻(xiàn)和相關(guān)文檔,格式如下:作者+書名(或雜志、文獻(xiàn)、文檔)+出版社(或期號(hào)、卷號(hào)、公司文檔編號(hào))+出版日期+起止頁(yè)碼。例如:[1]D.B.Leeson,“ASimpleModelofFeedbackOscillatorNoiseSpectrum,”Proc.IEEE,pp329-330,February1966(英文文章格式)[2]D.Wolaver,Phase-LockedLoopCircuitDesign,PrenticeHall,NewJersey,1991(英文書籍格式)[3]王陽(yáng)元,奚雪梅等,“薄膜SOI/CMOSSPICE電路模擬”,電子學(xué)報(bào),vol.22,No.5,1994(中文文章格式)[4]鄭筠,《MOS存儲(chǔ)系統(tǒng)及技術(shù)》,科學(xué)出版社,1990(中文書籍格式)[5]XXX,SDXXX用戶手冊(cè)V1.1,基礎(chǔ)部文檔室,2001/4/26詳細(xì)設(shè)計(jì)模板目錄1概述1.1目標(biāo)應(yīng)包含以下幾個(gè)方面的內(nèi)容:1、該文檔所描述的模塊;2、該文檔所針對(duì)的讀者;1.2范圍概述本文檔所包含的內(nèi)容2模塊1詳細(xì)設(shè)計(jì)2.1類12.1.1簡(jiǎn)介詳細(xì)描述CLASS1的職責(zé)和功能;必要時(shí),可描述本類與相關(guān)類之間的靜態(tài)/動(dòng)態(tài)關(guān)系。2.1.2類圖提供類的結(jié)構(gòu)圖2.1.3狀態(tài)設(shè)計(jì)可用狀態(tài)圖來(lái)描述類的狀態(tài)信息2.1.4屬性可先定義相關(guān)的數(shù)據(jù)結(jié)構(gòu)。.可見性屬性名稱類型說(shuō)明(對(duì)屬性的簡(jiǎn)短描述)2.1.5方法下面針對(duì)每個(gè)方法進(jìn)行說(shuō)明。1.方法1(1)方法描述Prototype方法的聲明,包含可見性函數(shù)原型Description描述本方法的功能功能描述Calls調(diào)用函數(shù)被本函數(shù)調(diào)用的函數(shù)清單(非系統(tǒng)函數(shù))CalledBy被調(diào)用函數(shù)調(diào)用本函數(shù)的函數(shù)清單(非系統(tǒng)函數(shù)),可選Input輸入?yún)?shù)描述每個(gè)輸入?yún)?shù)的含義、內(nèi)存管理原則Output輸出參數(shù)描述每個(gè)輸出參數(shù)的含義、內(nèi)存管理原則Return返回值描述返回值的含義Exception拋出異常描述可能拋出的異常(2)ImplementationDescription實(shí)現(xiàn)描述使用偽代碼、流程圖等來(lái)描述本方法的詳細(xì)實(shí)現(xiàn)。這部分是詳細(xì)設(shè)計(jì)的重點(diǎn)。3模塊2詳細(xì)設(shè)計(jì)3.1類13.1.1簡(jiǎn)介詳細(xì)描述CLASS1的職責(zé)和功能;必要時(shí),可描述本類與相關(guān)類之間的靜態(tài)/動(dòng)態(tài)關(guān)系。3.1.2類圖提供類的結(jié)構(gòu)圖3.1.3狀態(tài)設(shè)計(jì)可用狀態(tài)圖來(lái)描述類的狀態(tài)信息3.1.4屬性可先定義相關(guān)的數(shù)據(jù)結(jié)構(gòu)。.可見性屬性名稱類型說(shuō)明(對(duì)屬性的簡(jiǎn)短描述)3.1.5方法下面針對(duì)每個(gè)方法進(jìn)行說(shuō)明。2.方法1(1)方法描述Prototype方法的聲明,包含可見性函數(shù)原型Description描述本方法的功能功能描述Calls調(diào)用函數(shù)被本函數(shù)調(diào)用的函數(shù)清單(非系統(tǒng)函數(shù))CalledBy被調(diào)用函數(shù)調(diào)用本函數(shù)的函數(shù)清單(非系統(tǒng)函數(shù)),可選Input輸入?yún)?shù)描述每個(gè)輸入?yún)?shù)的含義、內(nèi)存管理原則Output輸出參數(shù)描述每個(gè)輸出參數(shù)的含義、內(nèi)存管理原則Return返回值描述返回值的含義Exception拋出異常描述可能拋出的異常(2)ImplementationDescription實(shí)現(xiàn)描述使用偽代碼、流程圖等來(lái)描述本方法的詳細(xì)實(shí)現(xiàn)。這部分是詳細(xì)設(shè)計(jì)的重點(diǎn)。4數(shù)據(jù)庫(kù)詳細(xì)設(shè)計(jì)(可選)描述存儲(chǔ)過程、觸發(fā)器等的詳細(xì)實(shí)現(xiàn)4.1存儲(chǔ)過程1/觸發(fā)器1的名稱(1)Descriptions語(yǔ)法Prototype原型描述原型Description描述實(shí)現(xiàn)的功能功能描述使用的數(shù)據(jù)庫(kù)對(duì)象Input輸入?yún)?shù)描述每個(gè)輸入?yún)?shù)的含義Output輸出參數(shù)描述每個(gè)輸出參數(shù)的含義Return返回值描述返回值的含義(2)ImplementationDescription實(shí)現(xiàn)描述Pseudocodescouldbeusedtodepictthedefinitions.使用偽代碼來(lái)描述詳細(xì)實(shí)現(xiàn)。這部分是詳細(xì)設(shè)計(jì)的重點(diǎn)。5錯(cuò)誤處理5.1系統(tǒng)錯(cuò)誤描述象內(nèi)存分配失敗,任務(wù)創(chuàng)建失敗等錯(cuò)誤是如何被處理的。5.2接口錯(cuò)誤描述將要產(chǎn)生并給外部實(shí)體用的錯(cuò)誤碼5.3協(xié)議錯(cuò)誤描述在協(xié)議中沒有描述的情況如何處理。(可選)軟件設(shè)計(jì)說(shuō)明目錄1范圍1.1標(biāo)識(shí)本條應(yīng)描述本文檔所適用的系統(tǒng)、接口實(shí)體和接口的完整標(biāo)識(shí),適用時(shí),包括其標(biāo)識(shí)號(hào)、名稱、縮略名、版本號(hào)和發(fā)布號(hào)。1.2系統(tǒng)概述本條應(yīng)概述本文檔所適用的系統(tǒng)和軟件的用途。它還應(yīng)描述系統(tǒng)與軟件的一般特性;概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史;標(biāo)識(shí)項(xiàng)目的需方、用戶、開發(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)題、編寫單位、修訂版及日期,還應(yīng)標(biāo)識(shí)不能通過正常采購(gòu)活動(dòng)得到的文檔的來(lái)源。3CSCI級(jí)設(shè)計(jì)決策本章應(yīng)根據(jù)需要分條給出CSCI級(jí)設(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í)陳述。針對(duì)關(guān)鍵性需求(例如對(duì)安全性或保密性關(guān)鍵的需求)作出的設(shè)計(jì)決策,應(yīng)在專門的章條申加以敘述。如果設(shè)計(jì)決策依賴于系統(tǒng)狀態(tài)或方式,則應(yīng)指明這一依賴性。本條應(yīng)給出或引用理解這些設(shè)計(jì)所需的設(shè)計(jì)約定。CSCI級(jí)設(shè)計(jì)決策的例子如下:a)關(guān)于CSCI將接收的輸入和將產(chǎn)生的輸出的設(shè)計(jì)決策,包括與其他系統(tǒng)、HWCI、CSCI和用戶的接口(本文檔的4.3.X條指出本說(shuō)明要考慮的主題)。如果這一信息的全部或部分已在接口設(shè)計(jì)說(shuō)明(IDD)中給出,則可以直接引用。b)有關(guān)響應(yīng)每個(gè)輸入或條件的CSCI行為的設(shè)計(jì)決策,包括CSCI要執(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ì)決策(本文檔的4.3.X條標(biāo)識(shí)了本說(shuō)明要考慮的主題)。如果這一信息的全部或部分在數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明(DBDD)中給出,則可直接引用。d)為滿足安全性和保密性需求所選擇的方法。e)為滿足需求所做的其他CSCI級(jí)設(shè)計(jì)決策,例如為提供所需的靈活性、可用性和可維護(hù)性所選擇的方法。4CSCI體系結(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ì)約定。4.1CSCI部件本條應(yīng)描述:a)構(gòu)成該CSCI的所有軟件單元。應(yīng)賦予每個(gè)軟件單元一個(gè)項(xiàng)目唯一的標(biāo)識(shí)符。注:軟件單元是CSCI設(shè)計(jì)中的一個(gè)元素;例如,CSCI的一個(gè)主要分支、該主要分支的一個(gè)組成部分,一個(gè)類、對(duì)象、模塊、函數(shù)、例程或數(shù)據(jù)庫(kù)。軟件單元可以出現(xiàn)在層次結(jié)構(gòu)的不同層上,且又可以由其他軟件單元組成。在設(shè)計(jì)中,軟件單元與實(shí)現(xiàn)它們的代碼和數(shù)據(jù)實(shí)體(例程,過程,數(shù)據(jù)庫(kù),數(shù)據(jù)文件等),或與包含這些實(shí)體的計(jì)算機(jī)文件之間,可以有、也可以沒有一對(duì)一的對(duì)應(yīng)關(guān)系。一個(gè)數(shù)據(jù)庫(kù)可被處理為一個(gè)CSCI也可被處理為一個(gè)軟件單元。SDD可以采用與所使用設(shè)計(jì)方法相一致的任何名字來(lái)稱呼軟件單元。b)軟件單元的靜態(tài)(如,由…組成)關(guān)系。根據(jù)所選擇的軟件設(shè)計(jì)方法學(xué),可以給出多種關(guān)系(例如,采用面向?qū)ο蟮脑O(shè)計(jì)方法時(shí),本條既可給出類和對(duì)象結(jié)構(gòu),也可給出CSCI的模塊和過程結(jié)構(gòu))。)每個(gè)軟件單元的用途,指明分配給它的CSCI需求和CSCI級(jí)設(shè)計(jì)決策(需求的分配也可在6a)中提供)。d)每個(gè)軟件單元的開發(fā)狀態(tài)/類型(如新開發(fā)、按原樣重用已有的設(shè)計(jì)或軟件、再工程的已有的設(shè)計(jì)或軟件、為重用而要開發(fā)的軟件等,為構(gòu)建版N計(jì)劃的軟件)。針對(duì)現(xiàn)有的設(shè)計(jì)或軟件,本說(shuō)明應(yīng)提供標(biāo)識(shí)信息,例如名字、版本、文檔引用、庫(kù)等。e)CSCI(若適用,針對(duì)每個(gè)軟件單元)計(jì)劃使用的計(jì)算機(jī)硬件資源(例如處理機(jī)能力,內(nèi)存能力,輸入/輸出設(shè)備能力,輔存能力以及通信/網(wǎng)絡(luò)設(shè)備能力)。本說(shuō)明應(yīng)覆蓋CSCI的資源使用需求中、影響該CSCI的系統(tǒng)級(jí)資源分配中、以及在軟件開發(fā)計(jì)劃(SDP)的資源使用測(cè)量策劃中包含的全部計(jì)算機(jī)硬件資源。如果針對(duì)指定計(jì)算機(jī)硬件資源的所有使用數(shù)據(jù)都在同一處提供,例如在SDD中提供,那么本條可直接引用。對(duì)每個(gè)計(jì)算機(jī)硬件資源,應(yīng)包括如下信息:1)得到滿足的CSC[需求或系統(tǒng)級(jí)資源分配;2)使用數(shù)據(jù)基于的假設(shè)和條件(例如,典型用法、最壞情況用法、特定事件的假定);3)影響使用的特殊考慮(例如,虛存、覆蓋、多處理器的使用情況,操作系統(tǒng)、庫(kù)軟件的開銷或其他實(shí)現(xiàn)開銷的影響);4)所使用的測(cè)度的單位(例如,處理器能力的百分比、周期/秒、內(nèi)存字節(jié)數(shù)、千字節(jié)/秒);5)進(jìn)行評(píng)估或測(cè)量酌級(jí)別(例如,軟件單元,CSCI或者可執(zhí)行程序)。f)標(biāo)識(shí)實(shí)現(xiàn)每個(gè)軟件單元的軟件放置在哪個(gè)程序庫(kù)中。4.2執(zhí)行方案本條應(yīng)說(shuō)明軟件單元間的執(zhí)行方案,可采用圖表和描述,來(lái)說(shuō)明軟件單元間的動(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)分配與去除分配、對(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)通過名稱、編號(hào)、版本及文檔引用來(lái)標(biāo)識(shí)接口實(shí)體(軟件單元、系統(tǒng)、配置項(xiàng)、用戶等)。該標(biāo)識(shí)應(yīng)說(shuō)明哪些實(shí)體具有周定的接口特性(從而把接口需求分配給這些接口實(shí)體);說(shuō)明哪些實(shí)體正在開發(fā)或修改(這些實(shí)體已有各自的接口需求)。(若適用)應(yīng)通過接口圖來(lái)描述這些接口。4.3.2(接口的項(xiàng)目唯一的標(biāo)識(shí)符)本條(從4.3.2開始)應(yīng)通過項(xiàng)目唯一的標(biāo)識(shí)符來(lái)標(biāo)識(shí)接口,應(yīng)簡(jiǎn)要地標(biāo)識(shí)接口實(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ì)說(shuō)明應(yīng)包括以下內(nèi)容(若適用),以任何適合于所提供的信息的順序提供,并應(yīng)從接口實(shí)體角度說(shuō)明這些特性之間的區(qū)別(例如關(guān)于數(shù)據(jù)元素的大小、頻率或其他特性的不同期望值):a)接口實(shí)體分配給接口的優(yōu)先級(jí)。b)要實(shí)現(xiàn)的接口類型(例如實(shí)時(shí)數(shù)據(jù)傳輸、數(shù)據(jù)的存儲(chǔ)和檢索等)。c)接口實(shí)體將提供、存儲(chǔ)、發(fā)送、訪問、接收的各個(gè)數(shù)據(jù)元素的特征,例如:1)名稱/標(biāo)識(shí)符:a.項(xiàng)目唯一的標(biāo)識(shí)符;b.非技術(shù)(自然語(yǔ)言)名稱;c.?dāng)?shù)據(jù)元素名稱;d.技術(shù)名稱(如在代碼或數(shù)據(jù)庫(kù)中的變量名或字段名):e.縮略名或同義名。2)教據(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)源(建立/發(fā)送的實(shí)體)和接受者(使用/接收的實(shí)體)。d)接口實(shí)體將提供、存儲(chǔ)、發(fā)送、訪問、接收的數(shù)據(jù)元素組合體(記錄、消息、文件、數(shù)組、顯示、報(bào)表等)的特征,例如:1)名稱/標(biāo)識(shí)符:a.項(xiàng)目唯一的標(biāo)識(shí)符;lb.非技術(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ì)(例如磁盤)以及介質(zhì)上數(shù)據(jù)元素/數(shù)據(jù)組合體的結(jié)構(gòu)。4)顯示和其他輸出的視聽特性(例如顏色、布局、字體、圖標(biāo)和其他顯示元素、峰嗚聲和亮度)。5)數(shù)據(jù)組合體之間的關(guān)系,如排序/存取特性。6)優(yōu)先級(jí)、定時(shí)、頻率、容量、序列及其他約束,例如數(shù)據(jù)組合體是否可被更新、業(yè)務(wù)規(guī)則是否適用。7)保密性約束。8)來(lái)源(建立,發(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)先級(jí)和等級(jí):8)安全性/保密性考慮,如:加密、用戶鑒別、隔離和審核。f)接口實(shí)體用于接口的協(xié)議的特征,如:1)項(xiàng)目唯一的標(biāo)識(shí)符;2)協(xié)議的優(yōu)先級(jí)別/層次;3)打包,包括分段與重組、路由和尋址;4)合法性檢查、錯(cuò)誤控制和恢復(fù)過程;5)同步,包括連接的建立、保持和終止;6)狀態(tài)、標(biāo)識(shí)和其他報(bào)告特性。f)其他特征,例如接口實(shí)體的物理兼容性(尺寸、公差、負(fù)荷、電壓和接插件的兼容性等)。5CSCI軟件詳細(xì)設(shè)計(jì)5.1X(軟件單元的項(xiàng)目唯一的標(biāo)識(shí)符,或者一組軟件單元的標(biāo)志符)本條應(yīng)通過項(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ǔ)言不同于該CSCI所指定的語(yǔ)言,則應(yīng)指出并說(shuō)明使用它的理由。d)如果該軟件單元包含過程性命令或由過程性命令組成(例如數(shù)據(jù)庫(kù)管理系統(tǒng)(DBMS)中用于定義表單和報(bào)表的菜單選擇,用于數(shù)據(jù)庫(kù)訪問和操縱的在線DBMS查詢,用于代碼自動(dòng)生成的圖形用戶接口(GUI)構(gòu)造器的輸入,操作系統(tǒng)的命令或Shell腳本),應(yīng)列出這些過程性命令,并引用解釋它們的用戶手冊(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ù)分開來(lái)描述。如果該軟件單元是一個(gè)數(shù)據(jù)庫(kù),應(yīng)引用相應(yīng)的數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明(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)系。6需求的可追蹤性本章應(yīng)包含:a.從本SDD所標(biāo)識(shí)的每個(gè)軟件單元,到分配給他的CSCI需求的可追蹤性。b.從每個(gè)CSCI需求,到分配這些需求的軟件單元的可追溯性。7注釋本章應(yīng)包括有助于了解文檔的所有信息(例如:背景、術(shù)語(yǔ)、縮略語(yǔ)或公式)軟件用戶手冊(cè)目錄1范圍1.1標(biāo)識(shí)a)本文檔的標(biāo)題:;b)本文檔的標(biāo)識(shí):;c)本文檔的版本號(hào):;d)本文檔對(duì)應(yīng)的軟件名稱及版本:。1.2系統(tǒng)概述注:本條應(yīng)概述本文檔所適用系統(tǒng)和軟件的用途。它還應(yīng)描述系統(tǒng)與軟件的一般特性;概述系統(tǒng)開發(fā)、運(yùn)行和維護(hù)的歷史;標(biāo)識(shí)項(xiàng)目的需方、用戶、開發(fā)方和保障機(jī)構(gòu)等;標(biāo)識(shí)當(dāng)前和計(jì)劃的運(yùn)行現(xiàn)場(chǎng),列出其他有關(guān)文檔.1.3文檔概述注:本節(jié)概述該文檔的用途和內(nèi)容,并描述與其使用有關(guān)的保密性或私密性要求。2引用文檔注:本章應(yīng)列出引用文檔的編號(hào)、標(biāo)題、編寫單位、修訂版及日期GJB438B-2009軍用軟件開發(fā)文檔通用要求[AAA]作者,《XXX書》,機(jī)構(gòu)名稱,日期3軟件綜述3.1軟件應(yīng)用本條應(yīng)簡(jiǎn)要說(shuō)明軟件預(yù)期的用途,并應(yīng)描述對(duì)軟件使用所期望的能力、運(yùn)行改進(jìn)和受益情況。3.2軟件清單系統(tǒng)運(yùn)行所提供軟件如表31:表31軟件內(nèi)容清單序號(hào)文件名稱版本號(hào)/發(fā)行號(hào)備注1WindowsXPWindowsXP2002出廠前安裝3.3軟件環(huán)境本條應(yīng)描述用戶安裝并運(yùn)行該軟件所需的硬件、軟件、手工操作和其他的資源。(若適用)包括以下方面:a)應(yīng)提供的計(jì)算機(jī)設(shè)備,包括需要的內(nèi)存數(shù)量、輔存數(shù)量及外圍設(shè)備(如打印機(jī)和其他的輸入/輸出設(shè)備):b)應(yīng)提供的通信設(shè)備:c)應(yīng)提供的其他軟件,例如操作系統(tǒng)、數(shù)據(jù)庫(kù)、數(shù)據(jù)文件、實(shí)用程序和其他的支持系統(tǒng):1)應(yīng)提供的表格、規(guī)程或其他的手工操作:2)應(yīng)提供的其他設(shè)施、設(shè)備或資源。3.4軟件組織和操作概述本條應(yīng)從用戶的角度出發(fā),簡(jiǎn)要描述軟件的組織與操作。(若適用)描述應(yīng)包括:a)從用戶的角度,概述軟件邏輯部件和每個(gè)部件的用途操作。b)用戶可能期望的性能特性,例如:1)可接受的輸入的類型、數(shù)量、速率:2)軟件產(chǎn)生的輸出類型、數(shù)量、準(zhǔn)確性和速率:3)典型的響應(yīng)時(shí)間和影響它的因素;4)典型的處理時(shí)間和影響它的因索;5)限制,例如可追蹤的事件數(shù)目:6)預(yù)期的錯(cuò)誤率:7)預(yù)期的可靠性。c)該軟件執(zhí)行的功能與接口系統(tǒng)、組織或位置之間的關(guān)系。d)為管理軟件而能夠采取的監(jiān)控措施(例如口令〕3.5意外事故及運(yùn)行的備用狀態(tài)和方式(若適用)本條應(yīng)說(shuō)明在緊急時(shí)刻以及在不同運(yùn)行

溫馨提示

  • 1. 本站所有資源如無(wú)特殊說(shuō)明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁(yè)內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫(kù)網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

最新文檔

評(píng)論

0/150

提交評(píng)論