paulwong

          軟件工程文檔編寫標準包括哪些內容

          在項目開發過程中,應該按要求編寫好十三種文檔,文檔編制要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性。


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


            ◇ 項目開發計劃:為軟件項目實施方案制訂出具體計劃,應該包括各部分工作的負責人員、開發的進度、開發經費的預算、所需的硬件及軟件資源等。


           


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


           


            ◇
          概要設計說明書:該說明書是概要實際階段的工作成果,它應說明功能分配、模塊劃分、程序的總體結構、輸入輸出以及接口設計、運行設計、數據結構設計和出錯處理設計等,為詳細設計提供基礎。


           


            ◇ 詳細設計說明書:著重描述每一模塊是怎樣實現的,包括實現算法、邏輯流程等。


           


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


           


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


           


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


           


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


           


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


           


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


           


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


           


            ◇ 軟件修改報告:軟件產品投入運行以后,發現了需對其進行修正、更改等問題,應將存在的問題、修改的考慮以及修改的影響作出詳細的描述,提交審批。


           


           


           


           


           


           


          項目開發計劃


          1 引言


          1.1 編寫目的:闡明編寫可行性研究報告的目的,提出讀者對象


           


          1.2 項目背景:應包括


            ● 項目的委托單位、開發單位和主管部門;


            ● 該軟件系統與其他系統的關系。


           


          1.3 定義:列出文檔中用到的專門術語的定義和縮寫詞的原文


           


          1.4 參考資料:可包括:


            ● 項目經核準的計劃任務書、合同或上級機關的批文


            ● 文檔所引用的資料、規范等


            ● 列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源;


           


          2 項目概述


          2.1 工作內容:簡要說明項目的各項主要工作,介紹所開發軟件的功能、性能等;若不編寫可行性研究報告;則應在本節給出較詳細的介紹;


           


          2.2 條件與限制:
          闡明為完成項目應具備的條件、開發單位已具備的條件以及尚需創造的條件。必要時還應說明用戶及分合同承擔的工作、完成期限及其他條件與限制。


           


          2.3 產品


           


          2.3.1程序:列出應交付的程序名稱、使用的語言及存儲形式。


           


          2.3.2文檔:列出應交付的文檔。


           


          2.4 運行環境:應包括硬件環境、軟件環境。


           


          2.5 服務:闡明開發單位可向用戶提供的服務。如人員培訓、安裝、保修、維護和其他運行支持。


           


          2.6 驗收標準


           


          3 實施計劃


          3.1 任務分解:任務的劃分及各項任務的負責人。


           


          3.2 進度:按階段完成的項目,用圖表說明開始時間、完成時間。


           


          3.3 預算


           


          3.4 關鍵問題:說明可能影響項目的關鍵問題,如設備條件、技術難點或其他風險因素,并說明對策。


           


          4 人員組織及分工


          5 交付期限


          6 專題計劃要點


            如測試計劃、質量保證計劃、配置管理計劃、人員培訓計劃、系統安裝計劃等。


           


           


           


           


           


           


          軟件需求說明書


          1 引言


          1.1 編寫目的:闡明編寫需求說明書的目的,指明讀者對象。


           


          1.2 項目背景:應包括


            ● 項目的委托單位、開心單位和主管部門;


            ● 該軟件系統與其他系統的關系。


           


          1.3 定義:列出文檔中所用到的專門術語的定義和縮寫詞的愿文。


           


          1.4 參考資料:可包括


            ● 項目經核準的計劃任務書、合同或上級機關的批文


            ● 文檔所引用的資料、規范等


            ● 列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源


           


          2 任務概述


          2.1 目標


           


          2.2 運行環境


           


          2.3 條件與限制


           


          3 數據描述


          3.1 表態數據


           


          3.2 動態數據:包括輸入數據和輸出數據。


           


          3.3 數據庫描述:給出使用數據庫的名稱和類型。


           


          3.4 數據詞典


           


          3.5 數據采集


           


          4 功能需求


          4.1功能劃分


           


          4.2功能描述


           


          5 性能需求


          5.1 數據精確度


           


          5.2 時間特性:如響應時間、更新處理時間、數據轉換與傳輸時間、運行時間等。


           


          5.3 適應性:在操作方式、運行環境、與其他軟件的接口以及開發計劃等發生變化時,應具有的適應能力。


           


          6 運行需求


          6.1 用戶界面:如屏幕格式、報表格式、菜單格式、輸入輸出時間等。


           


          6.2 硬件接口


           


          6.3 軟件接口


           


          6.4 故障處理


           


          7 其他需求


            如可使用性、安全保密、可維護性、可移植性等。


           


           


           


           


           


           


          概要設計說明書


          1 引言


          1.1 寫目的:闡明編寫概要設計說明書的目的,指明讀者對象。


           


          1.2 項目背景:應包括


            ● 項目的委托單位、開發單位和主管部門


            ● 該軟件系統與其他系統的關系。


           


          1.3 定義:列出本文檔中所用到的專門術語的定義和縮寫詞的愿意。


           


          1.4 參考資料:


            ● 列出這些資料的作者、標題、編號、發表日期、出版單位或資料來源


            ●項目經核準的計劃任務書、合同或上級機關的批文;項目開發計劃;需求規格說明書;測試計劃(初稿);用戶操作手冊


            ● 文檔所引用的資料、采用的標準或規范。


           


          2 任務概述


          2.1 目標


           


          2.2 需求概述


           


          2.3 條件與限制


           


          3 總體設計


          3.2 總體結構和模塊外部設計


           


          3.3 功能分配:表明各項功能與程序結構的關系。


           


          4 接口設計


          4.1 外部接口:包括用戶界面、軟件接口與硬件接口。


           


          4.2 內部接口:模塊之間的接口。


           


          5 數據結構設計


          6 邏輯結構設計


            所有文檔的統一封面格式如下頁所示。


           


          7 物理結構設計


          8 數據結構與程序的關系


          9 運行設計


          9.1 運行模塊的組合


           


          9.2 運行控制


           


          9.3 運行時間


           


          10 出錯處理設計


          10.1 出錯輸出信息


           


          10.2 出錯處理對策:如設置后備、性能降級、恢復及再啟動等。


           


          11 安全保密設計


          12 維護設計


            說明為方便維護工作的設施,如維護模塊等。


           


           


           


           


           


           


          詳細設計說明書


          1 引言


          1.1 編寫目的:闡明編寫詳細設計說明書的目的,指明讀者對象。


           


          1.2 項目背景:應包括項目的來源和主管部門等。


           


          1.3 定義:列出本文檔中所用到的專門術語的定義和縮寫詞的愿意。


           


          1.4 參考資料:


            ● 列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源


            ●項目經核準的計劃任務書、合同或上級機關的批文;項目開發計劃;需求規格說明書;概要設計說明書;測試計劃(初稿);用戶操作手冊


            ● 文檔所引用的資料、軟件開發的標準或規范。


           


          2 總體設計


          2.1 需求概述


           


          2.2 軟件結構:如給出軟件系統的結構圖。


           


          3 程序描述


          3.1 逐個模塊給出以下說明:


            ● 功能


            ● 性能


            ● 輸入項目


            ● 輸出項目


           


          3.2 算法:模塊所選用的算法。


           


          3.3 程序邏輯:詳細描述模塊實現的算法,可采用:標準流程圖;PDL語言;N-S圖;判定表等描述算法的圖表。


           


          3.4 接口


            ● 存儲分配


            ● 限制條件


           


          3.5測試要點:給出測試模塊的主要測試要求。


           


           


           


           


           


           


          用戶操作手冊


          1 引言


          1.1 編寫目的:闡明編寫手冊的目的,指明讀者對象。


           


          1.2 項目背景:說明項目的來源、委托單位、開發單位及和主管部門。


           


          1.3 定義:列出手冊中使用的專門術語的定義和縮寫詞的愿意。


           


          1.4 參考資料:


            ● 列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源


            ● 項目經核準的計劃任務書、合同或上級機關的批文;項目開發計劃;需求規格說明書;概要設計說明書;詳細設計說明書;測試計劃


            ● 文檔中所引用的其他資料、采用的軟件工程標準或軟件工程規范。


           


          2 軟件概述


          2.1 目標


           


          2.2 功能


           


          2.3 性能


           


          2.4 數據精確度:包括輸入、輸出及處理數據的精度。


           


          2.5 時間特性:如響應時間、處理時間、數據傳輸時間等。


           


          2.6 靈活性:在操作方式、運行環境需做某些變更時軟件的適應能力。


           


          3 運行環境


          3.1 硬件


            ● 列出軟件系統運行時所需的硬件最小配置,如計算機型號、主存容量


            ● 外存儲器、媒體、記錄格式、設備型號及數量


            ● 輸入、輸出設備


            ● 數據傳輸設備及數據轉換設備的型號及數量。


           


          3.2 支持軟件


            ● 操作系統名稱及版本號


            ● 語言編譯系統或匯編系統的名稱及版本號


            ● 數據庫管理系統的名稱及版本號


            ● 其他必要的支持軟件


           


          4 使用說明


          4.1 安裝和初始化:給出程序的存儲形式、操作命令、反饋信息及其做含意、表明安裝完成的測試實例以及安裝所需的軟件工具等。


           


          4.2 輸入:給出輸入數據或參數的要求。


            ● 數據背景:說明數據來源、存儲媒體、出現頻度、限制和質量管理等。


            ● 數據格式:如長度、格式基準、標號、順序、分隔符、詞匯表、省略和重復、控制。


            ● 輸入舉例。


           


          4.3 輸出:給出每項輸出數據的說明。


            ● 數據背景:說明輸出數據的去向、使用頻度、存放媒體及質量管理等。


            ● 數據格式:詳細闡明每一輸出數據的格式,如首部、主體和尾部的具體形式。


            ● 舉例


           


          4.4 出錯和恢復:給出出錯信息及其含意;用戶應采取的措施,如修改、恢復、再啟動。


           


          4.5 查詢:說明如何操作。


           


          5 運行說明


          5.1 運行表:列出每種可能的運行情況,說明其運行目的。


           


          5.2 運行步驟:按順序說明每和運行的步驟,應包括:


           


          5.3 運行控制


           


          5.4 操作信息:運行目的、運行目的、操作要求、啟動方法、預計運行時間、操作命令格式及說明、其他事項;


           


          5.5輸入/輸出文件:給出建立或更新文件的有關信息,如:文件的名稱及編號;記錄媒體;存留的目錄;文件的支配:說明確定保留文件或廢棄文件的準則,分發文件的對象,戰勝硬件的優先級及保密控制等。


           


          5.6 啟動或恢復過程


           


          6 非常規過程


            提供應急戒非常規操作的必要信息及操作步驟,如出錯處理操作、向后備系統切換操作及維護人員須知的操作和注意事項。


           


          7 操作命令一覽表


            按字母順序逐個列出全部操作命令的格式、功能及參數說明。


           


          8 程序文件(或命令文件)和數據文件一覽表


            按文件名字母順序或按功能與模塊分類順序逐個列出文件名稱、標識符及說明。


           


          9 用戶操作舉例


           


           


           


           


           


          測試計劃


          1 引言


          1.1 編寫目的:闡明編寫測試計劃的目的并指明讀者對象。


           


          1.2 項目背景:說明項目的來源、委托單位及主管部門。


           


          1.3 定義:列出測試計劃中所用到的專門術語的定義和縮寫詞的原意。


           


          1.4參考資料:列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源,可包括:項目的計劃任務書、合同或批文;項目開發計劃;需求規格說明書;概要設計說明書;詳細設計說明書;用戶操作手冊;本測試計劃中引用的其他資料、采用


          的軟件開發標準或規范。


           


          2 任務概述


          2.1 目標


           


          2.2 運行環境


           


          2.3 需求概述


           


          2.4 條件與限制


           


          3 計劃


          3.1 測試方案:說明測試方法和選取測試用例的原則。


           


          3.2 測試項目:列出組裝測試和確認測試中每一項測試的內容、名稱、目的和進度。


           


          3.3 測試準備


           


          3.4 測試機構及人員:測試機構名稱、負責人和職責。


           


          4 測試項目說明


          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 準則:說明評論測試結果的準則。


           


           


           


           


           


           


          測試分析報告


          1 引言


          1.1 編寫目的:闡明編寫測試分析報告的目的并指明讀者對象。


           


          1.2 項目背景:說明項目的來源、委托單位及主管部門。


           


          1.3定義:列出測試分析報告中所用到的專門術語的定義和縮寫詞的原意。


           


          1.4參考資料:列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源,可包括:項目的計劃任務書、合同或批文;項目開發計劃;需求規格說明書;概要設計說明書;詳細設計說明書;用戶操作手冊;測試計劃;測試分析報告所引用的其他資料、采用的軟件工程標準或工程規范。


           


          2 測試計劃招待情況


          2.1 機構和人員:給出測試機構名稱、負責人和參與測試人員名單。


           


          2.2 測試結果:按順序給出每一測試項目的:實測結果數據;與預期結果數據的偏差;該項測試表明的事實;該項測試發現的問題。


           


          3 軟件需求測試結論


            按順序給出每一項需求測試的結論。包括:證實的軟件能力;局限性(即項需求未得到充分測試的情況及原因。


           


          4 評價


          4.1 軟件能力:經過測試所表明的軟件能力。


           


          4.2 缺陷和限制:說明測試所揭露的軟件缺陷和不足,以及可能給軟件運行帶來的影響。


           


          4.3 建議:提出為彌補上述缺陷的建議。


           


          4.4 測試結論:說明能否通過。


           


           


           


          開發進度月報


          1 報告時間及所處的開發階段


          2 工程進度


          2.1 本月內的主要活動


           


          2.2 實際進展與計劃比較


           


          3 所用工時


            按不同層次人員分別計時。

          posted on 2012-08-22 21:27 paulwong 閱讀(453) 評論(0)  編輯  收藏 所屬分類: Project Management

          主站蜘蛛池模板: 灵山县| 信丰县| 商城县| 济南市| 宁海县| 迁西县| 宁河县| 米林县| 井研县| 潼关县| 河源市| 扎赉特旗| 屯昌县| 新竹市| 斗六市| 凉城县| 武隆县| 香港| 平陆县| 闻喜县| 安龙县| 册亨县| 濮阳市| 当雄县| 萨迦县| 北安市| 海原县| 平和县| 襄垣县| 三亚市| 西藏| 昭通市| 始兴县| 友谊县| 子长县| 凤城市| 承德县| 昭通市| 安平县| 汶上县| 靖边县|