1、軟件開發文檔封面格式文檔編號版本號文檔名稱：項目名稱：項目負責人：編寫年月日校對年月日審核年月曰批準年月日開發單位、可行性分析報告1 .引言1.1 編寫目的【闡明編寫本報告的目的。】1.2 項目背景【包括：a.開發軟件的名稱；b.任務的提出者、開發者及用戶；c.本項目與其它軟件或系統的關系。】1.3 定義【列出本文檔中用到的專門術語的定義和縮寫詞的原文。】1.4 參考資料【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：a.本項目經核準的計劃任務書、合同或上級機關的批文；b.與本項目有關的已發表的資料；c.本文檔中所引用的資料和所采用的軟件標準或規范。】2 .可行性研究的

2、前提2.1 要求【列出并說明建議開發軟件的基本要求，如a.功能；b.性能；c.輸出；d.輸入；e.基本的數據流程和處理流程；f.安全與保密要求；g.與本軟件相關的其它系統；h.完成期限。】2.2 目標【可包括，a.人力與設備費用的節省；b.處理速度的提高；c.控制精度或生產能力的提高；d.管理信息服務的改進；e.決策系統的改進；f.人員工作效率的提高等。】2.3 條件、假定和限制【可包括，a.建議開發軟件的最短壽命；b.進行系統方案選擇比較的期限；c.經費來源和使用限制；d.法律和政策方面的限制；e.硬件、軟件、運行環境和開發環境的條件和限制；f.可利用的信息和資源；g.建議開發軟件投入使用的

3、最遲時間。】2.4 可行性研究方法2.5 決定可行性的主要因素3 .對現有系統的分析3.1 處理流程和數據流程3.2 工作負荷3.3 費用支出【如人力、設備、空間、支持性服務、材料等項目開支】3.4 人員【列出所需人員的專業技術類別和數量】3.5 設備3.6 局限性【說明現有系統存在的問題以及為什么需要開發新的系統。】4 .新系統技術可行性分析4.1 對系統的簡要描述4.2 處理流程和數據流程4.3 與現有系統比較的優越性4.4 采用新系統可能帶來的影響4.4.1 對設備的影響4.4.2 對現有軟件的影響4.4.3 對用戶的影響4.4.4 對系統運行的影響4.4.5 對開發環境的影響4.4.6

4、 對運行環境的影響4.4.7 對經費支出的影響4.5 技術可行性評價【包括，a.在限制條件下，功能目標是否能達到；b.利用現有技術，功能目標能否達到；c.對開發人員數量和質量的要求，并說明能否滿足；d.在規定的期限內，開發能否完成。】5 .新系統經濟可行性分析5.1 支出5.1.1 基建投資5.1.2 其它一次性支出5.1.3 經常性支出5.2 效益5.2.1 一次性效益5.2.2 經常性效益5.2.3 不可定量收益5.3 收益/投資比5.4 投資回收周期5.5 敏感性分析【敏感性分析是指一些關鍵性因素，如：系統生存周期長短、系統工作負荷量、處理速度要求、設備和軟件配置變化對支出和效益的影響等

5、分析。】6 .社會因素可行性分析6.1 法律因素【如合同責任、侵犯版權等問題的分析】6.2 用戶使用可行性【如用戶單位的行政管理、工作制度、人員素質等能否滿足要求。】7 .其它可供選擇的方案【逐個闡明其它可供選擇的方案，并重點說明未被推薦的理由】8 .結論意見【結論意見可能是：a.可著手組織開發；b.需待條件（如資金、人力、設備等）具備后才能開發；c.需對開發目標進行某些修改；d.不能進行或不必進行（如技術不成熟，經濟上不合算等）；e.其它。】1.2.3.項目開發計劃引言1 編寫目的【闡明編寫本項目開發計劃的目的。】1 項目背景【包括：a.本項目的委托單位、開發單位和主管部門；b.本系統與其它

6、系統的關系。】1 定義【列出本文檔中用到的專門術語的定義和縮寫詞的原文。】1 參考資料【可包括：a.本項目經核準的計劃任務書、合同或上級機關的批文；b.本文檔中所引用的資料、規范等，列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源。】項目概述1.1 工作內容【簡明說明本項目的各項主要工作，介紹所開發軟件的功能、性能等。若不編寫可行性報告，則應在本節給出較詳細的介紹】1.2 條件與限制【闡明為完成本項目應具備的條件、開發單位已具備的條件以及尚需創造的條件。必要時還應說明用戶及項目合作者所承擔的工作、完成期限及其它條件與限制】1.3 產品1.3.1 程序【列出應交付的程序名稱、使用的語

7、言及存儲形式。】1.3.2 文檔【列出應交付文檔。】1.4 運行環境【包括硬件環境、軟件環境。】1.5 服務【闡明開發單位可向用戶提供的服務。如人員培訓I、安裝、保修、維護和其它運行支持】1.6 驗收標準實施計劃1 任務分解【任務的劃分及各項任務的負責人。】1 進度【按階段完成的項目，用圖表說明開始時間、完成時間。】1 預算1 關鍵問題【說明可能影響項目的關鍵性問題，如設備條件、技術難點或其它風險因素，并說明對策。】.人員組織與分工.交付期限.專題計劃【如測試計劃、質量保證計劃、配置管理計劃、人員培訓計劃、系統安裝計劃等。】三、需求分析說明書.引言編寫目的【闡明編寫本需求說明書的目的。】項目背

8、景【包括：a.本項目的委托單位、開發單位和主管部門；b.本系統與其它系統的關系。】定義【列出本文檔中用到的專門術語的定義和縮寫詞的原文。】參考資料【可包括：a.本項目經核準的計劃任務書、合同或上級機關的批文；b.項目開發計劃；c.本文檔中所引用的資料、標準和規范等，列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源。】.任務概述目標運行環境條件與限制.數據描述靜態數據動態數據【包括輸入數據和輸出數據。】數據庫描述【給出使用數據庫的名稱和類型。】數據字典數據采集.功能要求功能劃分功能描述.性能需求數據精確度時間特性【如響應時間、更新處理時間、數據轉換與傳輸時間、運行時間等。】適應性【在

9、操作方式、運行環境、與其它軟件的接口以及開發計劃等發生變化時應具有的適應能力。】.運行需求用戶界面【如屏幕格式、報表格式、菜單格式、輸入輸出時間等。】硬件接口軟件接口故障處理.其它需求【如可使用性、安全保密、可維護性、可移植性等。】四、概要設計說明書.引言編寫目的【闡明編寫本說明書的目的。】項目背景【包括：a.本項目的委托單位、開發單位和主管部門；b.本系統與其它系統的關系。】定義【列出本文檔中用到的專門術語的定義和縮寫詞的原文。】參考資料【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：a.本項目經核準的計劃任務書、合同或上級機關的批文；b.項目開發計劃；c.需求分析說

10、明書；d.測試計劃（初稿）；e.用戶操作手冊（初稿）；f.本文檔中所引用的資料、標準和規范。】.任務概述目標運行環境需求概述條件與限制.總體設計處理流程總體結構和模塊外部設計功能分配.接口設計外部接口【包括用戶界面、軟件接口與硬件接口】內部接口【模塊之間的接口】.數據結構設計邏輯結構設計物理結構設計數據結構與程序的關系.運行設計運行模塊的組合運行控制運行時間.出錯處理設計出錯輸出信息出錯處理對策【如設置后備、性能降級、恢復及再啟動等。】.安全保密設計.維護設計【說明為方便維護工作的設施，如維護模塊。】五、詳細設計說明書.引言編寫目的【闡明編寫本說明書的目的。】項目背景【包括項目來源、委托單位、

11、開發單位和主管部門。】定義【列出本文檔中用到的專門術語的定義和縮寫詞的原文。】參考資料【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：a.本項目經核準的計劃任務書、合同或上級機關的批文；b.項目開發計劃；c.需求分析說明書；d.概要設計說明書；e.測試計劃（初稿）；f.用戶操作手冊（初稿）；g.本文檔中所引用的資料、標準和規范。】.總體設計需求概述軟件結構【如給出軟件系統的結構圖】.程序描述功能性能輸入項目輸出項目算法【本模塊所選用的算法】程序邏輯【詳細描述本模塊實現的算法，可采用：a.標準流程圖；b.PDL語言；c.N-S圖；d.PAD;e.判斷表等描述算法的圖表。】

12、接口存儲分配限制條件測試要點【給出測試本模塊的主要測試要求。】六、用戶操作手冊.引言編寫目的【闡明編寫本手冊的目的。】項目背景【說明項目來源、委托單位、開發單位和主管部門。】定義【列出本文檔中用到的專門術語的定義和縮寫詞的原文。】參考資料【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：a.本項目經核準的計劃任務書、合同或上級機關的批文；b.項目開發計劃；c.需求分析說明書；d.概要設計說明書；e.詳細設計說明書；f.測試計劃（初稿）；g.本文檔中所引用的資料、標準和規范。】.軟件概述目標功能性能a.數據精確度【包括輸入、輸出及處理數據的精度。】b.時間特性【如響應時間、

13、處理時間、數據傳輸時間等。】c.靈活性【在操作方式、運行環境需作某些變更時本軟件的適應能力。】.運行環境硬件【列出本軟件系統運行時所需的硬件最小配置，如a.計算機型號、主存容量；b.外存儲器、媒體、記錄格式、設備型號及數量；c.輸入、輸出設備；d.數據傳輸設備及數據轉換設備的型號及數量。】支持軟件【如：a.操作系統名稱及版本號；b.開發工具名稱及版本號；c.數據庫管理系統名稱及版本號；d.其它必要的支持軟件。】.使用說明安裝和初始化【給出程序的存儲形式、操作命令、反饋信息及其含意、表明安裝完成的測試實例以及安裝所需的軟件工具等。】輸入【給出輸入數據或參數的要求】數據背景【說明數據來源、存儲媒體

14、、出現頻度、限制和質量管理等。】數據格式【如：a.長度；b.格式基準；c.標號；d.順序；e.分隔符；f.詞匯表；g.省略和重復；h.控制。】輸入舉例輸出【給出每項輸出數據的說明】數據背景【說明輸出數據的去向、使用頻度、存放媒體及質量管理等。】數據格式【詳細闡明每一輸出數據的格式，如：首部、主體和尾部的具體形式。】舉例出錯和恢復【給出：a.出錯信息及其含意；b.用戶應采取的措施，如修改、恢復、再啟動。】求助查詢【說明如何操作】.運行說明運行表【列出每種可能的運行情況，說明其運行目的。】運行步驟【按順序說明每種運行的步驟。】運行控制操作信息【包括：a.運行目的；b.操作要求；c.啟動方法；d.預

15、計運行時間；e.操作命令格式及說明；f.其它事項。】輸入/輸出文件【給出建立或更新文件的有關信息，如：a.文件的名稱及編號；b.記錄媒體；c.存留的目錄；d.文件的支配（說明確定保留文件或廢棄文件的準則，分發文件的對象，占用硬件的優先級及保密控制等。）】啟動或恢復過程.非常規過程【提供應急或非常規操作的必要信息及操作步驟，如出錯處理操作、向后備系統切換操作以及維護人員須知的操作和注意事項】.操作命令一覽表【按字母順序逐個列出全部操作命令的格式、功能及參數說明。】.程序文件（命令文件）和數據文件一覽表【按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標識符及說明】.用戶操作舉例七、測試計

16、劃.引言編寫目的【闡明編寫本測試計劃的目的。】項目背景【說明項目來源、委托單位、開發單位和主管部門。】定義【列出本文檔中用到的專門術語的定義和縮寫詞的原文。】參考資料【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：a.本項目經核準的計劃任務書、合同或上級機關的批文；b.項目開發計劃；c.需求分析說明書；d.概要設計說明書；e.詳細設計說明書；f.用戶操作手冊；g.本測試計劃中所引用的資料、標準和規范。】.任務概述目標運行環境需求概述條件與限制.計劃測試方案測試項目【列出組裝測試和確認測試中每一項測試的內容、名稱、目的和進度。】測試機構及人員【測試機構名稱、負責人和職責。

17、】.測試項目說明【按順序逐個對測試項目作出說明：】測試項目名稱就測試內容測試用例輸入【輸入的數據和輸入命令。】輸出【預期的輸出數據。】步驟及操作允許偏差【給出實測結果與預期結果之間允許偏差的范圍。】進度條件【給出本項測試對資源特殊要求，如設備、軟件、人員等。】測試資料【說明本項測試所需的資料。】.評價范圍【說明所完成的各項測試說明問題的范圍及其局限性。】準則【說明評價測試結果的準則。】八、測試分析報告.引言編寫目的【闡明編寫本報告的目的。】項目背景【說明項目來源、委托單位、開發單位和主管部門。】定義【列出本文檔中用到的專門術語的定義和縮寫詞的原文。】參考資料【列出有關資料的作者、標題、編號、發

18、表日期、出版單位或資料來源，可包括：a.本項目經核準的計劃任務書、合同或上級機關的批文；b.項目開發計劃；c.需求分析說明書；d.概要設計說明書；e.詳細設計說明書；f.用戶操作手冊；g.測試計劃；h.本報告中所引用的資料、標準和規范。】.測試計劃執行情況測試項目【列出每一測試項目的名稱、內容和目的。】測試機構和人員【給出測試機構名稱、負責人和參與測試人員名單。】測試結果【按順序給出每一測試項目目的：a.實測結果數據；b.與預期結果數據的偏差；c.該項測試表明的事實；d.該項測試發現的問題。】軟件需求測試結論【按順序給出每一需求測試的結論。包括：a.證實的軟件能力；b.局限性（即本項需求未到充

19、分測試的情況和原因）。】.評價軟件能力【經過測試所表明的軟件能力】缺陷和限制【說明測試所揭露的軟件缺陷和不足，以及可能給軟件運行帶來的影響。】建議【提出為彌補上述缺陷的建議。】測試結論【說明能否通過。】.測試項目說明【按順序逐個對測試項目作出說明：】九、開發進度月報.報告時間及所處的開發階段.工程進度本月內的主要活動實際進展與計劃比較.所用工時【按不同層次人員分別計時。】.所用機時【按所用計算機機型分別計時。】.工作中遇到的問題及采取的對策.本月完成的成果.下月的工作計劃.特殊問題十、項目開發總結報告.引言編寫目的【闡明編寫本報告的目的。】項目背景【說明項目來源、委托單位、開發單位和主管部門。

20、】定義【列出本文檔中用到的專門術語的定義和縮寫詞的原文。】參考資料【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，可包括：a.本項目經核準的計劃任務書、合同或上級機關的批文；b.項目開發計劃；c.需求分析說明書；d.概要設計說明書；e.詳細設計說明書；f.用戶操作手冊；g.測試計劃；h.測試分析報告；i.本報告中所引用的資料、標準和規范。】.開發結果產品【可包括：a.列出各部分的程序名稱、源程序行數（包括注釋行）或目標程序字節數及程序總計數量、存儲形式；b.產品文檔名稱等。】主要功能和性能所用工時【按人員的不同層次分別計時。】所用機時【按所用計算機機型分別計時。】進度【給出計劃

21、進度與實際進度的對比。】費用.評價生產率評價【如平均每人每月生產的源程序行數、文檔的字數等。】技術方案評價產品質量評價.經驗與教訓十一、程序設計說明書.引言編寫目的【闡明編寫本說明書的目的。】開發單位【說明項目的提出者、開發者、用戶和使用場所。】定義【列出本文檔中用到的專門術語的定義和縮寫詞的原文。】參考資料【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源，以及保密級別，可包括：a.用戶操作手冊；b.與本文檔有關的其它文檔。】.系統說明系統用途【說明系統具備的功能，輸入和輸出。】安全保密【說明系統安全保密方面的考慮。】總體說明【說明系統的總體功能，對系統、子系統和作業作出綜合性的

22、介紹，并用圖表的方式給出系統主要部分的內部關系。】程序說明【說明系統中每一程序、分程序的細節和特性。】程序1說明功能【說明程序的功能】方法【說明實現的方法】輸入【說明程序的輸入、媒體、運行數據記錄、運行開始時使用的輸入數據的類型和存放單元、與程序初始化有關的入口要求。】處理【處理特點和目的，如：a.用圖表說明程序的運行邏輯流程；b.程序主要轉移條件；c.對程序的約束條件；d.程序結束時的出口條件；e.與下一個程序的通信與聯結（運行、控制）；f.由該程序產生并提供處理程序段使用的輸出數據類型和存放單元；g.程序運行所用存儲量、類型及存儲位置等。】輸出【程序的輸出】接口【本程序與本系統其它部分的接

23、口】表格【說明程序內部的各種表、項的細節和特性。對每張表的說明至少包括：a.表的標識符；b.使用目的；c.使用此表的其它程序；d.邏輯劃分，如塊或部，不包括表項；e.表的基本結構；f.設計安排，包括表的控制信息。表目結構細節、使用中的特有性質及各表項的標識、位置、用途、類型、編碼表示。】特有的運行性質【說明在用戶操作手冊中沒有提到的運行性質。】2.4.2程序2說明【與程序1的說明相同。以后其它各程序的說明相同。】.操作環境設備【逐項說明系統的設備配置及其特性。】支持軟件【列出系統使用的支持軟件，包括它們的名稱和版本號。】數據庫【說明每個數據庫的性質和內容，包括安全考慮。】總體特征【如：a.標識

24、符；b.使用這些數據庫的程序；c.靜態數據；d.動態數據；e.數據庫的存儲媒體；f.程序使用數據庫的限制。】結構及詳細說明說明該數據庫的結構，包括其中的記錄和項。說明記錄的組成，包括首部或控制段、記錄體。說明每個記錄結構的字段，包括：標記或標號、字段的字符長度和位數、該字段的允許值范圍。擴充：說明為記錄追加字段的規定。.維護過程約定【列出該軟件系統設計中所使用的全部規則和約定，包括：a.程序、分程序、記錄、字段和存儲區的標識或標識助記符的使用規則；b.圖表的處理標準、卡片的連接順序、語句和記號中使用的縮寫、出現在圖表中的符號名；c.使用的軟件技術標準；d.標準化的數據元素及其特征。】驗證過程輸

25、入【說明一個程序段修改后，對其進行驗證的要求和過程（包括測試程序和數據）及程序周期性驗證的過程。】出錯及糾正方法【列出出錯狀態及其糾錯方法】專門維護過程【說明本文檔其它地方沒有提到的專門維護過程，如：a.維護該軟件系統的輸入輸出部分（如數據庫）的要求、過程和驗證方法；b.運行程序庫維護系統所必需的要求、過程和驗證方法；c.對閏年、世紀變更所需要的臨時性修改等。】專用維護程序【列出維護軟件系統使用的后備技術和專用程序（如文件恢復程序、淘汰過時文件的程序等）的目錄，并加以說明，內容包括：a.維護作業的輸入輸出要求；b.輸入的詳細過程及在硬設備上建立、運行并完成維護作業的操作步驟。】程序清單和流程圖

26、【引用資料或提供附錄給出程序清單和流程圖。】十二、軟件問題報告.登記號【為該報告規定一個唯一的、順序的編號。】.登記日期【登記該報告的日期。】.問題發現日期【發現該問題的日期和時間。】.活動【在哪個階段發現的問題，如單元測試、組裝測試、確認測試和運行維護過程。】.狀態【狀態表示有：a.正在復查“軟件問題報告”，以確定將采取什么行動；b.“軟件問題報告”已由指定的人進行處理；c.修改已完成，并經過測試,正準備交給主程序庫；d.主程序庫已經更新，主程序庫修改的重新測試尚未完成；e.作了重新測試，問題再現；f.作了重新測試，所作的修改無故障，“軟件問題報告”被關閉；g.留待以后關閉。】.報告人【填寫"軟件問題報告”人員的姓名、地址、電話。】.問題屬于什么方面【問題包括：程序問題、模塊問題、數據庫問題、文件的問題或是它們的某種組合。】.模塊/子系統【出現問題的模塊名。如果不知是哪個模塊，可標出子系統名，盡量給出細節。】.修訂