軟件開發(fā)設(shè)計文檔模板

1、軟件文檔編寫指南封面格式：文檔編號版本號文檔名稱：項目名稱：項目負(fù)責(zé)人：編寫年月日校對年月日審核年月日批準(zhǔn)年月日系統(tǒng)規(guī)約說明書(SystemSpecification)一.引言A.文檔的范圍和目的B.概述1 .目標(biāo)2 .約束二.功能和數(shù)據(jù)描述A.系統(tǒng)結(jié)構(gòu)3 .結(jié)構(gòu)關(guān)系圖4 .結(jié)構(gòu)關(guān)系圖描述三.子系統(tǒng)描述A.子系統(tǒng)N的結(jié)構(gòu)圖規(guī)約說明B.結(jié)構(gòu)字典C.結(jié)構(gòu)連接圖和說明四.系統(tǒng)建模和模擬結(jié)構(gòu)A.用于模擬的系統(tǒng)模型B.模擬結(jié)果C.特殊性能五.軟件項目問題A.軟件項目可行性研究報告B.軟件項目計劃六.附錄軟件項目可行性研究報告（ReportforFeasibilityStudy）一.引言1 .編寫目的（闡

2、明編寫可行性研究報告的目的，指出讀者對象）2 .項目背景（應(yīng)包括：（1）所建議開發(fā)的軟件名稱；（2）項目的任務(wù)提出者、開發(fā)者、用戶及實現(xiàn)單位；（3）項目與其他軟件或其他系統(tǒng)的關(guān)系。）3 .定義（列出文檔中用到的專門術(shù)語的定義和縮略詞的原文。）4 .參考資料（列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源。）2 .可行性研究的前提1 .要求（列出并說明建議開發(fā)軟件的基本要求，如（1）功能；（2）性能；（3）輸出；（4）輸入；（5）基本的數(shù)據(jù)流程和處理流程；（6）安全與保密要求；（7）與軟件相關(guān)的其他系統(tǒng)；（8）完成期限。）2 .目標(biāo)（可包括：（1）人力與設(shè)備費用的節(jié)??；（2）處理速

3、度的提高；（3）控制精度和生產(chǎn)能力的提高；（4）管理信息服務(wù)的改進；（5）決策系統(tǒng)的改進；（6）人員工作效率的提高，等等。）3 .條件、假定和限制（可包括：（1）建議開發(fā)軟件運行的最短壽命；（2）進行系統(tǒng)方案選擇比較的期限；（3）經(jīng)費來源和使用限制；（4）法律和政策方面的限制；（5）硬件、軟件、運行環(huán)境和開發(fā)環(huán)境的條件和限制；（6）可利用的信息和資源；（7）建議開發(fā)軟件投入使用的最遲時間。）4 .可行性研究方法5 .決定可行性的主要因素3 .對現(xiàn)有系統(tǒng)的分析1 .處理流程和數(shù)據(jù)流程2 .工作負(fù)荷3 .費用支出（如人力、設(shè)備、空間、支持性服務(wù)、材料等項開支。）4 .人員（列出所需人員的專業(yè)技術(shù)類

4、別和數(shù)量。）5 .設(shè)備6 .局限性（說明現(xiàn)有系統(tǒng)存在的問題以及為什么需要開發(fā)新的系統(tǒng)。）4 .所建議技術(shù)可行性分析1 .對系統(tǒng)的簡要描述2 .處理流程和數(shù)據(jù)流程3 .與現(xiàn)有系統(tǒng)比較的優(yōu)越性4 .采用建議系統(tǒng)可能帶來的影響（1）對設(shè)備的影響（2）對現(xiàn)有軟件的影響（3）對用戶的影響（4）對系統(tǒng)運行的影響（5）對開發(fā)環(huán)境的影響（6）對運行環(huán)境的影響（7）對經(jīng)費支出的影響5.技術(shù)可行性評價（包括：（1）在限制條件下，功能目標(biāo)是否能夠達到；（2）利用現(xiàn)有技術(shù)，功能目標(biāo)能否達到；（3）對開發(fā)人員數(shù)量和質(zhì)量的要求，并說明能否滿足；（4）在規(guī)定的期限內(nèi)，開發(fā)能否完成。）五.所建議系統(tǒng)經(jīng)濟可行性分析1 .指出（

5、1）基建投資（2）其他一次性支出（3）經(jīng)常性支出2 .效益（1）一次性收益（2）經(jīng)常性收益（3）不可定量收益3 .收益/投資比4 .投資回收周期5 .敏感性分析（指一些關(guān)鍵性因素，如：系統(tǒng)生存周期長短、系統(tǒng)工作負(fù)荷量、處理速度要求、設(shè)備和軟件配置變化對支出和效益的影響等的分析。）六.社會因素可行性分析1 .法律因素（如，合同責(zé)任、侵犯專利權(quán)、侵犯版權(quán)等問題的分析。）2 .用戶使用可行性（如，用戶單位的行政管理、工作制度、人員素質(zhì)等能否滿足要求。）七.其他可供選擇的方案（逐個闡明其他可供選擇的方案，并重點說明未被推薦的理由。）八.結(jié)論意見（可能是：（1）可著手組織開發(fā)；（2）需待若干條件（如資金

6、、人力設(shè)備等）具備后才能開發(fā)；（3）需對開發(fā)目標(biāo)進行某些修改；（4）不能進行或不必進行（如技術(shù)不成熟，經(jīng)濟上不合算等）；（4）其他。）軟件項目計劃(SoftwareProjectPlan),引言1 .編寫目的（闡明編寫軟件計劃的目的，指出讀者對象。）2 .項目背景（可包括：（1）項目委托單位、開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）3 .定義（列出本文檔中用到的專門術(shù)語的定義和縮略詞的原文。）4 .參考資料（可包括：（1）項目經(jīng)核準(zhǔn)的計劃任務(wù)書、合同或上級機關(guān)的批文；（2）文檔所引用的資料、規(guī)范等；列出資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源。）.項目概述1 .工作

7、內(nèi)容（簡要說明項目的各項主要工作，介紹所開發(fā)軟件的功能性能等.若不編寫可行性研究報告，則應(yīng)在本節(jié)給出較詳細(xì)的介紹。）2 .條件與限制（闡明為完成項目應(yīng)具備的條件開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件.必要時還應(yīng)說明用戶及分合同承包者承擔(dān)的工作完成期限及其它條件與限制。）3 .產(chǎn)品（1）程序（列出應(yīng)交付的程序名稱使用的語言及存儲形式。）（2）文檔（列出應(yīng)交付的文檔。）（3）運行環(huán)境（應(yīng)包括硬件環(huán)境軟件環(huán)境。）4 .服務(wù)（闡明開發(fā)單位可向用戶提供的服務(wù).如人員培訓(xùn)安裝保修維護和其他運行支持。）5 .驗收標(biāo)準(zhǔn)三.實施計劃1 .任務(wù)分解（任務(wù)的劃分及各項任務(wù)的負(fù)責(zé)人。）2 .進度（按階段完成的項目，用

8、圖表說明開始時間完成時間。）3 .預(yù)算4 .關(guān)鍵問題（說明可能影響項目的關(guān)鍵問題，如設(shè)備條件技術(shù)難點或其他風(fēng)險因素，并說明對策。）四.人員組織及分工五.交付期限六.專題計劃要點（如測試計劃質(zhì)量保證計劃配置管理計劃人員培訓(xùn)計劃系統(tǒng)安裝計劃等。）需求規(guī)格說明書(RequirementsSpecification)1 .引言1 .編寫目的（闡明編寫需求說明書的目的，指明讀者對象。）2 .項目背景（可包括：（1）項目的委托單位，開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）3 .定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原文。）4 .參考資料（可包括：（1）項目經(jīng)核準(zhǔn)的計劃任務(wù)書，合同或上

9、機機關(guān)的批文；（2）項目開發(fā)計劃；（3）文檔所引用的資料，標(biāo)準(zhǔn)和規(guī)范。列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源。）2 .任務(wù)概述1 .目標(biāo)2 .運行環(huán)境3 .條件與限制3 .數(shù)據(jù)描述1 .靜態(tài)數(shù)據(jù)2 .動態(tài)數(shù)據(jù)（包括輸入數(shù)據(jù)和輸出數(shù)據(jù)。）3 .數(shù)據(jù)庫描述（給出使用數(shù)據(jù)庫的名稱和類型。）4 .數(shù)據(jù)詞典5 .數(shù)據(jù)采集4 .功能需求1 .功能劃分2 .功能描述5 .性能需求1 .數(shù)據(jù)精確度2 .時間特性（如響應(yīng)時間、更新處理時間、數(shù)據(jù)轉(zhuǎn)化與傳輸時間、運行時間等。3 .適應(yīng)性（在操作方式運行環(huán)境與其他軟件的接口以及開發(fā)計劃等發(fā)生變化時，應(yīng)具有的適應(yīng)能力。）6 .運行需求1 .用戶界

10、面（如屏幕格式、報表格式、菜單格式、輸入輸出時間等。）2 .硬件接口3 .軟件接口4 .故障處理7 .其他需求（如可使用性、安全保密、可維護性、可移植性等。）概要設(shè)計說明書（ArchitecturalDesignSpecification）1 .引言1 .編寫目的（闡明編寫概要設(shè)計說明書的目的，指明讀者對象。）2 .項目背景（可包括：（1）項目的委托單位，開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）3 .定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原意。）4 .參考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目經(jīng)核準(zhǔn)的計劃任務(wù)書，合同或上機機

11、關(guān)的批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明書；（4）測試計劃（初稿）；（5）用戶操作手冊（初稿）；（6）文檔所引用的資料、采用的標(biāo)準(zhǔn)或規(guī)范。）2 .任務(wù)概述1 .目標(biāo)2 .運行環(huán)境3 .需求概述4 .條件與限制3 .總體設(shè)計1 .處理流程2 .總體結(jié)構(gòu)和模塊外部設(shè)計3 .功能分配（表明各項功能與程序結(jié)構(gòu)的關(guān)系。）4 .接口設(shè)計1 .外部接口（包括用戶界面軟件接口與硬件接口。）2 .內(nèi)部接口（模塊之間的接口。）5 .數(shù)據(jù)結(jié)構(gòu)設(shè)計1 .邏輯結(jié)構(gòu)設(shè)計2 .物理結(jié)構(gòu)設(shè)計3 .數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系6 .運行設(shè)計1 .運行模塊的組合2 .運行控制3 .運行時間7 .出錯處理設(shè)計1 .出錯輸出信息2

12、.出錯處理對策（如設(shè)置后備、性能降級、恢復(fù)及再啟動等。）8 .安全保密設(shè)計9 .維護設(shè)計（說明為方便維護工作的設(shè)施，如維護模塊等。）詳細(xì)設(shè)計說明書（ProceduralDesignSpecification）一.引言1 .編寫目的（闡明編寫詳細(xì)設(shè)計說明書的目的，指明讀者對象。）2 .項目背景（應(yīng)包括項目的來源和主管部門等。）3 .定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原意。）4 .參考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目的計劃任務(wù)書，合同或批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明書；（3）概要設(shè)計說明書；（4）測試計劃（初稿）；（5）

13、用戶操作手冊（初稿）；（5）文檔所引用的其他資料、軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。）二.總體設(shè)計1 .需求概述2 .軟件結(jié)構(gòu)（如給出軟件系統(tǒng)的結(jié)果圖。）三.程序描述（逐個模塊給出以下的說明：）1 .功能2 .性能3 .輸入項目4 .輸出項目5 .算法（模塊所選用的算法。）6 .程序邏輯（詳細(xì)描述模塊實現(xiàn)的算法，可采用：（1）標(biāo)準(zhǔn)流程圖；（2）PDL語言；（3）N-S圖；（4）PAD;（5）判定表等描述算法的圖表。）7 .接口8 .存儲分配9 .限制條件10 .測試要點（給出測試模塊的主要測試要求。）用戶操作手冊（UserGuide),引言1 .編寫目的（闡明編寫手冊的目的，指明讀者對象。）2 .項目背景（

14、說明項目的來源、委托單位、開發(fā)單位及主管部門。3 .定義（列出手冊中用到的專門術(shù)語定義和縮寫詞的原意。）4 .參考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目的計劃任務(wù)書，合同或批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明書；（4）概要設(shè)計說明書；（5）詳細(xì)設(shè)計說明書；（6）測試計劃；（7）手冊中引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。）二.軟件概述1 .目標(biāo)2 .功能3 .性能（1）數(shù)據(jù)精確度（包括輸入、輸出及處理數(shù)據(jù)的精度。）（2）時間特性（如響應(yīng)時間、處理時間、數(shù)據(jù)傳輸時間等。）（3）靈活性（在操作方式、運行環(huán)境需做某些變更時軟件的適應(yīng)

15、能力。）三.運行環(huán)境1 .硬件（列出軟件系統(tǒng)運行時所需的硬件最小配置，如：（1）計算機型號、主存容量；（2）外存儲器、媒體、記錄格式、設(shè)備型號及數(shù)量；（3）輸入、輸出設(shè)備；（4）數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號及數(shù)量。）2 .支持軟件（如：（1）操作系統(tǒng)名稱及版本號；（2）語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號；（3）數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號；（4）其他必要的支持軟件。）四.使用說明1 .安裝和初始化（給出程序的存儲形式、操作命令、反饋信息及其含義、表明安裝完成的測試實例以及安裝所需的軟件工具等。）2 .輸入（給出輸入數(shù)據(jù)或參數(shù)的要求。）（1）數(shù)據(jù)背景（說明數(shù)據(jù)來源、存儲媒體、出現(xiàn)頻度、限制

16、和質(zhì)量管理等。）（2）數(shù)據(jù)格式（如：（1）長度（2）格式基準(zhǔn)（3）標(biāo)號（4）順序（5）分隔符（6）詞匯表（7）省略和重復(fù)（8）控制。）（3）輸入舉例3.輸出（給出每項輸出數(shù)據(jù)的說明。）（1）數(shù)據(jù)背景（說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。）（2）數(shù)據(jù)格式（詳細(xì)闡明每一輸出數(shù)據(jù)的格式，如:首部主體和尾部的具體形式。）（3）舉例3 .出錯和恢復(fù)（給出：（1）出錯信息及其含義（2）用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動。）4 .求助查詢（說明如何操作。）五.運行說明1 .運行表列出每種可能的運行情況，說明其運行目的.2 .運行步驟按順序說明每種運行的步驟，應(yīng)包括:（1） 運行控制（2）

17、 操作信息（1）運行目的（2）操作要求（3）啟動方法（4）預(yù)計運行時間（5）操作命令格式及說明（6）其他事項。）（3） 輸入/輸出文件（給出建立和更新文件的有關(guān)信息，如：（1）文件的名稱及編號（2）記錄媒體（3）存留的目錄（4）文件的支配說明確定保留文件或廢棄文件的準(zhǔn)則，分發(fā)文件的對象，占用硬件的優(yōu)先級及保密控制等。）（4） 啟動或恢復(fù)過程六.非常規(guī)過程（提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟，如出錯處理操作、向后備系統(tǒng)切換操作以及維護人員須知的操作和注意事項。）七.操作命令一覽表（按字母順序逐個列出全部操作命令的格式功能及參數(shù)說明。）八.程序文件（或命令文件）和數(shù)據(jù)文件一覽表（按文件名字母

18、順序或按功能與模塊分類順序逐個列出文件名稱、標(biāo)識符及說明。）九.用戶操作舉例測試計戈1J(TestPlan)一、引言1 .編寫目的（闡明編寫測試計劃的目的，指明讀者對象。）2 .項目背景（說明項目的來源委托單位及主管部門。）3 .定義（列出測試計劃中用到的專門術(shù)語定義和縮寫詞的原意。）4 .參考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目的計劃任務(wù)書，合同或批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明書；（3）概要設(shè)計說明書；（4）詳細(xì)設(shè)計說明書；（5）用戶操作手冊；g本測試計劃中引用的其他資料采用的軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。）二.任務(wù)概述1 .目標(biāo)2 .運

19、行環(huán)境3 .需求概述4 .條件與限制三.計劃1 .測試方案（說明確定測試方法和選取測試用例的原則。）2 .測試項目（列出組裝測試和確認(rèn)測試中每一項測試的內(nèi)容、名稱、目的和進度。）3 .測試準(zhǔn)備4 .測試機構(gòu)及人員（測試機構(gòu)名稱負(fù)責(zé)人和職責(zé)。）四.測試項目說明（按順序逐個對測試項目做出說明：）1 .測試項目名稱及測試內(nèi)容2 .測試用例（1）輸入（輸入的數(shù)據(jù)和輸入的命令。）（2）輸出（預(yù)期的輸出數(shù)據(jù)。）（3）步驟及操作（4）允許偏差（給出實測結(jié)果與預(yù)測結(jié)果之間允許偏差的范圍。）3 .進度4 .條件（給出項測試對資源的特殊要求，如設(shè)備、軟件、人員等。）5 .測試資料（說明項測試所需的資料。）五.評價

20、1 .范圍（說明所完成的各項測試說明問題的范圍及其局限性。）2 .準(zhǔn)則（說明評價測試結(jié)果的準(zhǔn)則。）測試分析報告(TestSpecification)一.引言1 .編寫目的（闡明編寫測試分析報告的目的，指明讀者對象。）2 .項目背景（說明項目的來源、委托單位及主管部門。）3 .定義（列出測試分析報告中用到的專門術(shù)語定義和縮寫詞的原意。）4 .參考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目的計劃任務(wù)書，合同或批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明書；（4）概要設(shè)計說明書；（5）詳細(xì)設(shè)計說明書；（6）用戶操作手冊；（7）測試計劃；（8）測試分析報告所

21、引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。）二.測試計劃執(zhí)行情況1 .測試項目（列出每一測試項目的名稱、內(nèi)容和目的。）2 .測試機構(gòu)和人員（給出測試機構(gòu)名稱、負(fù)責(zé)人和參與測試人員名單。）3 .測試結(jié)果（按順序給出每一測試項目的：（1）實測結(jié)果數(shù)據(jù)（2）與預(yù)期結(jié)果數(shù)據(jù)的偏差（3）該項測試說明的事實（4）該項測試發(fā)現(xiàn)的問題。）三.軟件需求測試結(jié)論（按順序給出每一項需求測試的結(jié)論。包括：（1）證實的軟件能力（2）局限性（即項需求未得到充分測試的情況及原因）。）四.評價1 .軟件能力（經(jīng)過測試所表明的軟件能力。）2 .缺陷和限制（說明測試所揭露的軟件缺陷和不足，以及可能給軟件運行帶來的影響。）

22、3 .建議（提出為彌補上述缺陷的建議。）4 .測試結(jié)論（說明能否通過。）開發(fā)進度月報一.報告時間及所處的開發(fā)階段2 .給出進度1 .本月內(nèi)的主要活動2 .實際進展與計劃比較3 .所用工時（按不同層次人員分別計時。）4 .所有機時（按所有計算機機型分別計時。）5 .經(jīng)費支出（分類列出本月經(jīng)費支出項目，給出支出總額，并與計劃比較。）6 .工作遇到的問題及采取的對策7 .本月完成的成果8 .下月的工作計劃9 .特殊問題項目開發(fā)總結(jié)報告一.引言1 .編寫目的（闡明編寫總結(jié)報告的目的，指明讀者對象。）2 .項目背景（說明項目的來源、委托單位、開發(fā)單位及主管部門。）3 .定義（列出報告中用到的專門術(shù)語定義和縮寫詞的原意。）4 .參考資料（列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目的計劃任務(wù)書，合同或批文；（2）項目開發(fā)計劃；（3）需求規(guī)格說明書；（4）概要設(shè)計說明書；（5）詳細(xì)設(shè)計說明書；（6）用戶操作手冊；（7）測試計戈IJ;（8）測試分析報告（9）本報告引用的其他資料、采用的開發(fā)標(biāo)準(zhǔn)或開發(fā)規(guī)范。）二.開發(fā)結(jié)果1 .產(chǎn)品（可包括：（1）列出各部分的程序名稱、源程序行數(shù)（包括注釋行）或目標(biāo)程序字節(jié)數(shù)及程序總計數(shù)量、存儲形式；產(chǎn)品文檔名稱等。）2 .主要功能及性能3 .所用工時（按人員的不同層次分別計時。）4 .所用機時（按所用計算機機型分別計時。