1. 程式人生 > >軟體設計文件國家標準

軟體設計文件國家標準

操作手冊(GB8567——88)

1引言

1.1編寫目的

說明編寫這份操作手冊的目的,指出預期的讀者。

1.2前景

說明:

a.  這份操作手冊所描述的軟體系統的名稱;

b.  該軟體專案的任務提出者、開發者、使用者(或首批使用者)及安裝該軟體的計算中心。

1.3定義

列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。

1.4參考資料

列出有用的參考資料,如:

a.  本專案的經核準的計劃任務書或合同、上級機關的批文;

b.  屬於本專案的其他已發表的檔案;

c.  本檔案中各處引用的檔案、資料,包括所列出的這些檔案資料的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的來源。

2軟體徵述

2.1軟體的結構

結合軟體系統所具有的功能包括輸入、處理和輸出提供該軟體的總體結構圖表。

2.2程式表

列出本系統內每個程式的識別符號、編號和助記名。

2.3文卷表

列出將由本系統引用、建立或更新的每個永久性文卷,說明它們各自的識別符號、編號、助記名、儲存媒體和儲存要求。

3安裝與初始化

一步一步地說明為使用本軟體而需要進行的安裝與初始化過程,包括程式的存載形式,安裝與初始化過程中的全部操作命令,系統對這些命令的反應與答覆,表徵安裝工作完成的測試例項等。如果有的話,還應說明安裝過程中所需用到的專用軟體。

4執行說明

所謂一個執行是指提供一個啟動控制資訊後,直到計算機系統等待另一個啟動控制資訊時為止的計算機系統執行的全部過程。

4.1執行表

列出每種可能的執行,摘要說明每個執行的目的,指出每個執行各自所執行的程式。

4.2執行步驟

說明從一個執行轉向另一個執行以完成整個系統執行的步驟。

4.3執行1(識別符號)說明

把執行1的有關資訊,以對操作人員為最方便最有用的形式加以說明。

4.3.1執行控制

列出為本執行所需要”的執行流向控制的說明。

4.3.2操作資訊

給出為操作中心的操作人員和管理人員所需要的資訊,如:

a.  執行目的;

b.  操作要求;

c. 啟動方法 如應請啟動(由所遇到的請求資訊啟動)、預定時間啟動、…,··等;

d.  預計的執行時間和解題時間;

e.  操作命令;

f.  與執行有聯絡的其他事項。

4.3.3輸入一輸出文卷

提供被本執行建立、更新或訪問的資料文卷的有關資訊,如:

a. 文卷的識別符號或標號;

b. 記錄媒體;

c.  存留的目錄表;

d. 文卷的支配如確定保留或廢棄的準則、是否要分配給其他接受者、佔用硬裝置的優先順序以及保密控制等有關規定。

4.3.4輸出文段

提供本軟體輸出的每一一個用於提示、說明、或應答的文段(包括“選單”)的有關資訊,如:

a.  文段的識別符號;

b.  輸出媒體(螢幕顯示、列印、……);

c.  文字容量;

d.  分發物件;

e.  保密要求。

4.3.5輸出文段的複製

對由計算機產生,而後需用其他方法複製的那些文段提供有關資訊,如:

a. 文段的識別符號;

b. 複製的技術手段;

c. 紙張或其他媒體的規格;

d. 裝訂要求;

e. 分發物件;

f. 複製份數。

4.3.6恢復過程

說明本執行故障後的恢復過程。

4.4執行2(識別符號)說明

用與本手冊4.3條相類似的方式介紹另一個執行的有關資訊。

5非常規過程

提供有關應急操作或非常規操作的必要資訊,如出錯處理操作、向後備系統的切換操作以及其他必須向程式維護人員交待的事項和步驟。

6遠端操作

如果本軟體能夠通過遠端終端控制執行,則在本章說明通過遠端終端執行本軟體的操作過程。

測試分析報告(GB8567——88)

1引言

1.1編寫目的

說明這份測試分析報告的具體編寫目的,指出預期的閱讀範圍。

1.2背景

說明:

a. 被測試軟體系統的名稱;

b. 該軟體的任務提出者、開發者、使用者及安裝此軟體的計算中心,指出測試環境與實際執行環境 之間可能存在的差異以及這些差異對測試結果的影響。

1.3定義

列出本檔案中用到的專問術語的定義和外文首字母組詞的原片語。

1.4參考資料

列出要用到的參考資料,如:

a.本專案的經核準的計劃任務書或合同、上級機關的批文;

b.屬於本專案的其他已發表的檔案;

c.本檔案中各處引用的檔案、資料,包括所要用到的軟體開發標準。列出這些檔案的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的來源。

2測試概要

用表格的形式列出每一項測試的識別符號及其測試內容,並指明實際進行的測試工作內容與測試計劃中預先設計的內容之間的差別,說明作出這種改變的原因。

3測試結果及發現

3.1測試1(識別符號)

把本項測試中實際得到的動態輸出(包括內部生成資料輸出)結果同對於動態輸出的要求進行比較,陳述其中的各項發現。

3.2測試2(識別符號)

用類似本報告3.1條的方式給出第 2項及其後各項測試內容的測試結果和發現。

4對軟體功能的結論

4.1功能1(識別符號)

4.1.1能力

簡述該項功能,說明為滿足此項功能而設計的軟體能力以及經過一項或多項測試已證實的能力。

4.1.2限制

說明測試資料值的範圍(包括動態資料和靜態資料),列出就這項功能而言,測試期間在該軟體中查出的缺陷、侷限性。

4.2功能2(識別符號)

用類似本報告4.l的方式給出第2項及其後各項功能的測試結論。....

5分析摘要

5.1能力

陳述經測試證實了的本軟體的能力。如果所進行的測試是為了驗證一項或幾項特定效能要求的實現,應提供這方面的測試結果與要求之間的比較,並確定測試環境與實際執行環境之間可能存在的差異對能力的測試所帶來的影響。

5.2缺陷和限制

陳述經測試證實的軟體缺陷和限制,說明每項缺陷和限制對軟體效能的影響,並說明全部測得的效能缺陷的累積影響和總影響。

5.3建議

對每項缺陷提出改進建議,如:

a.各項修改可採用的修改方法;

b.各項修改的緊迫程度;

c.各項修改預計的工作量;

d.各項修改的負責人。

5.4評價

說明該項軟體的開發是否已達到預定目標,能否交付使用。

6測試資源消耗

總結測試工作的資源消耗資料,如工作人員的水平級別數量、機時消耗等。

測試計劃(GB8567——88)

1引言

1.1編寫目的

本測試計劃的具體編寫目的,指出預期的讀者範圍。

1.2背景

說明:

a. 測試計劃所從屬的軟體系統的名稱;

b. 該開發專案的歷史,列出使用者和執行此專案測試的計算中心,說明在開始執行本測試計劃之前必須完成的各項工作。

1.3定義

列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。

1.4參考資料

列出要用到的參考資料,如:

a.本專案的經核準的計劃任務書或合同、上級機關的批文;

b.屬於本專案的其他已發表的檔案;

c.本檔案中各處引用的檔案、資料,包括所要用到的軟體開發標準。列出這些檔案的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的來源。

2計劃

2.1軟體說明

提供一份圖表,並逐項說明被測軟體的功能、輸入和輸出等質量指標,作為敘述測試計劃的提綱。

2.2測試內容

列出組裝測試和確認測試中的每一項測試內容的名稱識別符號、這些測試的進度安排以及這些測試的內容和目的,例如模組功能測試、介面正確性測試、資料文卷存取的測試、執行時間的測試、設計約束和極限的測試等。

2.3測試1(識別符號)

給出這項測試內容的參與單位及被測試的部位。

2.3.1進度安排

給出對這項測試的進度安排,包括進行測試的日期和工作內容(如熟悉環境。培訓、準備輸入資料等)。

2.3.2條件

陳述本項測試工作對資源的要求,包括:

a.  裝置所用到的裝置型別、數量和預定使用時間;

b.  軟體列出將被用來支援本項測試過程而本身又並不是被測軟體的組成部分的軟體,如測試驅動程式、測試監控程式、模擬程式、樁模組等等;

c.  人員列出在測試工作期間預期可由使用者和開發任務組提供的工作人員的人數。技術水平及有關的預備知識,包括一些特殊要求,如倒班操作和資料鍵入人員。

2.3.3測試資料

列出本項測試所需的資料,如:

a.  有關本項任務的檔案;

b.  被測試程式及其所在的媒體;

c.  測試的輸入和輸出舉例;

d.  有關控制此項測試的方法、過程的圖表。

2.3.4測試培訓

說明或引用資料說明為被測軟體的使用提供培訓的計劃。規定培訓的內容、受訓的人員及從事培訓的工作人員。

2.4測試2(識別符號)

用與本測試計劃2.3條相類似的方式說明用於另一項及其後各項測試內容的測試工作計劃。

3測試設計說明

3.1測試1(識別符號)

說明對第一項測試內容的測試設計考慮。

3.1.1控制

說明本測試的控制方式,如輸入是人工、半自動或自動引入、控制操作的順序以及結果的記錄方法。

3.1.2輸入

說明本項測試中所使用的輸入資料及選擇這些輸入資料的策略。

3.1.3輸出

說明預期的輸出資料,如測試結果及可能產生的中間結果或執行資訊。

3.1.4過程

說明完成此項測試的一個個步驟和控制命令,包括測試的準備、初始化、中間步聚和執行結束方式。

3.2測試2(識別符號)

用與本測試計劃3.l條相類似的方式說明第2項及其後各項測試工作的設計考慮。

4評價準則

4.1範圍

說明所選擇的測試用例能夠接查的範圍及其侷限性。

4.2資料整理

陳述為了把測試資料加工成便於評價的適當形式,使得測試結果可以同,已知結果進行比較而要用到的轉換處理技術,如手工方式或自動方式;如果是用自動方式整理資料,還要說明為進行處理而要用到的硬體、軟體資源。

4.3尺度

說明用來判斷測試工作是否能通過的評價尺度,如合理的輸出結果的型別、測試輸出結果與預期輸出之間的容許偏離範圍、允許中斷或停機的最大次數。

概要設計說明書(GB8567——88)

1引言

1.1編寫目的

說明編寫這份概要設計說明書的目的,指出預期的讀者。

1.2背景

說明:

a. 待開發軟體系統的名稱;

b. 列出此專案的任務提出者、開發者、使用者以及將執行該軟體的計算站(中心)。

1.3定義

列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。

1.4參考資料

列出有關的參考檔案,如:

a.本專案的經核準的計劃任務書或合同,上級機關的批文;

b.屬於本專案的其他已發表檔案;

c. 本檔案中各處引用的檔案、資料,包括所要用到的軟體開發標準。列出這些檔案的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的來源。

2總體設計

2.1需求規定

說明對本系統的主要的輸入輸出專案、處理的功能效能要求,詳細的說明可參見附錄C。

2.2執行環境

簡要地說明對本系統的執行環境(包括硬體環境和支援環境)的規定,詳細說明參見附錄C。

2.3基本設計概念和處理流程

說明本系