目錄
- 縮略語
- 檔案程序
- 檔案編制要求
- 軟體生存周期與各種檔案的編制
- 檔案編制中的考慮因素
- 檔案的讀者
- 重復性
- 靈活性
- 附錄:檔案鏈接
本標準原則上適用于所有型別的軟體產品的開發程序和管理程序,
使用者可根據實際情況對本標準進行適當剪裁(可剪裁所需的檔案型別,也可對規范的內容作適當裁剪),
軟體檔案從使用的角度大致可分為軟體的用戶需要的用戶檔案和開發方在開發程序中使用的內部檔案(開發檔案)兩類,供方應提供的檔案的型別和規模,由軟體的需方和供方在合同中規定,
縮略語
| 縮略 | 中文全稱 | 英文全稱 |
|---|---|---|
| CASE | 計算機輔助軟體工程 | Computer Assistant Software Engineering |
| COM | 計算機操作手冊 | Computer Operation Manual |
| CPM | 計算機編程手冊 | Computer Programming Manual |
| CSCI | 計算機軟體配置項 | Computer Software Configuration Item |
| DBDD | 資料庫(頂層)設計說明 | Database Design Description |
| DID | 資料條目說明 | Data Item Description |
| DPMR | 開發進度月報 | Development Plan Month Report |
| DRD | 資料需求說明 | Data requirement Description |
| FAR | 可行性分析報告 | Feasibility analysis Report |
| HWCI | 硬體配置項 | Hardware Configuration Item |
| IDD | 介面設計說明 | Interface Design Description |
| IRS | 介面(軟體)需求規格說明 | Interface Requirement Specification |
| IV&V | 獨立驗證和確認 | Independent verification and validation |
| OCD | 運行概念說明 | Operation Conception Description |
| PDSR | 專案開發總結報告 | Project Development summary Report |
| SCCB | 軟體配置控制委員會 | Software Configuration Control Board |
| SCM | 軟體配置管理 | Software Configuration Manager |
| SCMP | 軟體配置管理計劃 | Software Configuration Manager Plan |
| SDD | 軟體(結構)設計說明 | Software Design Description |
| SDF | 軟體開發檔案 | Software Development File |
| SFDD | 軟體開發檔案 | Software Development Document |
| SDL | 軟體開發庫 | Software Development Library |
| SDP | 軟體開發計劃 | Software Development Plan |
| SIP | 軟體安裝計劃 | Software Installation Plan |
| SPS | 軟體產品規格說明 | Software Product Specification |
| SQA | 軟體質量保證 | Software Quality Assure |
| SQAP | 軟體質量保證計劃 | Software Quality Assure Plan |
| SRS | 軟體需求規格說明 | Software Requirement Specification |
| SSDD | 系統/子系統設計(結構設計)說明 | System Subsystem Design Description |
| SSS | 系統/子系統需求規格說明 | System Subsystem Requirement Specification |
| STD | 軟體測驗說明 | Software Testing Descrition |
| STP | 軟體測驗計劃 | Software Testing Plan |
| STR | 軟體測驗報告 | Software Testing Report |
| STrP | 軟體移交計劃 | Software Transfer Plan |
| SUM | 軟體用戶手冊 | Software User Manual |
| SVD | 軟體版本說明 | Software Version Description |
| SW | 軟體 | Software |
檔案程序
有兩種主要型別的標準:
- 產品標準:它規定產品的特征和功能需求,
- 程序標準:它規定開發產品的程序,
應用程式和計算機軟體的復雜性日益增加,使得給使用計算機的用戶提供完整的、正確的和易懂的檔案的需要更加迫切,
檔案常常是關心在軟體已經實作后做些什么,然而,為了質量,軟體檔案編制應作為整個軟體生產程序的一部分,
檔案程序的活動應按下圖中的順序執行:

其中,有兩個陰影框,在一個陰影框中的所有活動應在下一個陰影框中的活動開始之前完成,在陰影框中的活動可以并行執行,虛線指示可能的重復,
檔案編制要求
軟體生存周期與各種檔案的編制
在軟體的生存周期中,一般地說,應該產生以下一些基本檔案:
- a)可行性分析(研究)報告
- b)軟體(或專案)開發計劃
- c)軟體需求規格說明
- d)介面需求規格說明
- e)系統/子系統設計(結構設計)說明
- f)軟體(結構)設計說明
- g)介面設計說明
- h)資料庫(頂層)設計說明
- i)(軟體)用戶手冊
- j)操作手冊
- k)測驗計劃
- 1)測驗報告
- m)軟體配置管理計劃
- n)軟體質量保證計劃
- o)開發進度月報
- p)專案開發總結報告
- q)軟體產品規格說明
- r)軟體版本說明等
對于使用檔案的人員而言,他們所關心的檔案的種類隨他們所承擔的作業而異:
| 管理人員 | 開發人員 | 維護人員 | 用 戶 |
|---|---|---|---|
| 可行性分析(研究)報告 專案開發計劃 軟體配置管理計劃 軟體質量保證計劃 開發進度月報 專案開發總結報告 |
可行性分析(研究)報告 專案開發計劃 軟體需求規格說明 介面需求規格說明 軟體(結構)設計說明 介面設計說明書 資料庫(頂層)設計說明 測驗計劃 測驗報告 |
軟體需求規格說明 介面需求規格說明 軟體(結構)設計說明 測驗報告 |
軟體產品規格說明 軟體版本說明 用戶手冊 操作手 |
這些檔案從使用的角度可分為用戶檔案和開發檔案兩大類,其中,用戶檔案必須交給用戶,用戶應該得到的檔案的種類和規模由供應者與用戶之間簽訂的合同規定,
如前所述,軟體,從出現一個構思之日起,經過軟體開發成功投入使用,直到最后決定停止使用并被另一項軟體代替之時止,被認為是該軟體的一個生存周期,一般地說這個軟體生存周期可以分成以下 6 個階段:
-
a)可行性與計劃研究階段
在可行性分析(研究)與計劃階段內,要確定該軟體的開發目標和總的要求,要進行可行性分析、投資——收益分析、制訂開發計劃,并完成可行性分析報告、開發計劃等檔案, -
b)需求分析階段
在需求分析階段內,由系統分析人員對被設計的系統進行系統分析,確定對該軟體的各項功能、性能需求和設計約束,確定對檔案編制的要求,作為本階段作業的結果,一般地說軟體需求規格說明(也稱為:軟體需求說明、軟體規格說明)、資料要求說明和初步的用戶手冊應該撰寫出來, -
c)設計階段
在設計階段內,系統設計人員和程式設計人員應該在反復理解軟體需求的基礎上,提出多個設計,分析每個設計能履行的功能并進行相互比較,最后確定一個設計,包括該軟體的結構、模塊(或 CSCI)的劃分、功能的分配,以及處理流程,
在被設計系統比較復雜的情況下,設計階段應分解成概要設計階段和詳細設計階段兩個步驟,在一般情況下,應完成的檔案包括:結構設計說明、詳細設計說明和測驗計劃初稿, -
d)實作階段
在實作階段內,要完成源程式的編碼、編譯(或匯編)和排錯除錯得到無語法錯的程式清單,要開始撰寫進度日報、周報和月報(是否要有日報或周報,取決于專案的重要性和規模),并且要完成用戶手冊、操作手冊等面向用戶的檔案的撰寫作業,還要完成測驗計劃的編制, -
e)測驗階段
在測驗階段,該程式將被全面地測驗,已編制的檔案將被檢查審閱,一般要完成測驗分析報告,作為開發作業的結束,所生產的程式、檔案以及開發作業本身將逐項被評價,最后寫出專案開發總結報告,
注:在整個開發程序中(即前五個階段中),開發集體要按月撰寫開發進度月報,
- f)運行與維護階段
在運行和維護階段,軟體將在運行使用中不斷地被維護,根據新提出的需求進行必要而且可能的擴充和刪改、更新和升級,
檔案編制中的考慮因素
檔案的讀者
每一種檔案都具有特定的讀者,這些讀者包括個人或小組、軟體開發單位的成員或社會上的公眾、從事軟體作業的技術人員、管理人員或領導干部,他們期待著使用這些檔案的內容來進行作業,例如設計、撰寫程式、測驗、使用、維護或進行計劃管理,因此這些檔案的作者必須了解自己的讀者,這些檔案的撰寫必須注意適應自己的特定讀者的水平、特點和要求,
重復性
本標準中列出的檔案編制規范的內容要求中,顯然存在某些重復,較明顯的重復有兩類,引言是每一種檔案都要包含的內容,以向讀者提供總的梗概,第二類明顯的重復是各種檔案中的說明部分,如對功能性能的說明;對輸入、輸出的描述;系統中包含的設備等,
這是為了方便每種檔案各自的讀者,每種檔案應該自成體系盡量避免讀一種檔案時又不得不去參考另一種檔案,當然,在每一種檔案里,有關引言、說明等同其他檔案相重復的部分,在行文上、在所用的術語上、在詳細的程度上,還是應該有一些差別以適應各種檔案的不同讀者的需要,
靈活性
鑒于軟體開發是具有創造性的腦力勞動,也鑒于不同軟體在規模上和復雜程度上差別極大,在檔案編制作業中允許一定的靈活性,這種靈活性如下所述,
-
a)應編制的檔案種類
一般情況下,一項軟體的開發程序中,應產生如上所述的各種檔案,然而針對一項具體的軟體開發專案,有時不必編制這么多的檔案,可以把幾種檔案合并成一種,
一般地說,當專案的規模、復雜性和失敗風險增大時,檔案編制的范圍,管理手續和詳細程度將隨之增加,反之,則可適當減少, -
b)檔案的詳細程度
從同一份提綱起草的檔案的篇幅大小往往不同,可以少到幾頁,也可以長達幾百頁,此詳細程度取決于任務的規模、復雜性和專案負責人對該軟體的開發程序及運行環境所需要的詳細程度的判斷, -
c)檔案的擴展
當被開發系統的規模非常大(例如原始碼超過一百萬行)時,一種檔案可以分成幾卷撰寫,可以按其中每一個系統分別編制,也可以按內容劃分成多卷,例如:
專案開發計劃可能包括:質量保證計劃,配置管理計劃,用戶培訓計劃,安裝實施計劃;
系統設計說明可分寫成:系統設計說明,子系統設計說明;
程式設計說明可分寫成:程式設計說明,介面設計說明,版本說明;
操作手冊可分寫成:操作手冊,安裝實施程序;
測驗計劃可分寫成:測驗計劃,測驗設計說明,測驗規程,測驗用例;
測驗分析報告可分寫成:綜合測驗報告,驗收測驗報告;
專案開發總結報告亦可分寫成專案開發總結報告和資源環境統計, -
d)章、條的擴張與縮并
在軟體檔案中,一般宜使用本標準提供的章、條標題,但所有的條都可以擴展,可以進一步細分,以適應實際需要,反之如果章條中的有些細節并非必需,也可以根據實際情況縮并,此時章條的編號應相應地變更, -
e)程式設計的表現形式
本標準對于程式的設計表現形式并未作出規定或限制,可以使用流程圖的形式,判定表的形式,也可以使用其他表現形式,如程式設計語言(PDL)、問題分析圖(PALb)等, -
f)檔案的表現形式
本標準對于檔案的表現形式亦未作出規定或限制,可以使用自然語言,也可以使用形式化語言,也可以使用各種圖、表, -
g)檔案的其他種類
當本標準中規定的檔案種類尚不能滿足某些應用部門的特殊需要時,他們可以建立一些特殊的檔案種類要求,例如軟體質量保證計劃、軟體配置管理計劃等,這些要求可以包含在本單位的檔案編制實施規定中,
附錄:檔案鏈接
GB8567-2006《計算機軟體檔案編制規范》 - 道客巴巴
附錄2 GB T-8567-2006計算機軟體檔案編制案例 - 道客巴巴
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/3038.html
標籤:其他
