前言：
不同顔色代表不同的文檔，本文闡述了軟體開發過程中十二個必要文檔的書寫格式與規範，喜歡的話可以點個收藏轉發。
軟體文檔編寫指南
目錄
封面格式
系統規約說明書（System Specification）
一．引言
A. 文檔的範圍和目的
B. 概述
1．目标
2．限制
二．功能和資料描述
A. 系統結構
1．結構關系圖
2．結構關系圖描述
三．子系統描述
A. 子系統 N 的結構圖規約說明
B. 結構字典
C. 結構連接配接圖和說明
四．系統模組化和模拟結構
A. 用于模拟的系統模型
B. 模拟結果
C. 特殊性能
五．軟體項目問題
A. 軟體項目可行性研究報告
B. 軟體項目計劃
六．附錄
軟體項目可行性研究報告
一．引言
1．編寫目的（闡明編寫可行性研究報告的目的，指出讀者對象）
2．項目背景（應包括：（1）所建議開發的軟體名稱；（2）項目的任務提出者、開發者、
使用者及實作機關；（3）項目與其他軟體或其他系統的關系。）
3．定義（列出文檔中用到的專門術語的定義和縮略詞的原文。）
4．參考資料（列出有關資料的作者、标題、編号、發表日期、出版機關或資料來源。）
二．可行性研究的前提
1． 要求（列出并說明建議開發軟體的基本要求，如（1）功能；（2）性能；（3）輸出；（4）輸入；（5）基本的資料流程和處理流程；（6）安全與保密要求；（7）與軟體相關的其他系統；（8）完成期限。）
2． 目标（可包括：（1）人力與裝置費用的節省；（2）處理速度的提高；（3）控制精度和生産能力的提高；（4）管理資訊服務的改進；（5）決策系統的改進；（6）人員工作效率的提高，等等。）
3． 條件、假定和限制（可包括：（1）建議開發軟體運作的最短壽命；（2）進行系統方案選擇比較的期限；（3）經費來源和使用限制；（4）法律和政策方面的限制；（5）硬體、軟體、運作環境和開發環境的條件和限制；（6）可利用的資訊和資源；（7）建議開發軟體投入使用的最遲時間。）
4． 可行性研究方法
5． 決定可行性的主要因素
三．對現有系統的分析
1．處理流程和資料流程
2．工作負荷
3．費用支出（如人力、裝置、空間、支援性服務、材料等項開支。）
4．人員（列出所需人員的專業技術類别和數量。）
5．裝置
6．局限性（說明現有系統存在的問題以及為什麼需要開發新的系統。）
四．所建議技術可行性分析
1．對系統的簡要描述
2．處理流程和資料流程
3．與現有系統比較的優越性
4．采用建議系統可能帶來的影響
（1）對裝置的影響
（2）對現有軟體的影響
（3）對使用者的影響
（4）對系統運作的影響
（5）對開發環境的影響
（6）對運作環境的影響
（7）對經費支出的影響
5．技術可行性評價（包括：（1）在限制條件下，功能目标是否能夠達到；（2）利用現有軟體文檔編寫指南技術，功能目标能否達到；（3）對開發人員數量和品質的要求，并說明能否滿足；（4）在規定的期限内，開發能否完成。）
五．所建議系統經濟可行性分析
1．指出
（1）基建投資
（2）其他一次性支出
（3）經常性支出
2．效益
（1）一次性收益
（2）經常性收益
（3）不可定量收益
3．收益/投資比
4．投資回收周期
5．敏感性分析（指一些關鍵性因素，如：系統生存周期長短、系統工作負荷量、處理速
度要求、裝置和軟體配置變化對支出和效益的影響等的分析。）
六．社會因素可行性分析
1．法律因素（如，合同責任、侵犯專利權、侵犯版權等問題的分析。）
2．使用者使用可行性（如，使用者機關的行政管理、工作制度、人員素質等能否滿足要求。）
七．其他可供選擇的方案（逐個闡明其他可供選擇的方案，并重點說明未被推薦的理由。）
八．結論意見（可能是：（1）可着手組織開發；（2）需待若幹條件（如資金、人力裝置等）具備後才能開發；（3）需對開發目标進行某些修改；（4）不能進行或不必進行（如技術不成熟，經濟上不合算等）；（4）其他。）
軟體項目計劃（Software Project Plan）
一．引言
1．編寫目的（闡明編寫軟體計劃的目的，指出讀者對象。）
2．項目背景（可包括：（1）項目委托機關、開發機關和主管部門；（2）該軟體系統與其
他系統的關系。）
3．定義（列出本文檔中用到的專門術語的定義和縮略詞的原文。）
4．參考資料（可包括：（1）項目經核準的計劃任務書、合同或上級機關的批文；（2）文
檔所引用的資料、規範等；列出資料的作者、标題、編号、發表日期、出版機關或資
料來源。）
二．項目概述
1. 工作内容（簡要說明項目的各項主要工作,介紹所開發軟體的功能 性能等. 若不編寫可
行性研究報告,則應在本節給出較詳細的介紹。)
2. 條件與限制（闡明為完成項目應具備的條件 開發機關已具備的條件以及尚需創造的條
件. 必要時還應說明使用者及分合同承包者承擔的工作 完成期限及其它條件與限制。）
3. 産品
（1）程式（列出應傳遞的程式名稱 使用的語言及存儲形式。）
（2）文檔（列出應傳遞的文檔。）
（3）運作環境（應包括硬體環境 軟體環境。）
4．服務（闡明開發機關可向使用者提供的服務. 如人員教育訓練 安裝 保修 維護和其他運作支
持。）
5．驗收标準
三．實施計劃
1．任務分解（任務的劃分及各項任務的負責人。）
2．進度（按階段完成的項目,用圖表說明開始時間 完成時間。）
3．預算
4．關鍵問題（說明可能影響項目的關鍵問題,如裝置條件 技術難點或其他風險因素,并說
明對策。）
四．人員組織及分工
五．傳遞期限
六．專題計劃要點（如測試計劃 品質保證計劃 配置管理計劃 人員教育訓練計劃 系統安裝計劃
等。）
需求規格說明書（Requirements Specification）
一．引言
1． 編寫目的（闡明編寫需求說明書的目的,指明讀者對象。）
2． 項目背景（可包括：（1）項目的委托機關,開發機關和主管部門；（2）該軟體系統與其
他系統的關系。）
3． 定義（列出文檔中用到的專門術語定義和縮寫詞的原文。）
4． 參考資料（可包括：（1）項目經核準的計劃任務書,合同或上機機關的批文；（2）項目
開發計劃；（3）文檔所引用的資料，标準和規範。列出這些資料的作者、标題、編号、
發表日期、出版機關或資料來源。）
二．任務概述
1．目标
2．運作環境
3．條件與限制
三．資料描述
1． 靜态資料
2． 動态資料（包括輸入資料和輸出資料。）
3． 資料庫描述（給出使用資料庫的名稱和類型。）
4． 資料詞典
5． 資料采集
四．功能需求
1．功能劃分
2．功能描述
五．性能需求
1．資料精确度
2．時間特性（如響應時間、更新處理時間、資料轉化與傳輸時間、運作時間等。）
3．适應性（在操作方式 運作環境 與其他軟體的接口以及開發計劃等發生變化時，應具
有的适應能力。）
六．運作需求
1．使用者界面（如螢幕格式、報表格式、菜單格式、輸入輸出時間等。）
2．硬體接口
3．軟體接口
4．故障處理
七．其他需求（如可使用性、安全保密、可維護性、可移植性等。）
概要設計說明書（Architectural Design Specification）
一．引言
1．編寫目的（闡明編寫概要設計說明書的目的，指明讀者對象。）
2．項目背景（可包括：（1）項目的委托機關,開發機關和主管部門；（2）該軟體系統與其
他系統的關系。）
3．定義（列出文檔中用到的專門術語定義和縮寫詞的原意。）
4．參考資料（列出這些資料的作者、标題、編号、發表日期、出版機關或資料來源，可
包括：（1）項目經核準的計劃任務書，合同或上機機關的批文；（2）項目開發計劃；
（3）需求規格說明書；（4）測試計劃（初稿）；（5）使用者操作手冊（初稿）；（6）文檔
所引用的資料、采用的标準或規範。）
二．任務概述
1．目标
2．運作環境
3．需求概述
4．條件與限制
三．總體設計
1．處理流程
2．總體結構和子產品外部設計
3．功能配置設定（表明各項功能與程式結構的關系。）
四．接口設計
1．外部接口（包括使用者界面 軟體接口與硬體接口。）
2．内部接口（子產品之間的接口。）
五．資料結構設計
1． 邏輯結構設計
2． 實體結構設計
3． 資料結構與程式的關系
六．運作設計
1．運作子產品的組合
2．運作控制
3．運作時間
七．出錯處理設計
1．出錯輸出資訊
2．出錯處理對策（如設定後備、性能降級、恢複及再啟動等。）
八．安全保密設計
九．維護設計（說明為友善維護工作的設施,如維護子產品等。）
詳細設計說明書（Procedural Design Specification）
一．引言
1． 編寫目的（闡明編寫詳細設計說明書的目的,指明讀者對象。）
2． 項目背景（應包括項目的來源和主管部門等。）
3． 定義（列出文檔中用到的專門術語定義和縮寫詞的原意。）
4． 參考資料（列出這些資料的作者、标題、編号、發表日期、出版機關或資料來源，可
包括：（1）項目的計劃任務書,合同或批文；（2）項目開發計劃；（3）需求規格說明書；
（3）概要設計說明書；（4）測試計劃(初稿)；（5）使用者操作手冊(初稿)；（5）文檔所
引用的其他資料、軟體開發标準或規範。）
二．總體設計
1．需求概述
2．軟體結構（如給出軟體系統的結果圖。）
三．程式描述（逐個子產品給出以下的說明:：）
1．功能
2．性能
3．輸入項目
4．輸出項目
5．算法（子產品所選用的算法。）
6．程式邏輯（較長的描述子產品實作的算法，可采用:：（1）标準流程圖；（2）PDL 語言；（3）N-S 圖；（4）PAD；（5）判定表等描述算法的圖表。）
7．接口
8．存儲配置設定
9．限制條件
10． 測試要點（給出測試子產品的主要測試要求。）
使用者操作手冊（User Guide）
一．引言
1．編寫目的（闡明編寫手冊的目的，指明讀者對象。）
2．項目背景（說明項目的來源、委托機關、開發機關及主管部門。）
3．定義（列出手冊中用到的專門術語定義和縮寫詞的原意。）
4．參考資料（列出這些資料的作者、标題、編号、發表日期、出版機關或資料來源，可
包括：（1）項目的計劃任務書,合同或批文；（2）項目開發計劃；（3）需求規格說明書；
（4）概要設計說明書；（5）詳細設計說明書；（6）測試計劃；（7）手冊中引用的其他
資料、采用的軟體工程标準或軟體工程規範。）
二．軟體概述
1．目标
2．功能
3．性能
（1）資料精确度（包括輸入、輸出及處理資料的精度。）
（2）時間特性（如響應時間、處理時間、資料傳輸時間等。）
（3）靈活性（在操作方式、運作環境需做某些變更時軟體的适應能力。）
三．運作環境
1．硬體（列出軟體系統運作時所需的硬體最小配置，如：（1）計算機型号、主存容量；
（2）外存儲器、媒體、記錄格式、裝置型号及數量；（3）輸入、輸出裝置；（4）資料
傳輸裝置及資料轉換裝置的型号及數量。）
2．支援軟體（如：（1）作業系統名稱及版本号；（2）語言編譯系統或彙編系統的名稱及
版本号；（3）資料庫管理系統的名稱及版本号；（4）其他必要的支援軟體。）
四．使用說明
1．安裝和初始化（給出程式的存儲形式、操作指令、回報資訊及其含義、表明安裝完成
的測試執行個體以及安裝所需的軟體工具等。）
2．輸入（給出輸入資料或參數的要求。）
（1）資料背景（說明資料來源、存儲媒體、出現頻度、限制和品質管理等。）
（2）資料格式（如：（1）長度（2）格式基準（3）标号（4）順序（5）分隔符（6）
詞彙表（7）省略和重複（8）控制。）
（3）輸入舉例
3．輸出（給出每項輸出資料的說明。）
（1）資料背景（說明輸出資料的去向、使用頻度、存放媒體及品質管理等。）
（2）資料格式（詳細闡明每一輸出資料的格式,如:首部 主體和尾部的具體形式。）
（3）舉例
3．出錯和恢複（給出：（1）出錯資訊及其含義（2）使用者應采取的措施，如修改、恢複、
再啟動。）
4．求助查詢（說明如何操作。）
五．運作說明
1． 運作表 [列出每種可能的運作情況,說明其運作目的.]
2． 運作步驟 [按順序說明每種運作的步驟,應包括:]
軟體文檔編寫指南
（1） 運作控制
（2） 操作資訊（（1）運作目的（2）操作要求（3）啟動方法（4）預計運作時間（5）
操作指令格式及說明（6）其他事項。）
（3） 輸入/輸出檔案（給出建立和更新檔案的有關資訊，如：（1）檔案的名稱及編
号（2）記錄媒體（3）存留的目錄（4）檔案的支配[說明确定保留檔案或廢棄
檔案的準則，分發檔案的對象，占用硬體的優先級及保密控制等。）
（4） 啟動或恢複過程
六．非正常過程（提供應急或非正常操作的必要資訊及操作步驟，如出錯處理操作、向後備
系統切換操作以及維護人員須知的操作和注意事項。）
七．操作指令一覽表
（按字母順序逐個列出全部操作指令的格式 功能及參數說明。）
八．程式檔案（或指令檔案）和資料檔案一覽表（按檔案名字母順序或按功能與子產品分類順
序逐個列出檔案名稱、辨別符及說明。）
九．使用者操作舉例
測試計劃（Test Plan）
一、引言
1． 編寫目的（闡明編寫測試計劃的目的,指明讀者對象。）
2． 項目背景（說明項目的來源 委托機關及主管部門。）
3． 定義（列出測試計劃中用到的專門術語定義和縮寫詞的原意。）
4． 參考資料（列出這些資料的作者、标題、編号、發表日期、出版機關或資料來源，可
包括：（1）項目的計劃任務書，合同或批文；（2）項目開發計劃；（3）需求規格說明
書；（3）概要設計說明書；（4）詳細設計說明書；（5）使用者操作手冊; g 本測試計劃中
引用的其他資料 采用的軟體開發标準或規範。）
二．任務概述
1．目标
2．運作環境
3．需求概述
4．條件與限制
三．計劃
1．測試方案（說明确定測試方法和選取測試用例的原則。）
2．測試項目（列出組裝測試和确認測試中每一項測試的内容、名稱、目的和進度。）
3．測試準備
4．測試機構及人員（測試機構名稱 負責人和職責。）
四．測試項目說明（按順序逐個對測試項目做出說明：）
1．測試項目名稱及測試内容
2．測試用例
（1）輸入（輸入的資料和輸入的指令。）
（2）輸出（預期的輸出資料。）
（3）步驟及操作
（4）允許偏差（給出實測結果與預測結果之間允許偏差的範圍。）
3． 進度
4． 條件（給出項測試對資源的特殊要求，如裝置、軟體、人員等。）
5． 測試資料（說明項測試所需的資料。）
五．評價
1．範圍（說明所完成的各項測試說明問題的範圍及其局限性。）
2．準則（說明評價測試結果的準則。）
測試分析報告（Test Specification）
一．引言
1．編寫目的（闡明編寫測試分析報告的目的，指明讀者對象。）
2．項目背景（說明項目的來源、委托機關及主管部門。）
3．定義（列出測試分析報告中用到的專門術語定義和縮寫詞的原意。）
4．參考資料（列出這些資料的作者、标題、編号、發表日期、出版機關或資料來源，可
包括：（1）項目的計劃任務書，合同或批文；（2）項目開發計劃；（3）需求規格說明
書；（4）概要設計說明書；（5）詳細設計說明書；（6）使用者操作手冊；（7）測試計劃；
（8）測試分析報告所引用的其他資料、采用的軟體工程标準或軟體工程規範。）
二．測試計劃執行情況
1．測試項目（列出每一測試項目的名稱、内容和目的。）
2．測試機構和人員（給出測試機構名稱、負責人和參與測試人員名單。）
3．測試結果（按順序給出每一測試項目的：（1）實測結果資料（2）與預期結果資料的偏
差（3）該項測試說明的事實（4）該項測試發現的問題。）
三．軟體需求測試結論（按順序給出每一項需求測試的結論。包括：（1）證明的軟體能力（2）
局限性（即項需求未得到充分測試的情況及原因）。）
四．評價
1．軟體能力（經過測試所表明的軟體能力。）
2．缺陷和限制（說明測試所揭露的軟體缺陷和不足,以及可能給軟體運作帶來的影響。）
3．建議（提出為彌補上述缺陷的建議。）
4．測試結論（說明能否通過。）
開發進度月報
一．報告時間及所處的開發階段
二．給出進度
1． 本月内的主要活動
2． 實際進展與計劃比較
三．所用工時（按不同層次人員分别計時。）
四．所有機時（按所有計算機機型分别計時。）
五．經費支出（分類列出本月經費支出項目,給出支出總額，并與計劃比較。）
六．工作遇到的問題及采取的對策
七．本月完成的成果
八．下月的工作計劃
九．特殊問題
項目開發總結報告
一．引言
1．編寫目的（闡明編寫總結報告的目的,指明讀者對象。）
2．項目背景（說明項目的來源、委托機關、開發機關及主管部門。）
3．定義（列出報告中用到的專門術語定義和縮寫詞的原意。）
4．參考資料（列出這些資料的作者、标題、編号、發表日期、出版機關或資料來源，可
包括：（1）項目的計劃任務書，合同或批文；（2）項目開發計劃；（3）需求規格說明
書；（4）概要設計說明書；（5）詳細設計說明書；（6）使用者操作手冊；（7）測試計劃；
（8）測試分析報告（9）本報告引用的其他資料、采用的開發标準或開發規範。）
二．開發結果
1． 産品（可包括：（1）列出各部分的程式名稱、源程式行數（包括注釋行）或目标程式
位元組數及程式總計數量、存儲形式；産品文檔名稱等。）
2． 主要功能及性能
3． 所用工時（按人員的不同層次分别計時。）
4． 所用機時（按所用計算機機型分别計時。）
5． 進度（給出計劃進度與實際進度的對比。）
6． 費用
三．評價
1．生産率評價（如平均每人每月生産的源程式行數、文檔的字數等。）
2．技術方案評價
3．産品品質評價
四．經驗與教訓
軟體修改報告
一．登記号（由軟體配置管理部門為該報告規定的編号。）
二．登記日期（軟體配置管理部門登記”軟體修改報告”的日期。）
三．時間（準備好”軟體修改報告”的日期。）
四．報告人（填寫該報告的作者。）
五．子系統名（受修改影響的子系統名。）
六．子產品名（被修改的子產品名。）
七．“軟體問題報告”的編号（被”軟體修改報告”處理或部分處理的”軟體問題報告”的編号。）
八．修改（包括程式修改、檔案更新、資料庫修改或他們的組合。）
九．修改描述（修改的較長的描述。如果是檔案更新或資料庫修改，還要列出檔案更新通知或
資料庫修改申請的辨別符。）
十．準許人（準許人簽字，正式準許進行修改。）
十一． 語句類型（程式修改中涉及到的語句類型，包括：輸入/輸出語句類、計算語句類、
邏輯控制語句類、資料處理語句類(如資料傳送 存取語句類)。）
十二． 程式名（被修改的程式、檔案或資料庫名字。）
十三． 老修訂版（目前的版本/修訂本辨別。）
十四． 新修訂版（修改後的版本/修訂本辨別。）
十五． 資料庫（如果申請資料庫修改,則給出資料庫的辨別符。）
十六． 資料庫修改報告（資料庫修改申請号。）
十七． 檔案（如果要求對檔案進行修改，則給出檔案的名字。）
十八． 檔案更新（檔案更新通知單的編号。）
十九． 修改是否已測試（指出已對修改做了哪些測試，如單元、子系統、組裝、确認和運
行測試等，并注明測試成功與否。）
二十． “軟體問題報告”是否給出問題的準确描述
二十一． 題注釋（準确地叙述要維護的問題。）
二十二． 題源（指明問題來自于哪裡。）
二十三． 源（完成修改所需資源的估計，即總的人時數和計算機時間的開銷。）