軟體專案開發的編寫標準化

2022-07-06 18:27:01 字數 3652 閱讀 2612

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

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

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

◇ 軟體需求說明書(軟體規格說明書):對所開發軟體的功能、效能、使用者介面及執行環境等作出詳細的說明。它是在使用者與開發人員雙方對軟體需求取得共同理解並達成協議的條件下編寫的,也是實施開發工作的基礎。

該說明書應給出資料邏輯和資料採集的各項要求,為生成和維護系統資料檔案做好準備。

◇ 概要設計說明書:該說明書是概要實際階段的工作成果,它應說明功能分配、模組劃分、程式的總體結構、輸入輸出以及介面設計、執行設計、資料結構設計和出錯處理設計等,為詳細設計提供基礎。

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

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

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

◇ 測試分析報告:測試工作完成以後,應提交測試計畫執**況的說明,對測試結果加以分析,並提出測試的結論意見。

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

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

◇ 軟體維護手冊:主要包括軟體系統說明、程式模組說明、操作環境、支援軟體的說明、維護過程的說明,便於軟體的維護。

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

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

專案開發計畫

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.1 總體結構和模組外部設計

3.2 功能分配:表明各項功能與程式結構的關係。

4 介面設計

4.1 外部介面:包括使用者介面、軟體介面與硬體介面。

4.2 內部介面:模組之間的介面。

5 資料結構設計

6 邏輯結構設計

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

7 物理結構設計

8 資料結構與程式的關係

9 執行設計

9.1 執行模組的組合

9.2 執行控制

9.3 執行時間

10 出錯處理設計

10.1 出錯輸出資訊

10.2 出錯處理對策:如設定後備、效能降級、恢復及再啟動等。

11 安全保密設計

12 維護設計

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

安全標準化評審報告編寫

湖北省企業安全生產標準化 評審報告 申請企業 評審單位 評審等級 評審行業及專業 評審日期 年月日至年月日 湖北省安全生產監督管理局制 評審單位資質 企業安全生產標準化評審備案表 1 概述 企業簡介 包括企業性質 地理位置和交通 主要產品 主要生產工藝流程 主要原材料 生產能力和規模 生產方式和主要...

軟體工程標準化

實驗報告樣式 電腦科學與技術學院 實驗報告 實驗課程 軟體工程 實驗名稱 軟體工程標準化文件 學號 2009082104 姓名 班級 計算機09 1班 完成日期 2012年03月14日 一 實驗目的 1 熟悉和掌握軟體工程標準化的概念 內容及其意義。2 了解那些支援國家標準和其他相關資訊的專業 3 ...

標準化講師手冊開發

講師手冊,顧名思義是為講師服務的標準化的授課指導手冊,是講師理解 掌握 傳承課程的關鍵資料,它包括授課的時間分配 邏輯與步驟 方法及輔助資料等內容。講師要根據手冊要求對課程進行標準化的呈現,保證課程內容的準確性,教學活動的有效性以及課程傳承的一致性。講師手冊的組成部分 明確了標準化講師手冊對企業標準...