6、詳細(xì)設(shè)計(jì)說(shuō)明書(shū)
1 引言
1.1編寫(xiě)目的
說(shuō)明編寫(xiě)這份詳細(xì)設(shè)計(jì)說(shuō)明書(shū)的目的,指出預(yù)期的讀者。
1.2背景
說(shuō)明:
a.待開(kāi)發(fā)軟件系統(tǒng)的名稱;
b.本項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶和運(yùn)行該程序系統(tǒng)的計(jì)算中心。
1.3定義
列出本文件中用到專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。
1.4參考資料
列出有關(guān)的參考資料,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同、上級(jí)機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表的文件;
c.本文件中各處引用到的文件資料,包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位,說(shuō)明能夠取得這些文件的來(lái)源。
2 程序系統(tǒng)的結(jié)構(gòu)
用一系列圖表列出本程序系統(tǒng)內(nèi)的每個(gè)程序(包括每個(gè)模塊和子程序)的名稱、標(biāo)識(shí)符和它們之間的層次結(jié)構(gòu)關(guān)系。
3 程序1(標(biāo)識(shí)符)設(shè)計(jì)說(shuō)明
從本章開(kāi)始,逐個(gè)地給出各個(gè)層次中的每個(gè)程序的設(shè)計(jì)考慮。以下給出的提綱是針對(duì)一般情況的。對(duì)于一個(gè)具體的模塊,尤其是層次比較低的模塊或子程序,其很多條目的內(nèi)容往往與它所隸屬的上一層模塊的對(duì)應(yīng)條目的內(nèi)容相同,在這種情況下,只要簡(jiǎn)單地說(shuō)明這一點(diǎn)即可。
3.1程序描述
給出對(duì)該程序的簡(jiǎn)要描述,主要說(shuō)明安排設(shè)計(jì)本程序的目的意義,并且,還要說(shuō)明本程序的特點(diǎn)(如是常駐內(nèi)存還是非常駐?是否子程序?是可重人的還是不可重人的?有無(wú)覆蓋要求?是順序處理還是并發(fā)處理卜…..等)。
3.2功能
說(shuō)明該程序應(yīng)具有的功能,可采用IPO圖(即輸入—處理—輸出圖)的形式。
3.3性能
說(shuō)明對(duì)該程序的全部性能要求,包括對(duì)精度、靈活性和時(shí)間特性的要求。
3.4輸人項(xiàng)
給出對(duì)每一個(gè)輸入項(xiàng)的特性,包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入的方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來(lái)源和安全保密條件等等。
3. 5輸出項(xiàng)
給出對(duì)每一個(gè)輸出項(xiàng)的特性,包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式,數(shù)據(jù)值的有效范圍,輸出的形式、數(shù)量和頻度,輸出媒體、對(duì)輸出圖形及符號(hào)的說(shuō)明、安全保密條件等等。
3.6算法
詳細(xì)說(shuō)明本程序所選用的算法,具體的計(jì)算公式和計(jì)算步驟。
3.7流程邏輯
用圖表(例如流程圖、判定表等)輔以必要的說(shuō)明來(lái)表示本程序的邏輯流程。
3.8接口
用圖的形式說(shuō)明本程序所隸屬的上一層模塊及隸屬于本程序的下一層模塊、子程序,說(shuō)明參數(shù)賦值和調(diào)用方式,說(shuō)明與本程序相直接關(guān)聯(lián)的數(shù)據(jù)結(jié)構(gòu)(數(shù)據(jù)庫(kù)、數(shù)據(jù)文卷)。
3.9存儲(chǔ)分配
根據(jù)需要,說(shuō)明本程序的存儲(chǔ)分配。
3.10注釋設(shè)計(jì)
說(shuō)明準(zhǔn)備在本程序中安排的注釋,如:
a.加在模塊首部的注釋;
b.加在各分枝點(diǎn)處的注釋;對(duì)各變量的功能、范圍、缺省條件等所加的注釋;
d.對(duì)使用的邏輯所加的注釋等等。
3.11限制條件
說(shuō)明本程序運(yùn)行中所受到的限制條件。
3.12測(cè)試計(jì)劃
說(shuō)明對(duì)本程序進(jìn)行單體測(cè)試的計(jì)劃,包括對(duì)測(cè)試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn)度安排、人員職責(zé)、設(shè)備條件驅(qū)動(dòng)程序及樁模塊等的規(guī)定。
3.13尚未解決的問(wèn)題
說(shuō)明在本程序的設(shè)計(jì)中尚未解決而設(shè)計(jì)者認(rèn)為在軟件完成之前應(yīng)解決的問(wèn)題。
4 程序2(標(biāo)識(shí)符)設(shè)計(jì)說(shuō)明
用類似3的方式,說(shuō)明第2個(gè)程序乃至第N個(gè)程序的設(shè)計(jì)考慮。
7、數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)
1 引言
1.1編寫(xiě)目的
說(shuō)明編寫(xiě)這份數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)的目的,指出預(yù)期的讀者。
1.2背景
說(shuō)明:
a.說(shuō)明待開(kāi)發(fā)的數(shù)據(jù)庫(kù)的名稱和使用此數(shù)據(jù)庫(kù)的軟件系統(tǒng)的名稱;
b.列出該軟件系統(tǒng)開(kāi)發(fā)項(xiàng)目的任務(wù)提出者、用戶以及將安裝該軟件和這個(gè)數(shù)據(jù)庫(kù)的計(jì)算站(中心)。
1.3定義
列出本文件中用到的專門術(shù)語(yǔ)的定義、外文首字母組詞的原詞組。
1.4參考資料
列出有關(guān)的參考資料:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同、上級(jí)機(jī)關(guān)批文;
b.屬于本項(xiàng)目的其他已發(fā)表的文件;
c.本文件中各處引用到的文件資料,包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。
列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位,說(shuō)明能夠取得這些文件的來(lái)源。
2 外部設(shè)計(jì)
2.1標(biāo)識(shí)符和狀態(tài)
聯(lián)系用途,詳細(xì)說(shuō)明用于唯一地標(biāo)識(shí)該數(shù)據(jù)庫(kù)的代碼、名稱或標(biāo)識(shí)符,附加的描述性信息亦要給出。如果該數(shù)據(jù)庫(kù)屬于尚在實(shí)驗(yàn)中、尚在測(cè)試中或是暫時(shí)使用的,則要說(shuō)明這一特點(diǎn)及其有效時(shí)間范圍。
2.2使用它的程序
列出將要使用或訪問(wèn)此數(shù)據(jù)庫(kù)的所有應(yīng)用程序,對(duì)于這些應(yīng)用程序的每一個(gè),給出它的名稱和版本號(hào)。
2.3約定
陳述一個(gè)程序員或一個(gè)系統(tǒng)分析員為了能使用此數(shù)據(jù)庫(kù)而需要了解的建立標(biāo)號(hào)、標(biāo)識(shí)的約定,例如用于標(biāo)識(shí)數(shù)據(jù)庫(kù)的不同版本的約定和用于標(biāo)識(shí)庫(kù)內(nèi)各個(gè)文卷、、記錄、數(shù)據(jù)項(xiàng)的命名約定等。
2.4專門指導(dǎo)
向準(zhǔn)備從事此數(shù)據(jù)庫(kù)的生成、從事此數(shù)據(jù)庫(kù)的測(cè)試、維護(hù)人員提供專門的指導(dǎo),例如將被送入數(shù)據(jù)庫(kù)的數(shù)據(jù)的格式和標(biāo)準(zhǔn)、送入數(shù)據(jù)庫(kù)的操作規(guī)程和步驟,用于產(chǎn)生、修改、更新或使用這些數(shù)據(jù)文卷的操作指導(dǎo)。如果這些指導(dǎo)的內(nèi)容篇幅很長(zhǎng),列出可參閱的文件資料的名稱和章條。
2.5支持軟件
簡(jiǎn)單介紹同此數(shù)據(jù)庫(kù)直接有關(guān)的支持軟件,如數(shù)據(jù)庫(kù)管理系統(tǒng)、存儲(chǔ)定位程序和用于裝入、生成、修改、更新數(shù)據(jù)庫(kù)的程序等。說(shuō)明這些軟件的名稱、版本號(hào)和主要功能特性,如所用數(shù)據(jù)模型的類型、允許的數(shù)據(jù)容量等。列出這些支持軟件的技術(shù)文件的標(biāo)題、編號(hào)及來(lái)源。
3 結(jié)構(gòu)設(shè)計(jì)
3.1概念結(jié)構(gòu)設(shè)計(jì)
說(shuō)明本數(shù)據(jù)庫(kù)將反映的現(xiàn)實(shí)世界中的實(shí)體、屬性和它們之間的關(guān)系等的原始數(shù)據(jù)形式,包括各數(shù)據(jù)項(xiàng)、記錄、系、文卷的標(biāo)識(shí)符、定義、類型、度量單位和值域,建立本數(shù)據(jù)庫(kù)的每一幅用戶視圖。
3.2邏輯結(jié)構(gòu)設(shè)計(jì)
說(shuō)明把上述原始數(shù)據(jù)進(jìn)行分解、合并后重新組織起來(lái)的數(shù)據(jù)庫(kù)全局邏輯結(jié)構(gòu),包括所確定的關(guān)鍵字和屬性、重新確定的記錄結(jié)構(gòu)和文卷結(jié)構(gòu)、所建立的各個(gè)文卷之間的相互關(guān)系,形成本數(shù)據(jù)庫(kù)的數(shù)據(jù)庫(kù)管理員視圖。
3.3物理結(jié)構(gòu)設(shè)計(jì)
建立系統(tǒng)程序員視圖,包括:
a.?dāng)?shù)據(jù)在內(nèi)存中的安排,包括對(duì)索引區(qū)、緩沖區(qū)的設(shè)計(jì);
b.所使用的外存設(shè)備及外存空間的組織,包括索引區(qū)、數(shù)據(jù)塊的組織與劃分;
c.訪問(wèn)數(shù)據(jù)的方式方法。
4 運(yùn)用設(shè)計(jì)
4.1數(shù)據(jù)字典設(shè)計(jì)
對(duì)數(shù)據(jù)庫(kù)設(shè)計(jì)中涉及到的各種項(xiàng)目,如數(shù)據(jù)項(xiàng)、記錄、系、文卷、模式、子模式等一般要建立起數(shù)據(jù)字典,以說(shuō)明它們的標(biāo)識(shí)符、同義名及有關(guān)信息。在本節(jié)中要說(shuō)明對(duì)此數(shù)據(jù)字典設(shè)計(jì)的基本考慮。
4.2安全保密設(shè)計(jì)
說(shuō)明在數(shù)據(jù)庫(kù)的設(shè)計(jì)中,將如何通過(guò)區(qū)分不同的訪問(wèn)者、不同的訪問(wèn)類型和不同的數(shù)據(jù)對(duì)象,進(jìn)行分別對(duì)待而獲得的數(shù)據(jù)庫(kù)安全保密的設(shè)計(jì)考慮。