計算機軟體所包含的檔案有2類,一類是開發過程中填寫的各種圖表,稱之為工作**;另一類是應編制的技術資料或技術管理資料,稱為文件。
在一項計算機軟體的開發過程中,一般地說,應該產生14種檔案:
- 可行性研究報告
- 專案開發計畫
- 軟體需求說明書
- 資料要求說明書
- 概要設計說明書
- 詳細設計說明書
- 資料庫設計說明書
- 使用者手冊
- 操作手冊
- 模組開發卷宗
- 測試計畫
- 測試分析報告
- 開發進度月報
- 專案開發總結報告
乙個計算機軟體,從出現構思,經過開發成功並投入使用,到停止使用,完成乙個生存週期。這個週期可以分為6個階段:
- 可行性與計畫研究階段
- 需求分析階段
- 設計階段
- 實現階段
- 測試階段
- 執行與維護階段
當被開發的系統的規模非常大時,例如工作量超過30人月時,編寫的文件應該按照以下的方法分類,以包含更加詳細的內容。
檔案編制工作必須有管理工作的配合,才能使所編制的檔案真正發揮作用。檔案編制工作是一項貫穿整個軟體開發過程的工作。因此對檔案的管理必須貫徹整個開發過程。
在開發中必須進行的管理工作有:
檔案的形成是各個階段開發工作正式完成的標誌,因此,開發集體必須及時地對這些檔案進行嚴格的評審。
開發人員在軟體開發過程中,必須
- 按照規定,及時完成各種產品檔案的編寫工作;
- 將開發過程中做出的決定和取得的修改及時寫入檔案;
檔案中必須有編寫者、評審者、批准者的簽字,必須有編寫、評審完成的日期和批准日期。
為了便於檔案的儲存、查詢、使用和修改,應該對檔案按照層次加以分類組織。可以按照如下6個層次對檔案加以分類和標識。
a 檔案編號
b 檔案所屬專案標識
c 檔案種類標識
d 每一種檔案的不同版本號
e 頁號
f 保密級別
在軟體開發過程中,隨著程式的逐步形成和逐步修改,各種檔案不斷產生、修改和補充。因此,必須加以周密的控制,以保證檔案與程式產品的一致性,保證檔案之間的一致性和安全性。這種控制表現為:
(i). 對於一項軟體開發工作,應設定一位專職的檔案管理人員(可以由專案管理工程師擔當,也可以由專門的文件管理員擔當)。在開發集體中,應該集體保管本專案現有全部檔案的主文字2套,由該檔案管理人員負責保管。
(ii). 每乙份提交給檔案管理人員的檔案都必須有編寫者、審核者和批准者的簽字。
(iii). 這兩套主文字的內容必須完全一致;其中一套是可以出借的,另一套是絕對不可以出借的,以免發生萬一。可出借的主文字在出借時必須辦理出借手續,歸還時辦理登出出借手續。
(iv). 開發集體中的工作人員可以根據工作的需要,在本專案的開發過程中持有一些檔案,即所謂個人檔案,包括為使他完成他承擔的任務所需要的檔案,以及他在完成任務過程中所編制的檔案;但這種個人檔案必須是主文字的複製品,必須同住文字完全一致,若需修改,必須首先修改主文字。
(v). 不同開發人員所擁有的個人檔案通常是主文字的各種子集。所謂子集是霸主文字的各個部分根據所承擔不同任務的人員的工作需要加以複製、組裝而成的若干個檔案的集合。
檔案管理人員應列出乙份不同子集的分發物件的清單,按照清單及時把檔案分發給有關的人員或部門。
(vi). 乙份檔案如果已被另乙份新的檔案所代替,則原檔案應該被登出。檔案管理人員應該隨時整理主文字,及時反映出檔案的變化和增加情況,及時分發檔案。
(vii). 當乙個專案的開發工作臨近結束時,檔案管理人員應該逐個收回開發集體內每個成員的個人檔案,並檢查這些個人檔案的內容。如果發現這些個人檔案比主文字更加詳細,或不同於主文字,檔案管理人員應監督有關人員進行修改,使主文字能真正反映出實際的開發結果。
在開發過程中,開發集體內的任何成員對檔案的修改都應該遵守以下規程:
(i). 提議開發集體中的任何乙個成員都可以向專案負責人提出修改建議,為此應該填寫乙份修改建議表,說明修改的內容、所修改的檔案和部位、以及修改理由。
(ii). 評議有專案負責人或專案負責人指定的人對該修改建議進行評議,包括審核該修改的必要性,確定這一修改的影響範圍,研究進行修改的方法、步驟和實施計畫。
(iii). 審核由專案負責人進行審核,包括核實修改的目的和要求,核實修改或定將帶來的影響,審核修改或定是否可行。
(iv). 批准又開發單位的部門負責人對修改計畫進行批准。批准時,主要是決斷修改工作的各項活動的先後順序及各自的完成日期,以保證整個開發工作按照原定計畫日期完成。
(v). 實施由專案負責人按照已經批准了的修改活動計畫,安排各項修改活動的負責人員進行修改,建立修改記錄,產生新的檔案以取代原有檔案,做後把檔案交檔案管理人員歸檔,並分發給有關的持有者。
01技術協議書編制規範
f 對產品 引用實際外包的物資名稱 的使用壽命 重量偏差 平衡等特殊要求 g 產品 引用實際外包的物資名稱 的試裝配 試車 跑合 試壓 水 油 氣 及其它要求 h 對產品 引用實際外包的物資名稱 的塗裝要求 含防鏽 油漆 包裝 i 對產品 引用實際外包的物資名稱 的交貨狀態要求 列 作為附件 j 其...
01計算機軟體測試檔案編制規範
1 目的 本規範規定一組軟體測試檔案。測試是軟體生存週期中乙個獨立的 關鍵的階段,也是保證軟體質量的重要手段。為了提高檢測出錯誤的機率,使軟體能有計畫地 有條不紊地進行,就必須要編制測試軟體。而標準化的測試檔案就如同一種通用的參照體系,可達到便於交流的目的。檔案中所規定的內容可以作為對測試過程的每個...
第01章編制說明
一 編制依據 本 施工組織設計 的編制嚴格按照以下檔案的規定執行 1.金域豪庭 1 1 2 樓工程的建築 結構和水電等專業施工圖及業主對工程所作的各項要求。2.國家現行建築安裝工程施工及驗收規範及質量檢驗評定標準 招標檔案中所要求的相關標準。3.廣東省和深圳市有關施工規定 規程及政策檔案。4.根據工...