1 引言
1.1編寫目的
說明編寫這份數(shù)據(jù)要求說明書的目的,指出預(yù)期的讀者。
1.2背景
說明:
a.待開發(fā)軟件系統(tǒng)的名稱;
b.列出本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶以及將運(yùn)行該項(xiàng)軟件的計(jì)算站(中心)或計(jì)算機(jī)網(wǎng)絡(luò)系統(tǒng)。
1.3定義
列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。
1.4參考資料
列出有關(guān)的參考資料,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同,上級機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表文件;
c.本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號、發(fā)表日期和出版單位。說明能夠得到這些文件資料的來源。
2 數(shù)據(jù)的邏輯描述
對數(shù)據(jù)進(jìn)行邏輯描述時(shí)可把數(shù)據(jù)分為動態(tài)數(shù)據(jù)和靜態(tài)數(shù)據(jù)。所謂靜態(tài)數(shù)據(jù),指在運(yùn)行過程中主要作為參考的數(shù)據(jù),它們在很長的一段時(shí)間內(nèi)不會變化,一般不隨運(yùn)行而改變。所謂動態(tài)數(shù)據(jù).包括所有在運(yùn)行中要發(fā)生變化的數(shù)據(jù)以及在運(yùn)行中要輸入、輸出的數(shù)據(jù)。進(jìn)行描述時(shí)應(yīng)把各數(shù)據(jù)元素邏輯地分成若干組,列如函數(shù)、源數(shù)據(jù)或?qū)τ谄鋺?yīng)用更為恰當(dāng)?shù)倪壿嫹纸M。給出每一數(shù)據(jù)元的名稱(包括縮寫和代碼)、定義(或物理意義)度量單位、值域、格式和類型等有關(guān)信息。
2.1靜態(tài)數(shù)據(jù)
列出所有作為控制或參考用的靜態(tài)數(shù)據(jù)元素。
2.2動態(tài)輸人數(shù)據(jù)
列出動態(tài)輸入數(shù)據(jù)元素(包括在常規(guī)運(yùn)行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù))。
2.3動態(tài)輸出數(shù)據(jù)
列出動態(tài)輸出數(shù)據(jù)元素(包括在常規(guī)運(yùn)行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù))。
2.4內(nèi)部生成數(shù)據(jù)
列出向用戶或開發(fā)單位中的維護(hù)調(diào)試人員提供的內(nèi)部生成數(shù)據(jù)。
2.5數(shù)據(jù)約定
說明對數(shù)據(jù)要求的制約。逐條列出對進(jìn)一步擴(kuò)充或使用方面的考慮而提出的對數(shù)據(jù)要求的限制(容量、文卷、記錄和數(shù)據(jù)元的個(gè)數(shù)的最大值)。對于在設(shè)計(jì)和開發(fā)中確定是臨界性的限制更要明確指出。
3 數(shù)據(jù)的采集
3.1要求和范圍
按數(shù)據(jù)元的邏輯分組來說明數(shù)據(jù)采集的要求和范圍,指明數(shù)據(jù)的采集方法,說明數(shù)據(jù)采集工作的承擔(dān)者是用戶還是開發(fā)者。具體的內(nèi)容包括:
a.輸入數(shù)據(jù)的來源,例如是單個(gè)操作員、數(shù)據(jù)輸入站,專業(yè)的數(shù)據(jù)輸入公司或它們的一個(gè)分組;
b.?dāng)?shù)據(jù)輸入(指把數(shù)據(jù)輸入處理系統(tǒng)內(nèi)部)所用的媒體和硬設(shè)備。如果只有指定的輸入點(diǎn)的輸入才是合法的,則必須對此加以說明;
c.接受者說明輸出數(shù)據(jù)的接受者;
d.輸出數(shù)據(jù)的形式和設(shè)備列出輸出數(shù)據(jù)的形式和硬設(shè)備。無論接受者將接收到的數(shù)據(jù)是打印輸出,還是CRT上的一組字符、一幀圖形,或一聲警鈴,或向開關(guān)線圈提供的一個(gè)電脈沖,或常用介質(zhì)如磁盤、磁帶、穿孔卡片等,均應(yīng)具體說明;
e.?dāng)?shù)據(jù)值的范圍給出每一個(gè)數(shù)據(jù)元的合法值的范圍;
f.量綱給出數(shù)字的度量單位、增量的步長、零點(diǎn)的定標(biāo)等。在數(shù)據(jù)是非數(shù)字量的情況下,要給出每一種合法值的形式和含意;
g.更新和處理的頻度給出預(yù)定的對輸入數(shù)據(jù)的更新和處理的頻度。如果數(shù)據(jù)的輸入是隨機(jī)的,應(yīng)給出更新處理的頻度的平均值,或變化情況的某種其他度量。
3.2輸人的承擔(dān)者
說明預(yù)定的對數(shù)據(jù)輸入工作的承擔(dān)者。如果輸入數(shù)據(jù)同某一接口軟件有關(guān),還應(yīng)說明該接口軟件的來源。
3.3預(yù)處理
對數(shù)據(jù)的采集和預(yù)處理過程提出專門的規(guī)定,包括適合應(yīng)用的數(shù)據(jù)格式、預(yù)定的數(shù)據(jù)通信媒體和對輸入的時(shí)間要求等。對于需經(jīng)模擬轉(zhuǎn)換或數(shù)字轉(zhuǎn)換處理的數(shù)據(jù)量,要給出轉(zhuǎn)換方法和轉(zhuǎn)換因子等有關(guān)信息,以便軟件系統(tǒng)使用這些數(shù)據(jù)。
3.4 影響
說明這些數(shù)據(jù)要求對于設(shè)備、軟件、用戶、開發(fā)單位所可能產(chǎn)生的影響,例如要求用戶單位增設(shè)某個(gè)機(jī)構(gòu)等。
1 引言
1.1編寫目的
說明編寫這份概要設(shè)計(jì)說明書的目的,指出預(yù)期的讀者。
1.2背景
說明:
a.待開發(fā)軟件系統(tǒng)的名稱;
b.列出此項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶以及將運(yùn)行該軟件的計(jì)算站(中心)。
1.3定義
列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。
1.4參考資料
列出有關(guān)的參考文件,如:
a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同,上級機(jī)關(guān)的批文;
b.屬于本項(xiàng)目的其他已發(fā)表文件;
c.本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號、發(fā)表日期和出版單位,說明能夠得到這些文件資料的來源。
2 總體設(shè)計(jì)
2.1需求規(guī)定
說明對本系統(tǒng)的主要的輸入輸出項(xiàng)目、處理的功能性能要求,詳細(xì)的說明可參見附錄C。
2.2運(yùn)行環(huán)境
簡要地說明對本系統(tǒng)的運(yùn)行環(huán)境(包括硬件環(huán)境和支持環(huán)境)的規(guī)定,詳細(xì)說明參見附錄C。
2.3基本設(shè)計(jì)概念和處理流程
說明本系統(tǒng)的基本設(shè)計(jì)概念和處理流程,盡量使用圖表的形式。
2.4結(jié)構(gòu)
用一覽表及框圖的形式說明本系統(tǒng)的系統(tǒng)元素(各層模塊、子程序、公用程序等)的劃分,扼要說明每個(gè)系統(tǒng)元素的標(biāo)識符和功能,分層次地給出各元素之間的控制與被控制關(guān)系.
2.5功能需求與程序的關(guān)系
本條用一張如下的矩陣圖說明各項(xiàng)功能需求的實(shí)現(xiàn)同各塊程序的分配關(guān)系:
2.6人工處理過程
說明在本軟件系統(tǒng)的工作過程中不得不包含的人工處理過程(如果有的話)。
2.7尚未問決的問題
說明在概要設(shè)計(jì)過程中尚未解決而設(shè)計(jì)者認(rèn)為在系統(tǒng)完成之前必須解決的各個(gè)問題。
3 接口設(shè)計(jì)
3.1用戶接口
說明將向用戶提供的命令和它們的語法結(jié)構(gòu),以及軟件的回答信息。
3.2外部接口
說明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持軟件之間的接口關(guān)系。
3.3內(nèi)部接口
說明本系統(tǒng)之內(nèi)的各個(gè)系統(tǒng)元素之間的接口的安排。
4 運(yùn)行設(shè)計(jì)
4.1運(yùn)行模塊組合
說明對系統(tǒng)施加不同的外界運(yùn)行控制時(shí)所引起的各種不同的運(yùn)行模塊組合,說明每種運(yùn)行所歷經(jīng)的內(nèi)部模塊和支持軟件。
4.2運(yùn)行控制
說明每一種外界的運(yùn)行控制的方式方法和操作步驟。
4.3運(yùn)行時(shí)間
說明每種運(yùn)行模塊組合將占用各種資源的時(shí)間。
5 系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)
5.1邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)
給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)的名稱、標(biāo)識符以及它們之中每個(gè)數(shù)據(jù)項(xiàng)、記錄、文卷和系的標(biāo)識、定義、長度及它們之間的層次的或表格的相互關(guān)系。
5.2物理結(jié)構(gòu)設(shè)計(jì)要點(diǎn)
給出本系統(tǒng)內(nèi)所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)中的每個(gè)數(shù)據(jù)項(xiàng)的存儲要求,訪問方法、存取單位、存取的物理關(guān)系(索引、設(shè)備、存儲區(qū)域)、設(shè)計(jì)考慮和保密條件。
5.3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系
說明各個(gè)數(shù)據(jù)結(jié)構(gòu)與訪問這些數(shù)據(jù)結(jié)構(gòu)的形式:
6 系統(tǒng)出錯(cuò)處理設(shè)計(jì)
6.1出錯(cuò)信息
用一覽表的方式說朗每種可能的出錯(cuò)或故障情況出現(xiàn)時(shí),系統(tǒng)輸出信息的形式、含意及處理方法。
6.2補(bǔ)救措施
說明故障出現(xiàn)后可能采取的變通措施,包括:
a.后備技術(shù)說明準(zhǔn)備采用的后備技術(shù),當(dāng)原始系統(tǒng)數(shù)據(jù)萬一丟失時(shí)啟用的副本的建立和啟動的技術(shù),例如周期性地把磁盤信息記錄到磁帶上去就是對于磁盤媒體的一種后備技術(shù);
b.降效技術(shù)說明準(zhǔn)備采用的后備技術(shù),使用另一個(gè)效率稍低的系統(tǒng)或方法來求得所需結(jié)果的某些部分,例如一個(gè)自動系統(tǒng)的降效技術(shù)可以是手工操作和數(shù)據(jù)的人工記錄;
c.恢復(fù)及再啟動技術(shù)說明將使用的恢復(fù)再啟動技術(shù),使軟件從故障點(diǎn)恢復(fù)執(zhí)行或使軟件從頭開始重新運(yùn)行的方法。
6.3系統(tǒng)維護(hù)設(shè)計(jì)
說明為了系統(tǒng)維護(hù)的方便而在程序內(nèi)部設(shè)計(jì)中作出的安排,包括在程序中專門安排用于系統(tǒng)的檢查與維護(hù)的檢測點(diǎn)和專用模塊。