軟體需求說明書/ 概要設計說明書/專案開發計劃/詳細設計說明書模版(說明要點及要點解釋)
轉自:https://www.cnblogs.com/peizhe123/p/5511505.html
一、軟體需求說明書
1引言 2
1.1編寫目的 2
1.2背景 2
1.3定義 2
1.4參考資料 2
2任務概述 2
2.1目標 2
2.2使用者的特點 3
2.3假定和約束 3
3需求規定 3
3.1對功能的規定 3
3.2對效能的規定 3
3.2.1精度 3
3.2.2時間特性要求 3
3.2.3靈活性 4
3.3輸人輸出要求 4
3.4資料管理能力要求 4
3.5故障處理要求 4
3.6其他專門要求 5
4執行環境規定 5
4.1裝置 5
4.2支援軟體 5
4.3介面 5
4.4控制 5
軟體需求說明書的編寫提示
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控制
說明控制該軟體的執行的方法和控制訊號,並說明這些控制訊號的來源。
二、概要設計說明書
1引言 2
1.1編寫目的 2
1.2背景 2
1.3定義 2
1.4參考資料 2
2總體設計 2
2.1需求規定 2
2.2執行環境 2
2.3基本設計概念和處理流程 3
2.4結構 3
2.5功能器求與程式的關係 3
2.6人工處理過程 3
2.7尚未問決的問題 3
3介面設計 3
3.1使用者介面 3
3.2外部介面 3
3.3內部介面 4
4執行設計 4
4.1執行模組組合 4
4.2執行控制 4
4.3執行時間 4
5系統
5.1邏輯結構設計要點 4
5.2物理結構設計要點 4
5.3資料結構與程式的關係 4
6系統出錯處理設計 5
6.1出錯資訊 5
6.2補救措施 5
6.3系統維護設計 5
概要設計說明書
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系統維護設計
說明為了系統維護的方便而在程式內部設計中作出的安排,包括在程式中專門安排用於系統的檢查與維護的檢測點和專用模組。 各個程式之間的對應關係,可採用如下的矩陣圖的形式;
三、專案開發計劃
1引言 1
1.1編寫目的 1
1.2 背景 1
1.3定義 1
1.4參考資料 1
2專案概述 1
2.1工作內容 1
2.2主要參加人員 1
2.3產品 2
2.3.1程式 2
2.3.2檔案 2
2.3.3服務 2
2.3.4非移交的產品 2
2.4驗收標準 2
2.5完成專案的最遲期限 2
2.6本計劃的批准者和批准日期 2
3實施計劃 2
3.1工作任務的分解與人員分工 2
3.2介面人員 3
3.3進度 3
3.4預算 3
3.5關鍵問題 3
4支援條件 3
4.1計算機系統支援 3
4.2需由使用者承擔的工作 3
4.3由外單位提供的條件 4
5專題計劃要點 4
專案開發計劃(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專題計劃要點
說明本專案開發中需制定的各個專題計劃(如分合同計劃、開發人員培訓計劃、測試計劃、安全保密計劃、質量保證計劃、配置管理計劃、使用者培訓計劃、系統安裝計劃等)的要點。
四、詳細設計說明書
1引言 2
1.1編寫目的 2
1.2背景 2
1.3定義 2
1.4參考資料 2
2程式系統的結構 2
3程式1(識別符號)設計說明 2
3.1程式描述 3
3.2功能 3
3.3效能 3
3.4輸人項 3
3.5輸出項 3
3.6演算法 3
3.7流程邏輯 3
3.8介面 3
3.9儲存分配 4
3.10註釋設計 4
3.11限制條件 4
3.12測試計劃 4
3.13尚未解決的問題 4
4程式2(識別符號)設計說明 4
詳細設計說明書
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(識別符號)設計說明
用類似F.3的方式,說明第2個程式乃至第N個程式的設計考慮。
......