計算機軟體編制規範

2022-09-11 10:03:06 字數 5433 閱讀 9850

《計算機軟體文件編寫指南》

一.計算機軟體文件由封面、目錄、正文、注釋和附錄組成。

封面格式:

密級:編號:

文件名稱

專案名稱

編制審核批准研究所 年月日

二.計算機軟體文件包括:

1)軟體開發計畫

2)軟體需求規格說明

3)介面需求規格說明

4)介面設計文件

5)軟體設計文件

6)軟體產品規格說明

7)版本說明文件

8)軟體測試計畫

9)軟體測試說明

10)軟體測試報告

11)計算機系統操作員手冊

12)軟體使用者手冊

13)軟體程式設計師手冊

14)計算機資源綜合保障檔案

軟體開發計畫

一.引言

1. 編寫目的(闡明編寫軟體計畫的目的,指出讀者物件。)

2. 專案背景(可包括:(1)專案委託單位、開發單位和主管部門;(2)該軟體系統與其他系統的關係。)

3. 定義(列出本文件中用到的專門術語的定義和縮略詞的原文。)

4. 參考資料(可包括:(1)專案經核准的計畫任務書、合同或上級機關的批文;(2)文件所引用的資料、規範等;列出資料的作者、標題、編號、發表日期、出版單位或資料**。)

二.專案概述

1. 工作內容(簡要說明專案的各項主要工作,介紹所開發軟體的功能效能等. 若不編寫可行性研究報告,則應在本節給出較詳細的介紹。)

2. 條件與限制(闡明為完成專案應具備的條件開發單位已具備的條件以及尚需創造的條件. 必要時還應說明使用者及分合同承包者承擔的工作完成期限及其它條件與限制。)

3. 產品

(1)程式(列出應交付的程式名稱使用的語言及儲存形式。)

(2)文件(列出應交付的文件。)

(3)執行環境(應包括硬體環境軟體環境。)

4.服務(闡明開發單位可向使用者提供的服務. 如人員培訓安裝保修維護和其他執行支援。)

5. 驗收標準

三.實施計畫

1. 任務分解(任務的劃分及各項任務的負責人。)

2. 進度(按階段完成的專案,用圖表說明開始時間完成時間。)

3. 預算

4. 關鍵問題(說明可能影響專案的關鍵問題,如裝置條件技術難點或其他風險因素,並說明對策。)

四. 人員組織及分工

五.交付期限

六.專題計畫要點(如測試計畫質量保證計畫配置管理計畫人員培訓計畫系統安裝計畫等。)

軟體需求規格說明

一. 引言

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. 故障處理

七. 其他需求(如可使用性、安全保密、可維護性、可移植性等。)

概要設計說明書

一. 引言

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. 出錯處理對策(如設定後備、效能降級、恢復及再啟動等。)

八. 安全保密設計

九. 維護設計(說明為方便維護工作的設施,如維護模組等。)

詳細設計說明書

一. 引言

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. 測試要點(給出測試模組的主要測試要求。)

使用者操作手冊

一. 引言

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) 啟動或恢復過程

六. 非常規過程(提**急或非常規操作的必要資訊及操作步驟,如出錯處理操作、向後備系統切換操作以及維護人員須知的操作和注意事項。)

七. 操作命令一覽表

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

八. 程式檔案(或命令檔案)和資料檔案一覽表(按檔名字母順序或按功能與模組分類順序逐個列出檔名稱、識別符號及說明。)

九. 使用者操作舉例

測試計畫

一、 引言

1. 編寫目的(闡明編寫測試計畫的目的,指明讀者物件。)

2. 專案背景(說明專案的**委託單位及主管部門。)

3. 定義(列出測試計畫中用到的專門術語定義和縮寫詞的原意。)

4. 參考資料(列出這些資料的作者、標題、編號、發表日期、出版單位或資料**,可包括:(1)專案的計畫任務書,合同或批文;(2)專案開發計畫;(3)需求規格說明書;(3)概要設計說明書;(4)詳細設計說明書;(5)使用者操作手冊; g本測試計畫中引用的其他資料採用的軟體開發標準或規範。)

一. 任務概述

1. 目標

2. 執行環境

3. 需求概述

4. 條件與限制

二. 計畫

1.測試方案(說明確定測試方法和選取測試用例的原則。)

01計算機軟體測試檔案編制規範

1 目的 本規範規定一組軟體測試檔案。測試是軟體生存週期中乙個獨立的 關鍵的階段,也是保證軟體質量的重要手段。為了提高檢測出錯誤的機率,使軟體能有計畫地 有條不紊地進行,就必須要編制測試軟體。而標準化的測試檔案就如同一種通用的參照體系,可達到便於交流的目的。檔案中所規定的內容可以作為對測試過程的每個...

計算機軟體

一 填空與選擇 1 c語言從源程式的書寫到上機執行輸出結果要經過四個步驟。2 c語言的表示式與語句的區別在於 3 c語句有 沒有 輸入 輸出語句。4 結構化程式的編寫有三種程式結構。5 表示式10 3 9 2的值是 6 設有 intx 2,y 說明,則逗號表示式 y x 5,x y 的值是 7 設有...

計算機軟體知識

計算機基礎知識 認識電腦 計算機基礎知識 電腦是怎麼工作的 計算機基礎知識 鍵盤與指法 cpu如何工作?把cpu比喻成電腦的 大腦 一點都不為過,它不但要負責接收外界輸入的資訊資料,而且還要負責處理這些資料,然後將處理過的結果傳送到正確的裝置上。幾乎所有大大小小的工作,都需要由cpu來下達命令,傳達...