軟體開發標準(文件模板)
操作手冊(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基本設計概念和處理流程
說明本系統的基本設計概念和處理流程,儘量使用圖表的形式。
2.4結構
用一覽表及框圖的形式說明本系統的系統元素(各層模組、子程式、公用程式等)的劃分,扼要說明每個系統元素的識別符號和功能,分層次地給出各元素之間的控制與被控制關係.
2.5功能器求與程式的關係
本條用一張如下的矩陣圖說明各項功能需求的實現同各塊程式的分配關係:
程式1 程式2 …… 程式n
功能需求1 √
功能需求2 √
……
功能需求n √ √
2.6人工處理過程
說明在本軟體系統的工作過程中不得不包含的人工處理過程(如果有的話)。
2.7尚未問決的問題
說明在概要設計過程中尚未解決而設計者認為在系統完成之前必須解決的各個問題。
3介面設計
3.1使用者介面
說明將向用戶提供的命令和它們的語法結構,以及軟體的回答資訊。
3.2外部介面
說明本系統同外界的所有介面的安排包括軟體與硬體之間的介面、本系統與各支援軟體之間的介面關係。
3.3內部介面
說明本系統之內的各個系統元素之間的介面的安排。
4執行設計
4.1執行模組組合
說明對系統施加不同的外界執行控制時所引起的各種不同的執行模組組合,說明每種執行所歷經的內部模組和支援軟體。
4.2執行控制
說明每一種外界的執行控制的方式方法和操作步驟。
4.3執行時間
說明每種執行模組組合將佔用各種資源的時間。
5系統資料結構設計
5.1邏輯結構設計要點
給出本系統內所使用的每個資料結構的名稱、識別符號以及它們之中每個資料項、記錄、文卷和系的標識、定義、長度及它們之間的層次的或表格的相互關係。
5.2物理結構設計要點
給出本系統內所使用的每個資料結構中的每個資料項的儲存要求,訪問方法、存取單位、存取的物理關係(索引、裝置、儲存區域)、設計考慮和保密條件。
5.3資料結構與程式的關係
說明各個資料結構與訪問這些資料結構的形式:
6系統出錯處理設計
6.1出錯資訊
用一覽表的方式說朗每種可能的出錯或故障情況出現時,系統輸出資訊的形式、含意及處理方法。
6.2補救措施
說明故障出現後可能採取的變通措施,包括:
a. 後備技術說明準備採用的後備技術,當原始系統資料萬一丟失時啟用的副本的建立和啟動的技術,例如週期性地把磁碟資訊記錄到磁帶上去就是對於磁碟媒體的一種後備技術;
b. 降效技術說明準備採用的後備技術,使用另一個效率稍低的系統或方法來求得所需結果的某些部分,例如一個自動系統的降效技術可以是手工操作和資料的人工記錄;
c. 恢復及再啟動技術說明將使用的恢復再啟動技術,使軟體從故障點恢復執行或使軟體從頭開始重新執行的方法。
6.3系統維護設計
說明為了系統維護的方便而在程式內部設計中作出的安排,包括在程式中專門安排用於系統的檢查與維護的檢測點和專用模組。 各個程式之間的對應關係,可採用如下的矩陣圖的形式;
開發進度月報(GB8567——88)
1、標題
開發中的軟體系統的名稱和識別符號
分專案名稱和識別符號
分專案負責人簽名
本期月報編寫人簽名
本期月報的編號及所報告的年月
2、工程進度與狀態
2.1進度
列出本月內進行的各項主要活動,並且說明本月內遇到的重要事件,這裡所說的重要事件是指一個開發階段(即軟體生存週期內各個階段中的某一個,例如需求分析階段)的開始或結束,要說明階段名稱及開始(或結束)的日期。
2.2狀態
說明本月的實際工作進度與計劃相比,是提前了、按期完成了、或是推遲了?如果與計劃不一致,說 明原因及準備採取的措施。
3資額耗用與狀態
3.1資額耗用
主要說明本月份內耗用的工時與機時。
3.1.1工時
分為三類:
a. 管理用工時包括在專案管理(制訂計劃、佈置工作、收集資料、檢查彙報工作等)方面耗用的工時;
b. 服務工時包括為支援專案開發所必須的服務工作及非直接的開發工作所耗用的工時;
c. 開發用工時要分各個開發階段填寫。
3.1.2機時
說明本月內耗用的機時,以小時為單位,說明計算機系統的型號。
3.2狀態
說明本月內實際耗用的資源與計劃相比,是超出了、相一致、還是不到計劃數?如果與計劃不一致,說明原因及準備採取的措施。
4經費支出與狀態
4.1經費支出
4.1.1支援性費用
列出本月內支出的支援性費用,一般可按如下七類列出,並給出本月支援費用的總和:
a.房租或房屋折舊費;
b.社工資、獎金、補貼;
c.培訓費包括給教師的酬金及教室租金;
d.資料費包括影印及購買參考資料的費用;
e.會議費召集有關業務會議的費用;
f. 旅差費;
g.其他費用。
4.1.2裝置購置費
列出本月內支出的裝置購置費,一般可分如下三類:
a.購買軟體的名稱與金額;
b.購買硬裝置的名稱、型號、數量及金額;
c.已有硬裝置的折舊費。
4.2狀態
說明本月內實際支出的經費與計劃相比較,是超過了。相符合、還是不到計劃數?如果與計劃不一致,說明原因及準備採取的措施。
5下個月的工作計劃
6建議
本月遇到的重要問題和應引起重視的問題以及因此產生的建議。
可行性研究報告GB8567——88
1引言
1.1編寫目的
說明編寫本可行性研究報告的目的,指出預期的讀者。
1.2背景
說明:
A. 所建議開發的軟體系統的名稱;
B. 本專案的任務提出者、開發者、使用者及實現該軟體的計算中心或計算機網路;
C. 該軟體系統同其他系統或其他機構的基本的相互來往關係。
1.3定義
列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。
1.4參考資料
列出用得著的參考資料,如:
1. 本專案的經核準的計劃任務書或合同、上級機關的批文;
2. 屬於本專案的其他已發表的檔案;
3. 本檔案中各處引用的檔案、資料,包括所需用到的軟體開發標準。
列出這些檔案資料的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的來源。
2、可行性研究的前提
說明對所建議的開發專案進行可行性研究的前提,如要求、目標、假定、限制等。
2.1要求
說明對所建議開發的軟體的基本要求,如:
A. 功能;
B. 效能;
C. 輸出如報告、檔案或資料,對每項輸出要說明其特徵,如用途、產生頻度、介面以及分發物件;
D. 輸入說明系統的輸入,包括資料的來源、型別、數量、資料的組織以及提供的頻度;
E. 處理流程和資料流程用圖表的方式表示出最基本的資料流程和處理流程輔之以敘述;
F. 在安全與保密方面的要求;
G. 同本系統相連線的其他系統;
H. 完成期限。
2.2目標
說明所建議系統的主要開發目標,如:
A. 人力與裝置費用的減少;
B. 處理速度的提高;
C. 控制精度或生產能力的提高;
D. 管理資訊服務的改進;
E. 自動決策系統的改進;
F. 人員利用率的改進。
2.3條件、假定和限制
說明對這項開發中給出的條件、假定和所受到的限制,如:
a. 所建議系統的執行壽命的最小值;
b.進行系統方案選擇比較的時間;
c. 經費、投資方面的來源和限制;
d.法律和政策方面的限制;
e. 硬體、軟體、執行環境和開發環境方面的條件和限制;
f. 可利用的資訊和資源;
g. 系統投入使用的最晚時間。
2.4進行可行性研究的方法
說明這項可行性研究將是如何進行的,所建議的系統將是如何評價的。摘要說明所使用的基本方法 和策略,如調查、加權、確定模型、建立基準點或模擬等。
2.5評價尺度
說明對系統進行評價時所使用的主要尺度,如費用的多少、各項功能的優先次序、開發時間的長短 及使用中的難易程度。
3對現有系統的分析
這裡的現有系統是指當前實際使用的系統,這個系統可能是計算機系統,也可能是一個機械系統甚 至是一個人工系統。
分析現有系統的目的是為了進一步闡明建議中的開發新系統或修改現有系統的必要性。
3.1處理流程和資料流程
說明現有系統的基本的處理流程和資料流程。此流程可用圖表即流程圖的形式表示,並加以敘述。
3.2工作負荷
列出現有系統所承擔的工作及工作量。
3.3費用開支
列出由於執行現有系統所引起的費用開支,如人力、裝置、空間、支援性服務、材料等項開支以及開 支總額。
3.4人員
列出為了現有系統的執行和維護所需要的人員的專業技術類別和數量。
3.5裝置
列出現有系統所使用的各種裝置。
3.6侷限性
列出本系統的主要的侷限性,例如處理時間趕不上需要,響應不及時,資料儲存能力不足,處理功能 不夠等。並且要說明,為什麼對現有系統的改進性維護已經不能解決問題。
4所建議的系統
本章將用來說明所建議系統的目標和要求將如何被滿足。
4.1對所建議系統的說明
概括地說明所建議系統,並說明在第2章中列出的那些要求將如何得到滿足,說明所使用的基本方法及理論根據。
4.2處理流程和資料流程
給出所建議系統的處理流程和資料流程。
4.3改進之處
按2.2條中列出的目標,逐項說明所建議系統相對於現存系統具有的改進。
4.4影響
說明在建立所建議系統時,預期將帶來的影響,包括:
4.4.1對裝置的影響
說明新提出的裝置要求及對現存系統中尚可使用的裝置須作出的修改。
4.4.2對軟體的影響
說明為了使現存的應用軟體和支援軟體能夠同所建議系統相適應。而需要對這些軟體所進行的修改和補充。
4.4.3對使用者單位機構的影響
說明為了建立和執行所建議系統,對使用者單位機構、人員的數量和技術水平等方面的全部要求。
4.4.4對系統執行過程的影響
說明所建議系統對執行過程的影響,如:
a. 使用者的操作規程;
b.執行中心的操作規程;
c. 執行中心與使用者之間的關係;
d.源資料的處理;
e. 資料進入系統的過程;
f. 對資料儲存的要求,對資料儲存、恢復的處理;
g. 輸出報告的處理過程、儲存媒體和排程方法;
h. 系統失效的後果及恢復的處理辦法。
4.4.5對開發的影響
說明對開發的影響,如:
a. 為了支援所建議系統的開發,使用者需進行的工作;
b. 為了建立一個數據庫所要求的資料資源;
c. 為了開發和測驗所建議系統而需要的計算機資源;
d. 所涉及的保密與安全問題。
4.4.6對地點和設施的影響
說明對建築物改造的要求及對環境設施的要求。
4.4.7對經費開支的影響
扼要說明為了所建議系統的開發,設計和維持執行而需要的各項經費開支。
4.5侷限性
說明所建議系統尚存在的侷限性以及這些問題未能消除的原因。
4.6技術條件方面的可行性
本節應說明技術條件方面的可行性,如:
a. 在當前的限制條件下,該系統的功能目標能否達到;
b.利用現有的技術,該系統的功能能否實現;
c. 對開發人員的數量和質量的要求並說明這些要求能否滿足;
d.在規定的期限內,本系統的開發能否完成。
5可選擇的其他系統方案
扼要說明曾考慮過的每一種可選擇的系統方案,包括需開發的和可從國內國外直接購買的,如果沒有供選擇的系統方案可考慮,則說明這一點。
5.1可選擇的系統方案1
參照第4章的提綱,說明可選擇的系統方案1,並說明它未被選中的理由。
5.2可選擇的系統方案2
按類似5.1條的方式說明第2個乃至第n個可選擇的系統方案。
......
6投資及效益分析
6.1支出
對於所選擇的方案,說明所需的費用。如果已有一個現存系統,則包括該系統繼續執行期間所需的費用。
6.1.1基本建設投資
包括採購、開發和安裝下列各項所需的費用,如:
房屋和設施;
ADP裝置;
資料通訊裝置;
環境保護裝置;
安全與保密裝置;
ADP作業系統的和應用的軟體;
資料庫管理軟體。
6.1.2其他一次性支出
包括下列各項所需的費用,如:
a. 研究(需求的研究和設計的研究);
b.開發計劃與測量基準的研究;
c. 資料庫的建立;
d.ADP軟體的轉換;
e. 檢查費用和技術管理性費用;
f. 培訓費、旅差費以及開發安裝人員所需要的一次性支出;
g. 人員的退休及調動費用等。
6.1.3非一次性支出
列出在該系統生命期內按月或按季或按年支出的用於執行和維護的費用,包括:
a. 裝置的租金和維護費用;
b.軟體的租金和維護費用;
c. 資料通訊方面的租金和維護費用;
d.人員的工資、獎金;
e. 房屋、空間的使用開支;
f. 公用設施方面的開支;
g. 保密安全方面的開支;
h. 其他經常性的支出等。
6.2收益
對於所選擇的方案,說明能夠帶來的收益,這裡所說的收益,表現為開支費用的減少或避免、差錯的減少、靈活性的增加、動作速度的提高和管理計劃方面的改進等,包括;
6.2.1一次性收益
說明能夠用人民幣數目表示的一次性收益,可按資料處理、使用者、管理和支援等項分類敘述,如:
a. 開支的縮減包括改進了的系統的執行所引起的開支縮減,如資源要求的減少,執行效率的改進,資料進入、存貯和恢復技術的改進,系統性能的可監控,軟體的轉換和優化,資料壓縮技術的採用,處理的集中化/分佈化等;
b.價值的增升包括由於一個應用系統的使用價值的增升所引起的收益,如資源利用的改進,管理和執行效率的改進以及出錯率的減少等;
c. 其他如從多餘裝置出售回收的收入等。
6.2.2非一次性收益
說明在整個系統生命期內由於執行所建議系統而導致的按月的、按年的能用人民幣數目表示的收益,包括開支的減少和避免。
6.2.3不可定量的收益
逐項列出無法直接用人民幣表示的收益,如服務的改進,由操作失誤引起的風險的減少,資訊掌握情況的改進,組織機構給外界形象的改善等。有些不可捉摸的收益只能大概估計或進行極值估計(按最好和最差情況估計)。
6.3收益/投資比
求出整個系統生命期的收益/投資比值。
6.4投資回收週期
求出收益的累計數開始超過支出的累計數的時間。
6.5敏感性分析
所謂敏感性分析是指一些關鍵性因素如系統生命期長度、系統的工作負荷量、工作負荷的型別與這些不同型別之間的合理搭配、處理速度要求、裝置和軟體的配置等變化時,對開支和收益的影響最靈敏的範圍的估計。在敏感性分析的基礎上做出的選擇當然會比單一選擇的結果要好一些。
7社會因素方面的可行性
本章用來說明對社會因素方面的可行性分析的結果,包括:
7.1法律方面的可行性
法律方面的可行性問題很多,如合同責任、侵犯專利權、侵犯版權等方面的陷井,軟體人員通常是不熟悉的,有可能陷入,務必要注意研究。
7.2使用方面的可行性
例如從使用者單位的行政管理、工作制度等方面來看,是否能夠使用該軟體系統;從使用者單位的工作人員的素質來看,是否能滿足使用該軟體系統的要求等等,都是要考慮的。
8結論
在進行可行性研究報告的編制時,必須有一個研究的結論。結論可以是:
a. 可以立即開始進行;
b.需要推遲到某些條件(例如資金、人力、裝置等)落實之後才能開始進行;
c. 需要對開發目標進行某些修改之後才能開始進行;
d.不能進行或不必進行(例如因技術不成熟、經濟上不合算等)。
模組開發卷宗(GB8567——88)
1標題
軟體系統名稱和識別符號
模組名稱和識別符號(如果本卷宗包含多於一個的模組,則用這組模組的功能標識代替模組名)
程式編制員簽名
卷宗的修改文字序號
修改完成日期
卷宗序號(說明本卷宗在整個卷宗中的序號)
編排日期(說明整個卷宗最近的一次編排日期)
2模組開發情況表
3功能說明
扼要說明本模組(或本組模組)的功能,主要是輸入、要求的處理、輸出。可以從系統設計說明書中摘錄。同時列出在軟體需求說明書中對這些功能的說明的章、條、款。
4設計說明
說明本模組(或本組模組)的設計考慮,包括:
a. 在系統設計說明書中有關對本模組(或本組模組)設計考慮的敘述,包括本模組在軟體系統中所處的層次,它同其他模組的介面;
b. 在程式設計說明書中有關對本模組(或本組模組)的設計考慮,包括本模組的演算法、處理流程、牽涉到的資料文卷設計限制、驅動方式和出錯資訊等;
c. 在編制目前已通過全部測試的原始碼時實際使用的設計考慮。
5原始碼清單
要給出所產生的本模組(或本組模組)的第一份無語法錯的原始碼清單以及已通過全部測試的當前有效的原始碼清單。
6測試說明
說明直接要經過本模組(或本組模組)的每一項測試,包括這些測試各自的識別符號和編號、進行這些測試的目的、所用的配置和輸入、預期的輸出及實際的輸出。
7複審的結論
把實際測試的結果,同軟體需求說明書、系統設計說明書、程式設計說明書中規定的要求進行比較和給出結論。
軟體需求說明書的編寫提示(GB856T——88)
1引言
1.1編寫目的
說明編寫這份軟體需求說明書的目的,指出預期的讀者。
1.2背景
說明:
a. 待開發的軟體系統的名稱;
b. 本專案的任務提出者、開發者、使用者及實現該軟體的計算中心或計算機網路;
c. 該軟體系統同其他系統或其他機構的基本的相互來往關係。
1.3定義
列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。
1.4參考資料
列出用得著的參考資料,如:
a. 本專案的經核準的計劃任務書或合同、上級機關的批文;
b. 屬於本專案的其他已發表的檔案;
c. 本檔案中各處引用的檔案、資料、包括所要用到的軟體開發標準。 列出這些檔案資料的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的來源。
2任務概述
2.1目標
敘述該項軟體開發的意圖、應用目標、作用範圍以及其他應向讀者說明的有關該軟體開發的背景材料。解釋被開發軟體與其他有關軟體之間的關係。如果本軟體產品是一項獨立的軟體,而且全部內容自含,則說明這一點。如果所定義的產品是一個更大的系統的一個組成部分,則應說明本產品與該系統中其他各組成部分之間的關係,為此可使用一張方框圖來說明該系統的組成和本產品同其他各部分的聯絡和介面。|
2.2使用者的特點
列出本軟體的終端使用者的特點,充分說明操作人員、維護人員的教育水平和技術專長,以及本軟體的預期使甩頻度。這些是軟體設計工作的重要約束
2.3假定和約束
列出進行本軟體開發工作的假定和約束,例如經費限制、開發期限等。
3需求規定
3.1對功能的規定
用列表的方式(例如IPO表即輸入、處理、輸出表的形式),逐項定量和定性地敘述對軟體所提出的功能要求,說明輸入什麼量、經怎樣的處理、得到什麼輸出,說明軟體應支援的終端數和應支援的並行操作的使用者數。
3.2對效能的規定
3.2.1精度
說明對該軟體的輸入、輸出資料精度的要求,可能包括傳輸過程中的精度。
3.2.2時間特性要求
說明對於該軟體的時間特性要求,如對:
a. 響應時間;
b. 更新處理時間;
c. 資料的轉換和傳送時間;
d. 解題時間;等的要求。
3.2.3靈活性
說明對該軟體的靈活性的要求,即當需求發生某些變化時,該軟體對這些變化的適應能力,如:
a. 操作方式上的變化;
b. 執行環境的變化;
c. 同其他軟體的介面的變化;
d. 精度和有效時限的變化;
e. 計劃的變化或改進。
對於為了提供這些靈活性而進行的專門設計的部分應該加以標明。
3.3輸人輸出要求
解釋各輸入輸出資料型別,並逐項說明其媒體、格式、數值範圍、精度等。對軟體的資料輸出及必須標明的控制輸出量進行解釋並舉例,包括對硬拷貝報告(正常結果輸出、狀態輸出及異常輸出)以及圖形或顯示報告的描述。
3.4資料管理能力要求
說明需要管理的文卷和記錄的個數、表和文卷的大小規模,要按可預見的增長對資料及其分量的儲存要求作出估算。
3.5故障處理要求
列出可能的軟體、硬體故障以及對各項效能而言所產生的後果和對故障處理的要求。
3.6其他專門要求
如使用者單位對安全保密的要求,對使用方便的要求,對可維護性、可補充性、易讀性、可靠性、執行環境可轉換性的特殊要求等。
4執行環境規定
4.1裝置
列出執行該軟體所需要的硬裝置。說明其中的新型裝置及其專門功能,包括:
a. 處理器型號及記憶體容量;
b. 外存容量、聯機或離線、媒體及其儲存格式,裝置的型號及數量;
c. 輸入及輸出裝置的型號和數量,聯機或離線;
d. 資料通訊裝置的型號和數量;
e. 功能鍵及其他專用硬體
4.2支援軟體
列出支援軟體,包括要用到的作業系統、編譯(或彙編)程式、測試支援軟體等。
4.3介面
說明該軟體同其他軟體之間的介面、資料通訊協議等。
4.4控制
說明控制該軟體的執行的方法和控制訊號,並說明這些控制訊號的來源。
資料庫設計說明書(GB8567——88)
1引言
1.1編寫目的
說明編寫這份資料庫設計說明書的目的,指出預期的讀者。
1.2背景
說明:
a. 說明待開發的資料庫的名稱和使用此資料庫的軟體系統的名稱;
b. 列出該軟體系統開發專案的任務提出者、使用者以及將安裝該軟體和這個資料庫的計算站(中心)。
1.3定義
列出本檔案中用到的專門術語的定義、外文首字母組詞的原片語。
1.4參考資料
列出有關的參考資料:
a. 本專案的經核準的計劃任務書或合同、上級機關批文;
b. 屬於本專案的其他已發表的檔案;
c. 本檔案中各處引用到的檔案資料,包括所要用到的軟體開發標準。
列出這些檔案的標題、檔案編號、發表日期和出版單位,說明能夠取得這些檔案的來源。
2外部設計
2.1識別符號和狀態
聯絡用途,詳細說明用於唯一地標識該資料庫的程式碼、名稱或識別符號,附加的描述性資訊亦要給出。如果該資料庫屬於尚在實驗中、尚在測試中或是暫時使用的,則要說明這一特點及其有效時間範圍。
2.2使用它的程式
列出將要使用或訪問此資料庫的所有應用程式,對於這些應用程式的每一個,給出它的名稱和版本號。
2.3約定
陳述一個程式設計師或一個系統分析員為了能使用此資料庫而需要了解的建立標號、標識的約定,例如用於標識資料庫的不同版本的約定和用於標識庫內各個文卷、、記錄、資料項的命名約定等。
2.4專門指導
向準備從事此資料庫的生成、從事此資料庫的測試、維護人員提供專門的指導,例如將被送入資料庫的資料的格式和標準、送入資料庫的操作規程和步驟,用於產生、修改、更新或使用這些資料文卷的操作指導。如果這些指導的內容篇幅很長,列出可參閱的檔案資料的名稱和章條。
2.5支援軟體
簡單介紹同此資料庫直接有關的支援軟體,如資料庫管理系統、儲存定位程式和用於裝入、生成、修 改、更新資料庫的程式等。說明這些軟體的名稱、版本號和主要功能特性,如所用資料模型的型別、允許 的資料容量等。列出這些支援軟體的技術檔案的標題、編號及來源。
3結構設計
3.1概念結構設計
說明本資料庫將反映的現實世界中的實體、屬性和它們之間的關係等的原始資料形式,包括各資料項、記錄、系、文卷的識別符號、定義、型別、度量單位和值域,建立本資料庫的每一幅使用者檢視。
3.2邏輯結構設計
說明把上述原始資料進行分解、合併後重新組織起來的資料庫全域性邏輯結構,包括所確定的關鍵字和屬性、重新確定的記錄結構和文卷結構、所建立的各個文卷之間的相互關係,形成本資料庫的資料庫管理員檢視。
3.3物理結構設計
建立系統程式設計師檢視,包括:
a. 資料在記憶體中的安排,包括對索引區、緩衝區的設計;
b. 所使用的外存裝置及外存空間的組織,包括索引區、資料塊的組織與劃分;
c. 訪問資料的方式方法。
4運用設計
4.1資料字典設計
對資料庫設計中涉及到的各種專案,如資料項、記錄、系、文卷、模式、子模式等一般要建立起資料字典,以說明它們的識別符號、同義名及有關資訊。在本節中要說明對此資料字典設計的基本考慮。
4.2安全保密設計
說明在資料庫的設計中,將如何通過區分不同的訪問者、不同的訪問型別和不同的資料物件,進行分別對待而獲得的資料庫安全保密的設計考慮。
資料要求說明書(GB856T——88)
1引言
1.1編寫目的
說明編寫這份資料要求說明書的目的,指出預期的讀者。
1.2背景
說明:
a. 待開發軟體系統的名稱;
b.列出本專案的任務提出者、開發者、使用者以及將執行該項軟體的計算站(中心)或計算機網路系統。
1.3定義
列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。
1.4參考資料
列出有關的參考資料,如:
a. 本專案的經核準的計劃任務書或合同,上級機關的批文;
b. 屬於本專案的其他已發表檔案;
c. 本檔案中各處引用的檔案、資料,包括所要用到的軟體開發標準。列出這些檔案的標題、檔案編號、發表日期和出版單位。說明能夠得到這些檔案資料的來源。
2資料的邏輯描述
對資料進行邏輯描述時可把資料分為動態資料和靜態資料。所謂靜態資料,指在執行過程中主要作為參考的資料,它們在很長的一段時間內不會變化,一般不隨執行而改變。所謂動態資料,包括所有在執行中要發生變化的資料以及在執行中要輸入、輸出的資料。進行描述時應把各資料元素邏輯地分成若干組,列如函式、源資料或對於其應用更為恰當的邏輯分組。給出每一資料元的名稱(包括縮寫和程式碼)、定義(或物理意義)度量單位、值域、格式和型別等有關資訊。
2.1靜態資料
列出所有作為控制或參考用的靜態資料元素。
2.2動態輸人資料
列出動態輸入資料元素(包括在常規執行中或聯機操作中要改變的資料)。
2.3動態輸出資料
列出動態輸出資料元素(包括在常規執行中或聯機操作中要改變的資料)。
2.4內部生成資料
列出向用戶或開發單位中的維護除錯人員提供的內部生成資料。
2.5資料約定
說明對資料要求的制約。逐條列出對進一步擴充或使用方面的考慮而提出的對資料要求的限制(容 量、文卷、記錄和資料元的個數的最大值)。對於在設計和開發中確定是臨界性的限制更要明確指出。
3資料的採集
3.1要求和範圍
按資料元的邏輯分組來說明資料採集的要求和範圍,指明資料的採集方法,說明資料採集工作的承擔者是使用者還是開發者。具體的內容包括:
a. 輸入資料的來源,例如是單個操作員、資料輸入站,專業的資料輸入公司或它們的一個分組;
b. 資料輸入(指把資料輸入處理系統內部)所用的媒體和硬裝置。如果只有指定的輸入點的輸入才是合法的,則必須對此加以說明;
c. 接受者說明輸出資料的接受者;
d. 輸出資料的形式和裝置列出輸出資料的形式和硬裝置。無論接受者將接收到的資料是列印輸出,還是CRT上的一組字元、一幀圖形,或一聲警鈴,或向開關線圈提供的一個電脈衝,或常用介質如磁碟、磁帶、穿孔卡片等,均應具體說明;
e. 資料值的範圍給出每一個數據元的合法值的範圍;
f. 量綱給出數字的度量單位、增量的步長、零點的定標等。在資料是非數字量的情況下,要給出每一種合法值的形式和含意;
g. 更新和處理的頻度給出預定的對輸入資料的更新和處理的頻度。如果資料的輸入是隨機的,應給出更新處理的頻度的平均值,或變化情況的某種其他度量。
3.2輸人的承擔者
說明預定的對資料輸入工作的承擔者。如果輸入資料同某一介面軟體有關,還應說明該介面軟體的來源。
3.3預處理
對資料的採集和預處理過程提出專門的規定,包括適合應用的資料格式、預定的資料通訊媒體和對輸入的時間要求等。對於需經模擬轉換或數字轉換處理的資料量,要給出轉換方法和轉換因子等有關資訊,以便軟體系統使用這些資料。
3.4影響
說明這些資料要求對於裝置、軟體、使用者、開發單位所可能產生的影響,例如要求使用者單位增設某個機構等。
檔案給制實施規定的例項(GB8567-88)
儘管在檔案編制中存在著很多靈活性,然而,檔案的編制確實是非常必要的,其意義如前所述。為了控制這種靈活性,保證檔案編制能達到應該達到的目的,對於具體的軟體開發任務,應編制的檔案的種類、詳細程度應取決於承擔開發單位的管理能力、任務的規模、複雜性和成敗風險等因素。一個軟體開發單位應該根據本單位經營承包的應用軟體的專業特點和本單位的管理能力,制定一個檔案編制實施規定,說明在什麼情況下應該編制哪些檔案。由於國內目前在這方面還缺乏成熟的經驗,這裡提供參考國外經驗制定的兩個例子,用以向國內軟體開發單位說明如何建立這種實施規定,使專案負責人能確定本專案開發過程中應編制的檔案的種類。當然,例子畢竟只是例子,這兩個例子各自都不免有其片面性,它們兩者之間也不免有不一致之處,之所以列出來無非是供國內軟體開發單位參考。
例1:
此例規定用求和法來確定應編制的檔案。該方法的要點是提出十二個考慮因素來衡量一個應用軟,件,每個因素可能取值的範圍是互至5。任務負責人可用這十二個因素對所要開發的程式進行衡量,確定每個因素的具體值。把這十二個因素的值相加,得到一個總和。然後由這個總和的值來確定應該編制的檔案的種類。使用這個方法的具體過程如下:
a. 按表OI中的十二個因素衡量所要開發的程式,得到每個因素的值;
b. 把衡量所得的各個因素的值相加,得總和之值;
c. 根據總和之值,從表OZ查出應編制的檔案的種類。
表1檔案編制的十二項衡量因素
序號 因素 因素取值準則
1 2 3 4 5
1 創造性要求 沒有——在不同的裝置上重程式設計序 很少——具有嚴格的要求 有限——具有新的介面 相當多——應用現有的技巧 重大的——應用先進的技巧
2 通用程度 很強的限制——單一目標 有限制——功能的範圍是參量化的 有限的靈活性允許格式上有某些變化 多用途,靈活的格式有一個主題領域 很靈活——能在不同的裝置上處理範圍廣泛的主題
3 工作範圍 區域性單位 分指揮部 單個指揮部 多個指揮部 國防部,世界範圍
4 目標範圍的變化 沒有 極少 偶爾有 經常 不斷
5 裝置複雜性 單機,常規處理 單機,常規處理,擴充的外設系統 多機,標準外設系統 多機,複雜的外設系統 主機控制系統,多機,自動I/O和顯示
6 人員 1~2人 3~5人 5~10人 10~18人 18人以上
7 開發投資 6人月以下 6人月至3人年 3人年至10人年 10人年至30人年 30人年以上
8 重要程度 資料處理 常規過程控制 人身安全 單位成敗 國家安全
9 對程式改變的完成時間要求 2周以上 1~2周 3~7天 1~3天 24小時以內
10 對資料輸入的響應時間要求 2周以上 1~2周 1~7天 1~24小時 60分鐘內
11 程式語言 高階語言 高階語言帶一些彙編 高階語言帶相當多的彙編 組合語言 機器語言
12 並行的軟體開發 沒有 有限 中等程度 很多 完全的並行開發
表1檔案編制的十二項衡量因素
因素總和 可行性研究報告 專案開發計劃 軟體需求說明書 資料要求說明書 概要設計說明書 詳細設計說明書 資料庫設計說明書 使用者手冊(使用說明) 操作手冊 模組開發卷宗 測試設計 測試分析報告 專案開發總結報告 開發制度月報
12~18*
14~24
24~38
38~50
48~60
√
√
√ √
√
√
√
√
√
√
√
√
***
***
***
***
√
√
√
***
***
***
*** √
√
√
√
√
√
√
√
√
√
√
√
√
√
√
√
**
**
√
√ √
√
√
√
√
√
√
√
√
*在因素總和較低的情況下,專案開發總結報告的內容應包括:程式的主要功能、基本流程、測試結果和使用說明。
**測試分析報告應該寫,但不必很正規。
***資料要求說明和資料庫設計說明是否需要編寫應根據所開發軟體的實際需要來決定。
例2:
為了避免在軟體開發中檔案編制的不足或過分,一個簡便的辦法是把對軟體檔案的編制要求同軟體的規模大小聯絡起來,這就是本例的出發點。軟體的規模不妨分為四級:
1. 小規模軟體源程式行數小於5000的軟體;
2. 中規模軟體源程式行數為10000~50000的軟體;
3. 大規模軟體源程式行數為100000—500000的軟體;
4. 特大規模軟體源程式行數大於500000的軟體。
對上述的四級軟體的檔案編制要求分別列於表3。
至於源程式行數為5000~10000,50000~100000的軟體,其檔案編制要求介於兩級之間,可根據一個軟體產品的具體情況,由專案負責人蔘照表3的規定,確定需要編制的檔案種類。
對於源程式行數大於500000的特大規模軟體,可進一步把本指南規定的十四種檔案按實際需要擴充套件成更多種類。
詳細設計說明書(GB8567——88)
1引言
1.1編寫目的
說明編寫這份詳細設計說明書的目的,指出預期的讀者。
1.2背景
說明:
a. 待開發軟體系統的名稱;
b. 本專案的任務提出者、開發者、使用者和執行該程式系統的計算中心。
1.3定義
列出本檔案中用到專門術語的定義和外文首字母組詞的原片語。
1.4參考資料
列出有關的參考資料,如:
a. 本專案的經核準的計劃任務書或合同、上級機關的批文;
b. 屬於本專案的其他已發表的檔案;
c. 本檔案中各處引用到的檔案資料,包括所要用到的軟體開發標準。列出這些檔案的標題、檔案編號、發表日期和出版單位,說明能夠取得這些檔案的來源。
2程式系統的結構
用一系列圖表列出本程式系統內的每個程式(包括每個模組和子程式)的名稱、識別符號和它們之間 的層次結構關係。
3程式1(識別符號)設計說明
從本章開始,逐個地給出各個層次中的每個程式的設計考慮。以下給出的提綱是針對一般情況的。對於一個具體的模組,尤其是層次比較低的模組或子程式,其很多條目的內容往往與它所隸屬的上一層 模組的對應條目的內容相同,在這種情況下,只要簡單地說明這一點即可。
3.1程式描述
給出對該程式的簡要描述,主要說明安排設計本程式的目的意義,並且,還要說明本程式的特點(如 是常駐記憶體還是非常駐?是否子程式?是可重人的還是不可重人的?有無覆蓋要求?是順序處理還是併發處理等)。
3.2功能
說明該程式應具有的功能,可採用IPO圖(即輸入一處理一輸出圖)的形式。
3.3效能
說明對該程式的全部效能要求,包括對精度、靈活性和時間特性的要求。
3.4輸人項
給出對每一個輸入項的特性,包括名稱、標識、資料的型別和格式、資料值的有效範圍、輸入的方式。數量和頻度、輸入媒體、輸入資料的來源和安全保密條件等等。
3.5輸出項
給出對每一個輸出項的特性,包括名稱、標識、資料的型別和格式,資料值的有效範圍,輸出的形式、數量和頻度,輸出媒體、對輸出圖形及符號的說明、安全保密條件等等。
3.6演算法
詳細說明本程式所選用的演算法,具體的計算公式和計算步驟。
3.7流程邏輯
用圖表(例如流程圖、判定表等)輔以必要的說明來表示本程式的邏輯流程。
3.8介面
用圖的形式說明本程式所隸屬的上一層模組及隸屬於本程式的下一層模組、子程式,說明引數賦值和呼叫方式,說明與本程式相直接關聯的資料結構(資料庫、資料文卷)。
3.9儲存分配
根據需要,說明本程式的儲存分配。
3.10註釋設計
說明準備在本程式中安排的註釋,如:
a. 加在模組首部的註釋;
b. 加在各分枝點處的註釋;
c. 對各變數的功能、範圍、預設條件等所加的註釋;
d. 對使用的邏輯所加的註釋等等。
3.11限制條件
說明本程式執行中所受到的限制條件。
3.12測試計劃
說明對本程式進行單體測試的計劃,包括對測試的技術要求、輸入資料、預期結果、進度安排、人員職責、裝置條件驅動程式及樁模組等的規定。
3.13尚未解決的問題
說明在本程式的設計中尚未解決而設計者認為在軟體完成之前應解決的問題。
4程式2(識別符號)設計說明
專案開發計劃(GB856T——88)
1、引言
1.1編寫目的
說明:編寫這份軟體專案開發計劃的目的,並指出預期的讀者。
1.2 背景
說明:
a. 待開發的軟體系統的名稱;
b. 本專案的任務提出者、開發者、使用者及實現該軟體的計算中心或計算機網路;
c. 該軟體系統同其他系統或其他機構的基本的相互來往關係。
1.3定義
列出本檔案中用到的專門術語的定義和外文的首字母組詞的原片語。
1.4參考資料
列出用得著的參考資料,如:
a. 本專案的經核準的計劃任務書和合同、上級機關的批文;
b. 屬於本專案的其他已發表的檔案;
c. 本檔案中各處引用的檔案、資料,包括所要用到的軟體開發標準。列出這些檔案資料的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的來源。
2專案概述
2.1工作內容
簡要地說明在本專案的開發中須進行的各項主要工作。
2.2主要參加人員
扼要說明參加本專案開發的主要人員的情況,包括他們的技術水平。
2.3產品
2.3.1程式
列出須移交給使用者的程式的名稱、所用地程式語言及儲存程式的媒體形式,並通過引用相關檔案,逐項說明其功能和能力。
2.3.2檔案
列出須移交使用者的每種檔案的名稱及內容要點。
2.3.3服務
列出需向用戶提供的各項服務,如培訓安裝、維護和執行支援等,應逐項規定開始日期、所提供支援的級別和服務的期限。
2.3.4非移交的產品
說明開發集體應向本單位交出但不必向用戶移交的產品(檔案甚至某些程式)。
2.4驗收標準
對於上述這些應交出的產品和服務,逐項說明或引用資料說明驗收標準。
2.5完成專案的最遲期限
2.6本計劃的批准者和批准日期
3實施計劃
3.1工作任務的分解與人員分工
對於專案開發中需要完成的各項工作,從需求分析、設計、實現、測試直到維護,包括檔案的編制、審批、列印、分發工作,使用者培訓工作,軟體安裝工作等,按層次進行分解,指明每項任務的負責人和參加人員。
3.2說明
負責介面工作的人員及他們的職責,包括:
a.負責本專案同用戶的介面人員;
b. 本專案同本單位各管理機構,如合同計劃管理部門、財務部門、質量管理部門等的介面人員;
c. 負責本專案同個份合同負責單位的介面人員等。
3.3進度
對於需求分析、設計、編碼實現、測試、移交、培訓和安裝等工作,給出每項工作任務的預定開始日期、完成日期及所需資源,規定各項工作任務完成的先後順序以及表徵每項工作任務完成的標誌性事件(即所謂“里程碑)。
3.4預算
逐項列出本開發專案所需要的勞務(包括人員的數量和時間)以及經費的預算(包括辦公費、差旅費、機時費、資料費、通訊裝置和專用裝置的租金等)和來源。
3.5關鍵問題
逐項列出能夠影響整個專案成敗的關鍵問題、技術難點和風險,指出這些問題對專案的影響。
4支援條件
說明為支援本專案的開發所需要的各種條件和設施。
4.1計算機系統支援
逐項列出開發中和執行時所需的計算機系統支援,包括計算機、外圍裝置、通訊裝置、模擬器、編譯(或彙編)程式、作業系統、資料管理程式包、資料儲存能力和測試支援能力等,逐項給出有關到貨日期、使用時間的要求。
4.2需由使用者承擔的工作
逐項列出需要使用者承擔的工作和完成期限。包括需由使用者提供的條件及提供時間。
4.3由外單位提供的條件
逐項列出需要外單位分合同承包者承擔的工作和完成的時間,包括需要由外單位提供的條件和提供的時間。
5專題計劃要點
說明本專案開發中需制定的各個專題計劃(如分合同計劃、開發人員培訓計劃、測試計劃、安全保密計劃、質量保證計劃、配置管理計劃、使用者培訓計劃、系統安裝計劃等)的要點。
用類似F.3的方式,說明第2個程式乃至第N個程式的設計考慮。
專案開發總結報告(GB8567——88)
1引言
1.1編寫目的
說明編寫這份專案開發總結報告的目的,指出預期的閱讀範圍。
1.2背景
說明:
a. 本專案的名稱和所開發出來的軟體系統的名稱;
b. 此軟體的任務提出者、開發者、使用者及安裝此軟體的計算中心。
1.3定義
列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。
1.4參考資料
列出要用到的參考資料,如:
a. 本專案的已核準的計劃任務書或合同、上級機關的批文;
b. 屬於本專案的其他已發表的檔案;
c. 本檔案中各處所引用的檔案、資料,包括所要用到的軟體開發標準。列出這些檔案的標題、檔案編號、發表日期和出版單位,說明能夠得到這些檔案資料的來源。
2實際開發結果
2.1產品
說明最終制成的產品,包括:
a. 程式系統中各個程式的名字,它們之間的層次關係,以千位元組為單位的各個程式的程式量、儲存媒體的形式和數量;
b. 程式系統共有哪幾個版本,各自的版本號及它們之間的區別;
c. 每個檔案的名稱;
d. 所建立的每個資料庫。 如果開發中制訂過配置管理計劃,要同這個計劃相比較。
2.2主要功能和效能
逐項列出本軟體產品所實際具有的主要功能和效能,對照可行性研究報告、專案開發計劃、功能需求說明書的有關內容,說明原定的開發目標是達到了、未完全達到、或超過了。
2.3基本流程
用圖給出本程式系統的實際的基本的處理流程。
2.4進度
列出原定計劃進度與實際進度的對比,明確說明,實際進度是提前了、還是延遲了,分析主要原因。
2.5費用
列出原定計劃費用與實際支出費用的對比,包括:
a. 工時,以人月為單位,並按不同級別統計;
b. 計算機的使用時間,區別CPU時間及其他裝置時間;
c. 物料消耗、出差費等其他支出。
明確說明,經費是超出了、還是節餘了,分析其主要原因。
3開發工作評價
3.1對生產效率的評價
給出實際生產效率,包括:
a. 程式的平均生產效率,即每人月生產的行數;
b. 檔案的平均生產效率,即每人月生產的千字數;
並列出原訂計劃數作為對比。
3.2對產品質量的評價
說明在測試中檢查出來的程式編制中的錯誤發生率,即每幹條指令(或語句)中的錯誤指令數(或語句數)。如果開發中制訂過質量保證計劃或配置管理計劃,要同這些計劃相比較。
3.3對技術方法的評價
給出對在開發中所使用的技術、方法、工具、手段的評價。
3.4出錯原因的分析
給出對於開發中出現的錯誤的原因分析。
4經驗與教訓
列出從這項開發工作中所得到的最主要的經驗與教訓及對今後的專案開發工作的建
......
使用者手冊(GB8567——88)
1引言
1.1編寫目的
說明編寫這份使用者手冊的目的,指出預期的讀者。
1.2背景
說明:
a. 這份使用者手冊所描述的軟體系統的名稱;
b. 該軟體專案的任務提出者、開發者、使用者(或首批使用者)及安裝此軟體的計算中心。
1.3定義
列出本檔案中用到的專門術語的定義和外文首字母組詞的原片語。
1.4參考資料
列出有用的參考資料,如:
a. 專案的經核準的計劃任務書或合同、上級機關的批文;
b. 屬於本專案的其他已發表檔案;
c. 本檔案中各處引用的檔案、資料,包括所要用到的軟體開發標準。列出這些檔案資料的標題、檔案編號、發表日期和出版單位,說明能夠取得這些檔案資料的來源。
2用途
2.1功能
結合本軟體的開發目的逐項地說明本軟體所具有各項功能以及它們的極限範圍。
2.2效能
2.2.1精度
逐項說明對各項輸入資料的精度要求和本軟體輸出資料達到的精度,包括傳輸中的精度要求。
2.2.2時間特性
定量地說明本軟體的時間特性,如響應時間,更新處理時間,資料傳輸、轉換時間,計算時間等。
2.2.3靈活性
說明本軟體所具有的靈活性,即當用戶需求(如對操作方式、執行環境、結果精度、時間特性等的要求)有某些變化時,本軟體的適應能力。
2.3安全保密
說明本軟體在安全、保密方面的設計考慮和實際達到的能力。
3執行環境
3.1硬裝置
列出為執行本軟體所要求的硬裝置的最小配置,如:
a. 處理機的型號、記憶體容量;
b. 所要求的外儲存器、媒體、記錄格式、裝置的型號和臺數、聯機/離線;
c. I/O裝置(聯機/離線?);
d. 資料傳輸裝置和轉換裝置的型號、臺數。
3.2支援軟體
說明為執行本軟體所需要的支援軟體,如:
a. 作業系統的名稱、版本號;
b. 程式語言的編譯/彙編系統的名稱和版本號;
c. 資料庫管理系統的名稱和版本號;
d. 其他支援軟體。
3.3資料結構
列出為支援本軟體的執行所需要的資料庫或資料文卷。
4使用過程
在本章,首先用圖表的形式說明軟體的功能同系統的輸入源機構、輸出接收機構之間的關係。
4.1安裝與初始化
一步一步地說明為使用本軟體而需進行的安裝與初始化過程,包括程式的儲存形式、安裝與初始化過程中的全部操作命令、系統對這些命令的反應與答覆。表徵安裝工作完成的測試例項等。如果有的話,還應說明安