軟件工程文檔標準.pdf

《軟件工程文檔標準.pdf》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫。

1、A.1軟件開發(fā)文件模板（規(guī)范性附錄）A.1.1軟件需求說明書軟件需求說明書項目名稱：委托單位：承擔單位：編寫：年月日校對：年月日審核:年月日批準:年月日《軟件需求說明書》的編制是為了使用戶和軟件開發(fā)者雙方對該軟件的初始規(guī)定有一個共同的理解，使之成為整個開發(fā)工作的基礎(chǔ)。《軟件需求說明書》編制指導(dǎo)如下。1引言1.1編寫目的說明編寫這份《軟件需求說明書》的目的，指出預(yù)期的讀者。1.2背景說明待開發(fā)的軟件系統(tǒng)的名稱、版本號說明、本項目的任務(wù)提出者、開發(fā)者、用戶以及該軟件系統(tǒng)同其他系統(tǒng)的關(guān)系。1.3修訂審批記錄說明編寫這份《軟件需求說明書》的修訂過程、審批過程。參

2、見文檔修訂記錄表及文檔審批記錄表。表1文檔修訂記錄表修訂記錄章節(jié)修訂日期版本修訂描述修訂者審核者表2文檔審批記錄表審批記錄審批方式審批日期版本文檔所有者提交者審批者1.4術(shù)語和縮寫詞列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.5參考資料列出本文件中用到的參考資料（參考格式：作者、名稱、出版單位、發(fā)表日期等）。2任務(wù)概述2.1目標敘述該項軟件開發(fā)的意圖、應(yīng)用目標、作用范圍以及其他應(yīng)向讀者說明的有關(guān)該軟件開發(fā)的背景材料。2.2業(yè)務(wù)需求敘述本軟件最終用戶的原始業(yè)務(wù)需求，包括：業(yè)務(wù)現(xiàn)狀、預(yù)期功能需求、預(yù)期性能需求以及其他專門需求，為需求分析提供

3、支持。2.3用戶特點列出本軟件的最終用戶的特點，充分說明操作人員、維護人員的教育水平和技術(shù)專長，以及本軟件的預(yù)期使甩頻度。這些是軟件設(shè)計工作的重要約束。2.4假設(shè)和約束列出進行本軟件開發(fā)工作的假定和約束，例如經(jīng)費限制、開發(fā)期限等。3總體需求23.1組織結(jié)構(gòu)繪出待開發(fā)軟件系統(tǒng)最終用戶的組織結(jié)構(gòu)圖，并對各組織的作用以及相互關(guān)系加以說明。3.2業(yè)務(wù)流程說明待開發(fā)軟件系統(tǒng)的業(yè)務(wù)流程。此流程可用圖表即流程圖的形式表示，并加以敘述。3.3數(shù)據(jù)流程說明待開發(fā)軟件系統(tǒng)的數(shù)據(jù)流程。此流程可用圖表即流程圖的形式表示，并加以敘述。4需求規(guī)定4.1功能需求從以下四個部分，詳細敘

4、述每一類功能或每一個功能對軟件所提出的功能要求，說明輸入什么量、經(jīng)過怎樣處理、得到什么輸出：(1)引言該功能要達到的目標、所采用的方法和技術(shù)。還應(yīng)清楚說明該功能意圖的由來和背景。(2)輸入該功能的所有輸入以及輸入操作時控制細節(jié)的需求。(3)加工定義輸入數(shù)據(jù)、中間參數(shù)，以及獲得預(yù)期輸出結(jié)果的全部操作。它包括如下的說明：輸入數(shù)據(jù)的有效性檢查；操作的順序；響應(yīng)，例如，溢出、通信故障、錯誤處理等；用于把系統(tǒng)輸入變換成相應(yīng)輸出的任何方法（方程式、數(shù)學(xué)算法、邏輯操作等）；輸出數(shù)據(jù)的有效性檢查。(4)輸出該功能所有輸出以及非法值的處理、出錯信息。4.2性能需求說明對該

5、軟件的輸入、輸出數(shù)據(jù)精度的要求、對時間特性要求以及對對靈活性的要求。4.3其他專門需求說明對安全保密的要求、對使用方便的要求以及對可靠性、維護性、可擴充性的特殊要求等。5運行環(huán)境規(guī)定5.1設(shè)備列出運行該軟件所需要的硬設(shè)備。5.2支持軟件環(huán)境列出支持軟件,包括要用到的操作系統(tǒng)、編譯（或匯編）程序、測試支持軟件等。5.3接口說明該軟件同其他軟件之間的接口、數(shù)據(jù)通信協(xié)議等。3A.1.2系統(tǒng)設(shè)計說明書系統(tǒng)設(shè)計說明書項目名稱：委托單位：承擔單位：編寫：年月日校對：年月日審核:年月日批準:年月日4Q/SYXJXXXX—2007《系統(tǒng)設(shè)計說明書》的編制，是為了說明對程

6、序系統(tǒng)的設(shè)計考慮。《系統(tǒng)設(shè)計說明書》編制指導(dǎo)如下。1引言1.1編寫說明說明編寫這份《系統(tǒng)設(shè)計說明書》的目的，指出預(yù)期的讀者。1.2背景說明待開發(fā)的軟件系統(tǒng)的名稱、版本號說明、本項目的任務(wù)提出者、開發(fā)者、用戶以及該軟件系統(tǒng)同其他系統(tǒng)的關(guān)系。1.3修訂審批記錄說明編寫這份《系統(tǒng)設(shè)計說明書》的修訂過程、審批過程。參見文檔修訂記錄表及文檔審批記錄表。表1文檔修訂記錄表修訂記錄章節(jié)修訂日期版本修訂描述修訂者審核者表2文檔審批記錄表審批記錄審批方式審批日期版本文檔所有者提交者審批者1.4需求概述簡略說明待開發(fā)的軟件系統(tǒng)的基本需求。詳細的說明可參見《軟件需求說明書》。

7、1.5術(shù)語和縮寫詞列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1.6參考資料列出本文件中用到的參考資料（參考格式：作者、名稱、出版單位、發(fā)表日期等）。2總體設(shè)計2.1軟件實現(xiàn)技術(shù)及特點5Q/SYXJXXXX—2007簡要列出開發(fā)本軟件系統(tǒng)的所使用的技術(shù)及特點。2.2基本設(shè)計概念和處理流程說明本系統(tǒng)的基本設(shè)計概念和處理流程，盡量使用圖表的形式。2.3結(jié)構(gòu)設(shè)計用圖表的形式說明本系統(tǒng)的系統(tǒng)元素（各層模塊、子程序、公用程序等）的劃分，扼要說明每個系統(tǒng)元素的標識符和功能，分層次地給出各元素之間的控制與被控制關(guān)系。2.4運行環(huán)境設(shè)計說明本程序運行時所必

8、需的環(huán)境條件。2.5接口設(shè)計說明本系統(tǒng)同外界接口的安排（包括軟件與硬件之間的接口