在項目開發過程中，文檔編制要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性。

可行性分析報告：說明該軟件開發項目的實現在技術上、經濟上和社會因素上的可行性，評述為了合理地達到開發目標可供選擇的各種可能實施方案，說明并論證所選定實施方案的理由。

項目開發計劃：為軟件項目實施方案制訂出具體計劃，應該包括各部分工作的負責人員、開發的進度、開發經費的預算、所需的硬件及軟件資源等。軟件開發項目文檔在項目開發過程中，文檔編制要求具有針對性、精確性、清晰1

軟件需求說明書（軟件規格說明書）：對所開發軟件的功能、性能、用戶界面及運行環境等作出詳細的說明。它是在用戶與開發人員雙方對軟件需求取得共同理解并達成協議的條件下編寫的，也是實施開發工作的基礎。該說明書應給出數據邏輯和數據采集的各項要求，為生成和維護系統數據文件做好準備。

概要設計說明書：該說明書是概要實際階段的工作成果，它應說明功能分配、模塊劃分、程序的總體結構、輸入輸出以及接口設計、運行設計、數據結構設計和出錯處理設計等，為詳細設計提供基礎。詳細設計說明書：著重描述每一模塊是怎樣實現的，包括實現算法、邏輯流程等。軟件開發項目文檔軟件需求說明書（軟件規格說明書）：對所開發軟件的功能、性能2

用戶操作手冊：本手冊詳細描述軟件的功能、性能和用戶界面，使用戶對如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運行情況的有關知識，特別是操作方法的具體細節。

測試計劃：為做好集成測試和驗收測試，需為如何組織測試制訂實施計劃。計劃應包括測試的內容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差范圍等。

測試分析報告：測試工作完成以后，應提交測試計劃執行情況的說明，對測試結果加以分析，并提出測試的結論意見。

開發進度月報：該月報系軟件人員按月向管理部門提交的項目進展情況報告，報告應包括進度計劃與實際執行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。軟件開發項目文檔軟件開發項目文檔3

項目開發總結報告：軟件項目開發完成以后，應與項目實施計劃對照，總結實際執行的情況，如進度、成果、資源利用、成本和投入的人力，此外，還需對開發工作做出評價，總結出經驗和教訓。

軟件維護手冊：主要包括軟件系統說明、程序模塊說明、操作環境、支持軟件的說明、維護過程的說明，便于軟件的維護。

軟件問題報告：指出軟件問題的登記情況，如日期、發現人、狀態、問題所屬模塊等，為軟件修改提供準備文檔。

軟件修改報告：軟件產品投入運行以后，發現了需對其進行修正、更改等問題，應將存在的問題、修改的考慮以及修改的影響作出詳細的描述，提交審批。軟件開發項目文檔軟件開發項目文檔4一、可行性分析報告1.1編寫目的：闡明編寫可行性研究報告的目的，提出讀者對象。1.2項目背景：應包括●所建議開發軟件的名稱●項目的任務提出者、開發者、用戶及實現軟件的單位●項目與其他軟件或其他系統的關系。1.3定義：列出文檔中用到的專門術語的定義和縮寫詞的原文。1.4參考資料：列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括●項目經核準的計劃任務書、合同或上級機關的批文●與項目有關的已發表的資料●文檔中所引用的資料，所采用的軟件標準或規范

一、可行性分析報告1.1編寫目的：闡明編寫可行性研究報告的52可行性研究的前提2.1要求：列出并說明建議開發軟件的的基本要求，如●功能●性能●輸入/輸出●基本的數據流程和處理流程●安全與保密要求●與軟件相關的其他系統●完成日期2.2目標：可包括●人力與設備費用的節省●處理速度的提高●控制精度或生產力的提高●管理信息服務的改進●決策系統的改進●人員工作效率的提高

2可行性研究的前提62.3條件、假定和限制：可包括●建議開發軟件運行的最短壽命●進行顯然方案選擇比較的期限●經費來源和使用限制●法律和政策方面的限制●硬件、軟件、運行環境和開發環境的條件和限制●可利用的信息和資源●建議開發軟件投入使用的最遲時間2.4可行性研究方法2.5決定可行性的主要因素

2.3條件、假定和限制：可包括73對現有系統的分析3.1處理流程和數據流程3.2工作負荷3.3費用支出：如人力、設備、空間、支持性服務、材料等項開支3.4人員：列出所需人員的專業技術類別和數量3.5設備3.6局限性：說明現有系統存在的問題以及為什么需要開發新的系統

3對現有系統的分析84所建議技術可行性分析4.1對系統的簡要描述4.2與現有系統比較的優越性4.3處理流程和數據流程4.4采用建議系統可能帶來的影響●對設備的影響●對現有軟件的影響●對用戶的影響●對系統運行的影響●對開發環境的影響●對經費支出的影響4.5技術可行性評價:包括●在限制條件下，功能目的是否達到●利用現有技術，功能目的是否達到●對開發人員數量和質量的要求，并說明能否滿足●在規定的期限內，開發能否完成

4所建議技術可行性分析95所建議系統經濟可行性分析5.1支出5.2效益5.3收益/投資比5.4投資回收周期5.5敏感性分析：指一些關鍵性因素，如：●系統生存周期長短●系統工作負荷量●處理速度要求●設備和軟件配置變化對支出和效益的影響等的分析

5所建議系統經濟可行性分析106社會因素可行性分析6.1法律因素：如●合同責任●侵犯專利權●侵犯版權6.2用戶使用可行性：如●用戶單位的行政管理●工作制度●人員素質等能否滿足要求7其他可供選擇的方案逐個闡明其它可供選擇的方案，重點說明未被推薦的理由。8結論意見●可著手組織開發●需等待若干條件具備后才能開發●需對開發目標進行某些修改●不能進行或不必進行●其它

6社會因素可行性分析11二、項目開發計劃

1引言1.1編寫目的：闡明編寫可行性研究報告的目的，提出讀者對象1.2項目背景：應包括●項目的委托單位、開發單位和主管部門；●該軟件系統與其他系統的關系。1.3定義：列出文檔中用到的專門術語的定義和縮寫詞的原文1.4參考資料：可包括：●項目經核準的計劃任務書、合同或上級機關的批文●文檔所引用的資料、規范等●列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源；

二、項目開發計劃122項目概述2.1工作內容:簡要說明項目的各項主要工作，介紹所開發軟件的功能、性能等；若不編寫可行性研究報告；則應在本節給出較詳細的介紹；2.2條件與限制:闡明為完成項目應具備的條件、開發單位已具備的條件以及尚需創造的條件。必要時還應說明用戶及分合同承擔的工作、完成期限及其他條件與限制。2.3產品2.3.1程序：列出應交付的程序名稱、使用的語言及存儲形式。2.3.2文檔：列出應交付的文檔。2.4運行環境：應包括硬件環境、軟件環境。2.5服務：闡明開發單位可向用戶提供的服務。如人員培訓、安裝、保修、維護和其他運行支持。2.6驗收標準

2項目概述133實施計劃3.1任務分解：任務的劃分及各項任務的負責人。3.2進度：按階段完成的項目，用圖表說明開始時間、完成時間。3.3預算3.4關鍵問題：說明可能影響項目的關鍵問題，如設備條件、技術難點或其他風險因素，并說明對策。4人員組織及分工5交付期限6專題計劃要點如測試計劃、質量保證計劃、配置管理計劃、人員培訓計劃、系統安裝計劃等。

3實施計劃14三、軟件需求說明書

1引言1.1編寫目的：闡明編寫需求說明書的目的，指明讀者對象。1.2項目背景：應包括●項目的委托單位、開心單位和主管部門；●該軟件系統與其他系統的關系。1.3定義：列出文檔中所用到的專門術語的定義和縮寫詞的愿文。1.4參考資料：可包括●項目經核準的計劃任務書、合同或上級機關的批文●文檔所引用的資料、規范等●列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源

三、軟件需求說明書152任務概述2.1目標2.2運行環境2.3條件與限制3數據描述3.1表態數據3.2動態數據：包括輸入數據和輸出數據。3.3數據庫描述：給出使用數據庫的名稱和類型。3.4數據詞典3.5數據采集

2任務概述164功能需求4.1功能劃分4.2功能描述5性能需求5.1數據精確度5.2時間特性：如響應時間、更新處理時間、數據轉換與傳輸時間、運行時間等。5.3適應性：在操作方式、運行環境、與其他軟件的接口以及開發計劃等發生變化時，應具有的適應能力。

4功能需求176運行需求6.1用戶界面：如屏幕格式、報表格式、菜單格式、輸入輸出時間等。6.2硬件接口6.3軟件接口6.4故障處理7其他需求如可使用性、安全保密、可維護性、可移植性等。

6運行需求18四、概要設計說明書1引言1.1寫目的：闡明編寫概要設計說明書的目的，指明讀者對象。1.2項目背景：應包括●項目的委托單位、開發單位和主管部門●該軟件系統與其他系統的關系。1.3定義：列出本文檔中所用到的專門術語的定義和縮寫詞的愿意。1.4參考資料：●列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源●項目經核準的計劃任務書、合同或上級機關的批文；項目開發計劃；需求規格說明書；測試計劃（初稿）；用戶操作手冊●文檔所引用的資料、采用的標準或規范。

四、概要設計說明書192任務概述2.1目標2.2需求概述2.3條件與限制3總體設計3.2總體結構和模塊外部設計3.3功能分配：表明各項功能與程序結構的關系。

4接口設計4.1外部接口：包括用戶界面、軟件接口與硬件接口。4.2內部接口：模塊之間的接口。

2任務概述205數據結構設計6邏輯結構設計所有文檔的統一封面格式如下頁所示。7物理結構設計8數據結構與程序的關系9運行設計9.1運行模塊的組合9.2運行控制9.3運行時間

10出錯處理設計10.1出錯輸出信息10.2出錯處理對策：如設置后備、性能降級、恢復及再啟動等。11安全保密設計12維護設計說明為方便維護工作的設施，如維護模塊等。5數據結構設計21五、詳細設計說明書1引言1.1編寫目的：闡明編寫詳細設計說明書的目的，指明讀者對象。1.2項目背景：應包括項目的來源和主管部門等。1.3定義：列出本文檔中所用到的專門術語的定義和縮寫詞的愿意。1.4參考資料：●列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源●項目經核準的計劃任務書、合同或上級機關的批文；項目開發計劃；需求規格說明書；概要設計說明書；測試計劃（初稿）；用戶操作手冊●文檔所引用的資料、軟件開發的標準或規范。

五、詳細設計說明書222總體設計2.1需求概述2.2軟件結構：如給出軟件系統的結構圖。3程序描述3.1逐個模塊給出以下說明：●功能●性能●輸入項目●輸出項目3.2算法：模塊所選用的算法。3.3程序邏輯：詳細描述模塊實現的算法，可采用：標準流程圖；PDL語言；N-S圖；判定表等描述算法的圖表。3.4接口●存儲分配●限制條件3.5測試要點：給出測試模塊的主要測試要求。

2總體設計23六、用戶操作手冊

1引言1.1編寫目的：闡明編寫手冊的目的，指明讀者對象。1.2項目背景：說明項目的來源、委托單位、開發單位及和主管部門。1.3定義：列出手冊中使用的專門術語的定義和縮寫詞的愿意。1.4參考資料：●列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源●項目經核準的計劃任務書、合同或上級機關的批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；測試計劃●文檔中所引用的其他資料、采用的軟件工程標準或軟件工程規范。

六、用戶操作手冊242軟件概述2.1目標2.2功能2.3性能2.4數據精確度：包括輸入、輸出及處理數據的精度。2.5時間特性：如響應時間、處理時間、數據傳輸時間等。2.6靈活性：在操作方式、運行環境需做某些變更時軟件的適應能力。3運行環境3.1硬件●列出軟件系統運行時所需的硬件最小配置，如計算機型號、主存容量●外存儲器、媒體、記錄格式、設備型號及數量●輸入、輸出設備●數據傳輸設備及數據轉換設備的型號及數量。3.2支持軟件●操作系統名稱及版本號●語言編譯系統或匯編系統的名稱及版本號●數據庫管理系統的名稱及版本號●其他必要的支持軟件

2軟件概述254使用說明4.1安裝和初始化：給出程序的存儲形式、操作命令、反饋信息及其做含意、表明安裝完成的測試實例以及安裝所需的軟件工具等。4.2輸入：給出輸入數據或參數的要求。●數據背景：說明數據來源、存儲媒體、出現頻度、限制和質量管理等。●數據格式:如長度、格式基準、標號、順序、分隔符、詞匯表、省略和重復、控制。●輸入舉例。4.3輸出：給出每項輸出數據的說明。●數據背景：說明輸出數據的去向、使用頻度、存放媒體及質量管理等。●數據格式：詳細闡明每一輸出數據的格式，如首部、主體和尾部的具體形式。●舉例4.4出錯和恢復：給出出錯信息及其含意；用戶應采取的措施，如修改、恢復、再啟動。4.5求助查詢：說明如何操作。

4使用說明265運行說明5.1運行表：列出每種可能的運行情況，說明其運行目的。5.2運行步驟：按順序說明每和運行的步驟，應包括：5.3運行控制5.4操作信息：運行目的、運行目的、操作要求、啟動方法、預計運行時間、操作命令格式及說明、其他事項；5.5輸入/輸出文件：給出建立或更新文件的有關信息，如：文件的名稱及編號；記錄媒體；存留的目錄；文件的支配：說明確定保留文件或廢棄文件的準則，分發文件的對象，戰勝硬件的優先級及保密控制等。5.6啟動或恢復過程

5運行說明276非常規過程提供應急戒非常規操作的必要信息及操作步驟，如出錯處理操作、向后備系統切換操作及維護人員須知的操作和注意事項。7操作命令一覽表按字母順序逐個列出全部操作命令的格式、功能及參數說明。8程序文件（或命令文件）和數據文件一覽表按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標識符及說明。9用戶操作舉例

6非常規過程28七、測試計劃

1引言1.1編寫目的：闡明編寫測試計劃的目的并指明讀者對象。1.2項目背景：說明項目的來源、委托單位及主管部門。1.3定義：列出測試計劃中所用到的專門術語的定義和縮寫詞的原意。1.4參考資料：列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；用戶操作手冊；本測試計劃中引用的其他資料、采用的軟件開發標準或規范。

七、測試計劃292任務概述2.1目標2.2運行環境2.3需求概述2.4條件與限制3計劃3.1測試方案：說明測試方法和選取測試用例的原則。3.2測試項目：列出組裝測試和確認測試中每一項測試的內容、名稱、目的和進度。3.3測試準備3.4測試機構及人員：測試機構名稱、負責人和職責。

2任務概述304測試項目說明4.1按順序逐個對測試項目做出說明4.1.1測試項目名稱及測試內容4.1.2測試用例4.1.3輸入：輸入的數據和輸入命令。4.1.4輸出：預期的輸出數據。4.2步驟及操作4.3允許偏差：給出實測結果與預期結果之間允許偏差的范圍。4.4進度4.5條件：給出項測試對資源的特殊要求，如設備、軟件、人員等。4.6測試資料：說明項測試所需的資料。5評價5.1范圍：說明所完成的各項測試說明問題的范圍及其局限性。5.2準則：說明評論測試結果的準則。

4測試項目說明31八、測試分析報告

1引言1.1編寫目的：闡明編寫測試分析報告的目的并指明讀者對象。1.2項目背景：說明項目的來源、委托單位及主管部門。1.3定義：列出測試分析報告中所用到的專門術語的定義和縮寫詞的原意。1.4參考資料：列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；用戶操作手冊；測試計劃；測試分析報告所引用的其他資料、采用的軟件工程標準或工程規范。

八、測試分析報告322測試計劃招待情況2.1機構和人員：給出測試機構名稱、負責人和參與測試人員名單。2.2測試結果：按順序給出每一測試項目的：實測結果數據；與預期結果數據的偏差；該項測試表明的事實；該項測試發現的問題。3軟件需求測試結論按順序給出每一項需求測試的結論。包括：證實的軟件能力；局限性（即項需求未得到充分測試的情況及原因。4評價4.1軟件能力：經過測試所表明的軟件能力。4.2缺陷和限制：說明測試所揭露的軟件缺陷和不足，以及可能給軟件運行帶來的影響。4.3建議：提出為彌補上述缺陷的建議。4.4測試結論：說明能否通過。

2測試計劃招待情況33九、開發進度月報

1報告時間及所處的開發階段2工程進度2.1本月內的主要活動2.2實際進展與計劃比較3所用工時按不同層次人員分別計時。4所用機時按所用計算機機型分別計時。5經費支出分類列出本月經費支出項目，給出支出總額，并與計劃比較。6工作遇到的問題及采取的對策7本月完成的成果8下月的工作計劃9特殊問題

九、開發進度月報34十、項目開發總結報告

1引言1.1編寫目的：闡明編寫總結報告的目的并指明讀者對象。1.2項目背景：說明項目的來源、委托單位、開發單位及主管部門。1.3定義：列出報告中所用到的專門術語的定義和縮寫詞的原意。1.4參考資料：列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；用戶操作手冊；測試計劃；測試分析報告；本報告引用的其他資料、采用的開發標準或開發規范。

十、項目開發總結報告352開發結果2.1產品：可包括列出各部分的程序名稱、源程序行數（包括注釋行）或目標程序字節數及程序總計數量、存儲形式；產品文檔名稱等。2.2主要功能及性能2.3所用工時：按人員的不同層次分別計時。2.4所用機時：按所用計算機機型分別計時。2.5進度：給出計劃進度與實際進度的對比。2.6費用3評價3.1生產率評價：如平均每人每月生產的源程序行數、文檔的字數等。3.2技術方案評價3.3產品質量評價4經驗與教訓

2開發結果36十一、軟件維護手冊

1引言1.1編寫目的：闡明編寫手冊的目的并指明讀者對象。1.2項目背景：說明項目的提出者、開發者、用戶和使用場所。1.3定義：列出報告中所用到的專門術語的定義和縮寫詞的原意。1.4參考資料：列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，及保密級別，可包括：用戶操作手冊；與本項目有關的其他文檔。

十一、軟件維護手冊372系統說明2.1系統用途：說明系統具備的功能，輸入和輸出。2.2安全保密：說明系統安全保密方面的考慮。2.3總體說明：說明系統的總體功能，對系統、子系統和作業做出綜合性的介紹，并用圖表的方式給出系統主要部分的內部關系。2.4程序說明：說明系統中每一程序、分程序的細節和特性。2.4.1程序1的說明●功能：說明程序的功能。●方法：說明實現方法。●輸入：說明程序的輸入、媒體、運行數據記錄、運行開始時使用的輸入數據的類型和存放單元、與程序初始化有關的入口要求。●處理：處理特點和目的，如：用圖表說明程序的運行的邏輯流程；程序主要轉移條件；對程序的約束條件；程序結束時的出口要求；與下一個程序的通信與聯結（運行、控制）；由該程序產生并茶館處理程序段使用的輸出數據類型和存放單元；程序運行存儲量、類型及存儲位置等。

2系統說明38●輸出：程序的輸出。●接口：本程序與本系統其他部分的接口。●表格：說明程序內部的各種表、項的細節和特性。對每張表的說明至少包括：表的標識符；使用目的；使用此表的其他程序；邏輯劃分，如塊或部，不包括表項；表的基本結構；設計安排，包括表的控制信息。表目結構細節、使用中的特有性質及各表項的標識、位置、用途、類型、編碼表示。●特有的運行性質：說明在用戶操作手冊中沒有提到的運行性質。

2.4.2程序2的說明與程序1的說明相同。以后的其他各程序的說明相同。●輸出：程序的輸出。393操作環境3.1設備：逐項說明系統的設備配置及其特性。3.2支持軟件：列出系統使用的支持軟件，包括它們的名稱和版本號。3.3數據庫：說明每個數據庫的性質和內容，包括安全考慮。3.3.1總體特征：如標識符、使用這些數據庫的程序、靜態數據、動態數據；數據庫的存儲媒體；程序使用數據庫的限制。3.3.2結構及詳細說明●說明該數據庫的結構，包括其中的記錄和項。●說明記錄的組成，包括首部或控制段、記錄體。●說明每個記錄結構的字段，包括：標記或標號、字段的字符長度和位數、該字段的允許值范圍。●擴充：說明為記錄追加字段的規定。

3操作環境404維護過程4.1約定：列出該軟件系統設計中所使用全部規則和約定，包括：程序、分程序、記錄、字段和存儲區的標識或標號助記符的使用規則；圖表的處理標準、卡片的連接順序、語句和記號中使用的縮寫、出現在圖表中的符號名；使用的軟件技術標準；標準化的數據元素及其特征。4.2驗證過程：說明一個程序段修改后，對其進行驗證的要求和過程（包括測試程序和數據）及程序周期性驗證的過程。4.3出錯及糾正方法：列出出錯狀態及其糾正方法。4.4專門維護過程：說明文檔其他地方沒有提到的專門維護過程。如：維護該軟件系統的輸入輸出部分（如數據庫）的要求、過程和驗證方法；運行程序庫維護系統所必需的要求、過程和驗證方法；對閏年、世紀變更的所需要的臨時性修改等。4.5專用維護程序：列出維護軟件系統使用的后備技術和專用程序（如文件恢復程序、淘汰過時文件的程序等）的目錄，并加以說明，內容包括：維護作業的輸入輸出要求；輸入的詳細過程及在硬設備上建立、運行并完成維護作業的操作步驟。4.6程序清單和流程圖：引用或提供附錄給出程序清單和流程圖。

4維護過程41十二、軟件問題報告

1登記號由軟件配置管理部門為該報告規定一個唯一的、順序的編號。2登記日期軟件配置管理部門登記該報告的日期。3問題發現日期發現該問題的日期和時間。4活動在哪個階段發現的問題，分為單元測試、組裝測試、確認測試和運行維護。5狀態在軟件配置記錄中維護的動態指示，狀態表示有：正在復查"軟件問題報告"，以確定將采取什么行動；"軟件問題報告"已由指定的人去進行處理；修改已完成，并經過測試，正準備交給主程序庫；主程序庫已經更新，主程序庫修改的重新測試沿未完成；做了重新測試，問題再現；做了重新測試，所做的修改無故障，"軟件問題報告"被關閉；留待以后關閉。

十二、軟件問題報告426報告人填寫"軟件問題報告"人員的姓名、地址、電話。7問題屬于什么方面區分是程序的問題，還是模塊的問題，或是數據庫的問題，文件的問題。也可能是它們的某種組合。8模塊/子系統出現的模塊名。如果不知是哪個模塊，可標出子系統名，盡量給出細節。9修訂版本號出現問題的模塊版本。10磁帶包含有問題的模塊的主程序庫的磁帶的標識符。11數據庫當發現問題時所使用數據庫的標識符。6報告人4312文件號有錯誤的文件的編號。13測試用例發現錯誤時所使用測試用例的標識符。14硬件發現錯誤時所使用的計算機系統的標識。15問題描述/影響問題癥兆的詳細描述。如果可能，則寫明實際問題所在。也要給出該問題對將來測試、接口軟件和文件等的影響。16附注記載補充信息。

12文件號44十三、軟件修改報告

1登記號由軟件配置管理部門為該報告規定的編號。2登記日期軟件配置管理部門登記"軟件修改報告"的日期。3時間準備好"軟件修改報告"的日期。4報告人填寫該報告的作者。5子系統名受修改影響的子系統名。

十三、軟件修改報告456模塊名被修改的模塊名。7"軟件問題報告"的編號被"軟件修改報告"處理或部分處理的"軟件問題報告"的編號。如果某"軟件問題報告"的問題只是部分被處理，則在編號后附以p，如1234p。8修改包括程序修改、文件更新、數據庫修改或它們的組合。9修改描述修改的詳細描述。如果是文件更新或數據庫修改，還要列出文件更新通知或數據庫修改申請的標識符。10批準人批準人簽字，正式批準進行修改。11語句類型程序修改中涉及到的語句類型，包括：輸入/輸出語句類、計算語句類、邏輯控制語句類、數據處理語句類（如數據傳送、存取語句類）。6模塊名4612程序名被修改的程序、文件或數據庫的名字。13老修訂版當前的版本/修訂本標識。14新修訂版修改后的版本/修訂本標識。15數據庫如果申請數據庫修改，則給出數據庫的標識符。16數據庫修改報告數據庫修改申請號。17文件如果要求對文件進行修改，則給出文件的名字。18文件更新文件更新通知單的編號。12程序名4719修改是否已測試指出已對修改做了哪些測試，如單元、子系統、組裝、確認和運行測試等，并注明測試成功與否。20"軟件問題報告"是否給出問題的準確描述回答'是'或'否'。21問題注釋準確地敘述要維護的問題。22問題源指明問題來自于哪里，如軟件需求說明書、設計說明書、數據庫、源程序等。23資源完成修改所需資源的估計，即總的人時數和計算機時間的開銷。

19修改是否已測試48在項目開發過程中，文檔編制要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性。

可行性分析報告：說明該軟件開發項目的實現在技術上、經濟上和社會因素上的可行性，評述為了合理地達到開發目標可供選擇的各種可能實施方案，說明并論證所選定實施方案的理由。

項目開發計劃：為軟件項目實施方案制訂出具體計劃，應該包括各部分工作的負責人員、開發的進度、開發經費的預算、所需的硬件及軟件資源等。軟件開發項目文檔在項目開發過程中，文檔編制要求具有針對性、精確性、清晰49

軟件需求說明書（軟件規格說明書）：對所開發軟件的功能、性能、用戶界面及運行環境等作出詳細的說明。它是在用戶與開發人員雙方對軟件需求取得共同理解并達成協議的條件下編寫的，也是實施開發工作的基礎。該說明書應給出數據邏輯和數據采集的各項要求，為生成和維護系統數據文件做好準備。

概要設計說明書：該說明書是概要實際階段的工作成果，它應說明功能分配、模塊劃分、程序的總體結構、輸入輸出以及接口設計、運行設計、數據結構設計和出錯處理設計等，為詳細設計提供基礎。詳細設計說明書：著重描述每一模塊是怎樣實現的，包括實現算法、邏輯流程等。軟件開發項目文檔軟件需求說明書（軟件規格說明書）：對所開發軟件的功能、性能50

用戶操作手冊：本手冊詳細描述軟件的功能、性能和用戶界面，使用戶對如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運行情況的有關知識，特別是操作方法的具體細節。

測試計劃：為做好集成測試和驗收測試，需為如何組織測試制訂實施計劃。計劃應包括測試的內容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差范圍等。

測試分析報告：測試工作完成以后，應提交測試計劃執行情況的說明，對測試結果加以分析，并提出測試的結論意見。

開發進度月報：該月報系軟件人員按月向管理部門提交的項目進展情況報告，報告應包括進度計劃與實際執行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。軟件開發項目文檔軟件開發項目文檔51

項目開發總結報告：軟件項目開發完成以后，應與項目實施計劃對照，總結實際執行的情況，如進度、成果、資源利用、成本和投入的人力，此外，還需對開發工作做出評價，總結出經驗和教訓。

軟件維護手冊：主要包括軟件系統說明、程序模塊說明、操作環境、支持軟件的說明、維護過程的說明，便于軟件的維護。

軟件問題報告：指出軟件問題的登記情況，如日期、發現人、狀態、問題所屬模塊等，為軟件修改提供準備文檔。

軟件修改報告：軟件產品投入運行以后，發現了需對其進行修正、更改等問題，應將存在的問題、修改的考慮以及修改的影響作出詳細的描述，提交審批。軟件開發項目文檔軟件開發項目文檔52一、可行性分析報告1.1編寫目的：闡明編寫可行性研究報告的目的，提出讀者對象。1.2項目背景：應包括●所建議開發軟件的名稱●項目的任務提出者、開發者、用戶及實現軟件的單位●項目與其他軟件或其他系統的關系。1.3定義：列出文檔中用到的專門術語的定義和縮寫詞的原文。1.4參考資料：列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括●項目經核準的計劃任務書、合同或上級機關的批文●與項目有關的已發表的資料●文檔中所引用的資料，所采用的軟件標準或規范

一、可行性分析報告1.1編寫目的：闡明編寫可行性研究報告的532可行性研究的前提2.1要求：列出并說明建議開發軟件的的基本要求，如●功能●性能●輸入/輸出●基本的數據流程和處理流程●安全與保密要求●與軟件相關的其他系統●完成日期2.2目標：可包括●人力與設備費用的節省●處理速度的提高●控制精度或生產力的提高●管理信息服務的改進●決策系統的改進●人員工作效率的提高

2可行性研究的前提542.3條件、假定和限制：可包括●建議開發軟件運行的最短壽命●進行顯然方案選擇比較的期限●經費來源和使用限制●法律和政策方面的限制●硬件、軟件、運行環境和開發環境的條件和限制●可利用的信息和資源●建議開發軟件投入使用的最遲時間2.4可行性研究方法2.5決定可行性的主要因素

2.3條件、假定和限制：可包括553對現有系統的分析3.1處理流程和數據流程3.2工作負荷3.3費用支出：如人力、設備、空間、支持性服務、材料等項開支3.4人員：列出所需人員的專業技術類別和數量3.5設備3.6局限性：說明現有系統存在的問題以及為什么需要開發新的系統

3對現有系統的分析564所建議技術可行性分析4.1對系統的簡要描述4.2與現有系統比較的優越性4.3處理流程和數據流程4.4采用建議系統可能帶來的影響●對設備的影響●對現有軟件的影響●對用戶的影響●對系統運行的影響●對開發環境的影響●對經費支出的影響4.5技術可行性評價:包括●在限制條件下，功能目的是否達到●利用現有技術，功能目的是否達到●對開發人員數量和質量的要求，并說明能否滿足●在規定的期限內，開發能否完成

4所建議技術可行性分析575所建議系統經濟可行性分析5.1支出5.2效益5.3收益/投資比5.4投資回收周期5.5敏感性分析：指一些關鍵性因素，如：●系統生存周期長短●系統工作負荷量●處理速度要求●設備和軟件配置變化對支出和效益的影響等的分析

5所建議系統經濟可行性分析586社會因素可行性分析6.1法律因素：如●合同責任●侵犯專利權●侵犯版權6.2用戶使用可行性：如●用戶單位的行政管理●工作制度●人員素質等能否滿足要求7其他可供選擇的方案逐個闡明其它可供選擇的方案，重點說明未被推薦的理由。8結論意見●可著手組織開發●需等待若干條件具備后才能開發●需對開發目標進行某些修改●不能進行或不必進行●其它

6社會因素可行性分析59二、項目開發計劃

1引言1.1編寫目的：闡明編寫可行性研究報告的目的，提出讀者對象1.2項目背景：應包括●項目的委托單位、開發單位和主管部門；●該軟件系統與其他系統的關系。1.3定義：列出文檔中用到的專門術語的定義和縮寫詞的原文1.4參考資料：可包括：●項目經核準的計劃任務書、合同或上級機關的批文●文檔所引用的資料、規范等●列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源；

二、項目開發計劃602項目概述2.1工作內容:簡要說明項目的各項主要工作，介紹所開發軟件的功能、性能等；若不編寫可行性研究報告；則應在本節給出較詳細的介紹；2.2條件與限制:闡明為完成項目應具備的條件、開發單位已具備的條件以及尚需創造的條件。必要時還應說明用戶及分合同承擔的工作、完成期限及其他條件與限制。2.3產品2.3.1程序：列出應交付的程序名稱、使用的語言及存儲形式。2.3.2文檔：列出應交付的文檔。2.4運行環境：應包括硬件環境、軟件環境。2.5服務：闡明開發單位可向用戶提供的服務。如人員培訓、安裝、保修、維護和其他運行支持。2.6驗收標準

2項目概述613實施計劃3.1任務分解：任務的劃分及各項任務的負責人。3.2進度：按階段完成的項目，用圖表說明開始時間、完成時間。3.3預算3.4關鍵問題：說明可能影響項目的關鍵問題，如設備條件、技術難點或其他風險因素，并說明對策。4人員組織及分工5交付期限6專題計劃要點如測試計劃、質量保證計劃、配置管理計劃、人員培訓計劃、系統安裝計劃等。

3實施計劃62三、軟件需求說明書

1引言1.1編寫目的：闡明編寫需求說明書的目的，指明讀者對象。1.2項目背景：應包括●項目的委托單位、開心單位和主管部門；●該軟件系統與其他系統的關系。1.3定義：列出文檔中所用到的專門術語的定義和縮寫詞的愿文。1.4參考資料：可包括●項目經核準的計劃任務書、合同或上級機關的批文●文檔所引用的資料、規范等●列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源

三、軟件需求說明書632任務概述2.1目標2.2運行環境2.3條件與限制3數據描述3.1表態數據3.2動態數據：包括輸入數據和輸出數據。3.3數據庫描述：給出使用數據庫的名稱和類型。3.4數據詞典3.5數據采集

2任務概述644功能需求4.1功能劃分4.2功能描述5性能需求5.1數據精確度5.2時間特性：如響應時間、更新處理時間、數據轉換與傳輸時間、運行時間等。5.3適應性：在操作方式、運行環境、與其他軟件的接口以及開發計劃等發生變化時，應具有的適應能力。

4功能需求656運行需求6.1用戶界面：如屏幕格式、報表格式、菜單格式、輸入輸出時間等。6.2硬件接口6.3軟件接口6.4故障處理7其他需求如可使用性、安全保密、可維護性、可移植性等。

6運行需求66四、概要設計說明書1引言1.1寫目的：闡明編寫概要設計說明書的目的，指明讀者對象。1.2項目背景：應包括●項目的委托單位、開發單位和主管部門●該軟件系統與其他系統的關系。1.3定義：列出本文檔中所用到的專門術語的定義和縮寫詞的愿意。1.4參考資料：●列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源●項目經核準的計劃任務書、合同或上級機關的批文；項目開發計劃；需求規格說明書；測試計劃（初稿）；用戶操作手冊●文檔所引用的資料、采用的標準或規范。

四、概要設計說明書672任務概述2.1目標2.2需求概述2.3條件與限制3總體設計3.2總體結構和模塊外部設計3.3功能分配：表明各項功能與程序結構的關系。

4接口設計4.1外部接口：包括用戶界面、軟件接口與硬件接口。4.2內部接口：模塊之間的接口。

2任務概述685數據結構設計6邏輯結構設計所有文檔的統一封面格式如下頁所示。7物理結構設計8數據結構與程序的關系9運行設計9.1運行模塊的組合9.2運行控制9.3運行時間

10出錯處理設計10.1出錯輸出信息10.2出錯處理對策：如設置后備、性能降級、恢復及再啟動等。11安全保密設計12維護設計說明為方便維護工作的設施，如維護模塊等。5數據結構設計69五、詳細設計說明書1引言1.1編寫目的：闡明編寫詳細設計說明書的目的，指明讀者對象。1.2項目背景：應包括項目的來源和主管部門等。1.3定義：列出本文檔中所用到的專門術語的定義和縮寫詞的愿意。1.4參考資料：●列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源●項目經核準的計劃任務書、合同或上級機關的批文；項目開發計劃；需求規格說明書；概要設計說明書；測試計劃（初稿）；用戶操作手冊●文檔所引用的資料、軟件開發的標準或規范。

五、詳細設計說明書702總體設計2.1需求概述2.2軟件結構：如給出軟件系統的結構圖。3程序描述3.1逐個模塊給出以下說明：●功能●性能●輸入項目●輸出項目3.2算法：模塊所選用的算法。3.3程序邏輯：詳細描述模塊實現的算法，可采用：標準流程圖；PDL語言；N-S圖；判定表等描述算法的圖表。3.4接口●存儲分配●限制條件3.5測試要點：給出測試模塊的主要測試要求。

2總體設計71六、用戶操作手冊

1引言1.1編寫目的：闡明編寫手冊的目的，指明讀者對象。1.2項目背景：說明項目的來源、委托單位、開發單位及和主管部門。1.3定義：列出手冊中使用的專門術語的定義和縮寫詞的愿意。1.4參考資料：●列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源●項目經核準的計劃任務書、合同或上級機關的批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；測試計劃●文檔中所引用的其他資料、采用的軟件工程標準或軟件工程規范。

六、用戶操作手冊722軟件概述2.1目標2.2功能2.3性能2.4數據精確度：包括輸入、輸出及處理數據的精度。2.5時間特性：如響應時間、處理時間、數據傳輸時間等。2.6靈活性：在操作方式、運行環境需做某些變更時軟件的適應能力。3運行環境3.1硬件●列出軟件系統運行時所需的硬件最小配置，如計算機型號、主存容量●外存儲器、媒體、記錄格式、設備型號及數量●輸入、輸出設備●數據傳輸設備及數據轉換設備的型號及數量。3.2支持軟件●操作系統名稱及版本號●語言編譯系統或匯編系統的名稱及版本號●數據庫管理系統的名稱及版本號●其他必要的支持軟件

2軟件概述734使用說明4.1安裝和初始化：給出程序的存儲形式、操作命令、反饋信息及其做含意、表明安裝完成的測試實例以及安裝所需的軟件工具等。4.2輸入：給出輸入數據或參數的要求。●數據背景：說明數據來源、存儲媒體、出現頻度、限制和質量管理等。●數據格式:如長度、格式基準、標號、順序、分隔符、詞匯表、省略和重復、控制。●輸入舉例。4.3輸出：給出每項輸出數據的說明。●數據背景：說明輸出數據的去向、使用頻度、存放媒體及質量管理等。●數據格式：詳細闡明每一輸出數據的格式，如首部、主體和尾部的具體形式。●舉例4.4出錯和恢復：給出出錯信息及其含意；用戶應采取的措施，如修改、恢復、再啟動。4.5求助查詢：說明如何操作。

4使用說明745運行說明5.1運行表：列出每種可能的運行情況，說明其運行目的。5.2運行步驟：按順序說明每和運行的步驟，應包括：5.3運行控制5.4操作信息：運行目的、運行目的、操作要求、啟動方法、預計運行時間、操作命令格式及說明、其他事項；5.5輸入/輸出文件：給出建立或更新文件的有關信息，如：文件的名稱及編號；記錄媒體；存留的目錄；文件的支配：說明確定保留文件或廢棄文件的準則，分發文件的對象，戰勝硬件的優先級及保密控制等。5.6啟動或恢復過程

5運行說明756非常規過程提供應急戒非常規操作的必要信息及操作步驟，如出錯處理操作、向后備系統切換操作及維護人員須知的操作和注意事項。7操作命令一覽表按字母順序逐個列出全部操作命令的格式、功能及參數說明。8程序文件（或命令文件）和數據文件一覽表按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標識符及說明。9用戶操作舉例

6非常規過程76七、測試計劃

1引言1.1編寫目的：闡明編寫測試計劃的目的并指明讀者對象。1.2項目背景：說明項目的來源、委托單位及主管部門。1.3定義：列出測試計劃中所用到的專門術語的定義和縮寫詞的原意。1.4參考資料：列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；用戶操作手冊；本測試計劃中引用的其他資料、采用的軟件開發標準或規范。

七、測試計劃772任務概述2.1目標2.2運行環境2.3需求概述2.4條件與限制3計劃3.1測試方案：說明測試方法和選取測試用例的原則。3.2測試項目：列出組裝測試和確認測試中每一項測試的內容、名稱、目的和進度。3.3測試準備3.4測試機構及人員：測試機構名稱、負責人和職責。

2任務概述784測試項目說明4.1按順序逐個對測試項目做出說明4.1.1測試項目名稱及測試內容4.1.2測試用例4.1.3輸入：輸入的數據和輸入命令。4.1.4輸出：預期的輸出數據。4.2步驟及操作4.3允許偏差：給出實測結果與預期結果之間允許偏差的范圍。4.4進度4.5條件：給出項測試對資源的特殊要求，如設備、軟件、人員等。4.6測試資料：說明項測試所需的資料。5評價5.1范圍：說明所完成的各項測試說明問題的范圍及其局限性。5.2準則：說明評論測試結果的準則。

4測試項目說明79八、測試分析報告

1引言1.1編寫目的：闡明編寫測試分析報告的目的并指明讀者對象。1.2項目背景：說明項目的來源、委托單位及主管部門。1.3定義：列出測試分析報告中所用到的專門術語的定義和縮寫詞的原意。1.4參考資料：列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；用戶操作手冊；測試計劃；測試分析報告所引用的其他資料、采用的軟件工程標準或工程規范。

八、測試分析報告802測試計劃招待情況2.1機構和人員：給出測試機構名稱、負責人和參與測試人員名單。2.2測試結果：按順序給出每一測試項目的：實測結果數據；與預期結果數據的偏差；該項測試表明的事實；該項測試發現的問題。3軟件需求測試結論按順序給出每一項需求測試的結論。包括：證實的軟件能力；局限性（即項需求未得到充分測試的情況及原因。4評價4.1軟件能力：經過測試所表明的軟件能力。4.2缺陷和限制：說明測試所揭露的軟件缺陷和不足，以及可能給軟件運行帶來的影響。4.3建議：提出為彌補上述缺陷的建議。4.4測試結論：說明能否通過。

2測試計劃招待情況81九、開發進度月報

1報告時間及所處的開發階段2工程進度2.1本月內的主要活動2.2實際進展與計劃比較3所用工時按不同層次人員分別計時。4所用機時按所用計算機機型分別計時。5經費支出分類列出本月經費支出項目，給出支出總額，并與計劃比較。6工作遇到的問題及采取的對策7本月完成的成果8下月的工作計劃9特殊問題

九、開發進度月報82十、項目開發總結報告

1引言1.1編寫目的：闡明編寫總結報告的目的并指明讀者對象。1.2項目背景：說明項目的來源、委托單位、開發單位及主管部門。1.3定義：列出報告中所用到的專門術語的定義和縮寫詞的原意。1.4參考資料：列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：項目的計劃任務書、合同或批文；項目開發計劃；需求規格說明書；概要設計說明書；詳細設計說明書；用戶操作手冊；測試計劃；測試分析報告；本報告引用的其他資料、采用的開發標準或開發規范。

十、項目開發總結報告832開發結果2.1產品：可包括列出各部分的程序名稱、源程序行數（包括注釋行）或目標程序字節數及程序總計數量、存儲形式；產品文檔名稱等。2.2主要功能及性能2.3所用工時：按人員的不同層次分別計時。2.4所用機時：按所用計算機機型分別計時。2.5進度：給出計劃進度與實際進度的對比。2.6費用3評價3.1生產率評價：如平均每人每月生產的源程序行數、文檔的字數等。3.2技術方案評價3.3產品質量評價4經驗與教訓

2開發結果84十一、軟件維護手冊

1引言1.1編寫目的：闡明編寫手冊的目的并指明讀者對象。1.2項目背景：說明項目的提出者、開發者、用戶和使用場所。1.3定義：列出報告中所用到的專門術語的定義和縮寫詞的原意。1.4參考資料：列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，及保密級別，可包括：用戶操作手冊；與本項目有關的其他文檔。

十一、軟件維護手冊852系統說明2.1系統用途：說明系統具備的功能，輸入和輸出。2.2安全保密：說明系統安全保密方面的考慮。2.3總體說明：說明系統的總體功能，對系統、子系統和作業做出綜合性的介紹，并用圖表的方式給出系統主要部分的內部關系。2.4程序說明：說明系統中每一程序、分程序的細節和特性。2.4.1程序1的說明●功能：說明程序的功能。●方法：說明實現方法。●輸入：說明程序的輸入、媒體、運行數據記錄、運行開始時使用的輸入數據的類型和存放單元、與程序初始化有關的入口要求。●處理：處理特點和目的，如：用圖表說明程序的運行的邏輯流程；程序主要轉移條件；對程序的約束條件；程序結束時的出口要求；與下一個程序的通信與聯結（運行、控制）；由該程序產生并茶館處理程序段使用的輸出數據類型和存放單元；程序運行存儲量、類型及存儲位置等。

2系統說明86●輸出：程序的輸出。●接口：本程序與本系統其他部分的接口。●表格：說明程序內部的各種表、項的細節和特性。對每張表的說明至少包括：表的標識符；使用目的；使用此表的其他程序；邏輯劃分，如塊或部，不包括表項；表的基本結構；設計安排，包括表的控制信息。表目結構細節、使用中的特有性質及各表項的標識、位置、用途、類型、編碼表示。●特有的運行性質：說明在用戶操作手冊中沒有提到的運行性質。

2.4.2程序2的說明與程序1的說明相同。以后的其他各程序的說明相同。●輸出：程序的輸出。873操作環境