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