|
共同規範 1 名詞解釋與縮寫符號:描述在各文件中所使用到的特殊名詞、縮寫符號 與簡稱。定義用字需解釋清楚、縮寫符號則需說明全文及其意義,並以 英文字母順序表列。 2 參考文件資料:參考資料項目為一般國際標準文件所必需,記載並說明 各文件中所參考引用之文獻及範例,軟體專案之文件,組織及作業手冊 之編號、標題、改訂版、與日期,及其他相關的文件等。
第一章:軟體需求規格 1 文件目的: 本文件為軟體專案開發中,本府對交付之「軟體需求規格書」 提供的基本規範。目的在提供一可茲參考依循的軟體需求分析 作業程序,以利進行需求訂定作業並提昇分析品質,並可作為 使用者、軟體需求分析人員、專案管理人員之間溝通的橋樑, 亦是後續品保人員檢驗之依據。 2 工作說明: 廠商應交付「軟體需求規格書」文件,其中應包含下列大綱及 內容,特說明如下: 2.1 前言:請描述本系統目標、名稱、應用範圍及系統概述。 2.2 系統環境:請描述本系統硬體環境與網路架構、軟體環境與 資料庫配置等。 2.3 功能規格:採用物件導向分析作為主要的系統塑模的方法, 並使用UML 2.0 做為塑模語言。在 UML 中,任何一個角度 對系統所做的抽象定義,都可能需要幾種模型圖來描述,而 這些來自不同角度的模型圖最終組合成整個系統。而在本需 求書中最低要求使用:使用案例圖(Use Case Diagram)、 循序圖(Sequence Diagram)、活動圖(Activity Diagram )等圖形技術來描述及獲取需求。 2.4 對性能的要求:主要描述系統軟體的非功能性需求,如可靠 性、資料正確性、安全需求、操作需求等。 2.5 產品交付及確認。 2.6 相關文件:請提供「使用者需求訪談記錄」相關表單、與事 務流程圖等。另外,廠商須簽具「廠商保密與責任切結書」 。
第二章:軟體設計規格 1 文件目的: 在提供一可茲參考依循的設計作業程序,以加速進行設計作業 並提昇其品質,主要目的是作為進行軟體設計工作相關人員之 參考、作為執行軟體設計作業之依據、評估軟體設計產品品質 之指南,以及軟體分析人員、軟體設計人員、程式設計人員、 測試人員、品保人員與專案管理人員間之溝通橋樑、作為軟體 設計技術之基礎,累積設計經驗,進而提昇設計技術及增進設 計成果品質。 2 工作說明: 2.1 設計方法與工具:說明系統分析與設計將採用的方法。 2.2 系統流程圖:請依設計方法與工具提供相關系統流程圖。 2.3 軟體組織架構:請依設計方法與工具提供軟體組織架構。 2.4 軟體元件或模組設計:請依設計方法與工具提供軟體元件或 模組設計相關資料,須說明元件或模組的輸入、輸出、處理 程序、存取相關資料說明。 2.5 使用者介面設計:說明使用者各項介面的特徵。 2.6 資料結構設計(無可免填):系統使用的特殊演算法說明。 2.7 資料庫設計:說明本系統所使用的資料庫,需提供本系統所 使用的資料庫結構與資料庫關聯。 2.8 例外處理(無可免填):透過文字、程式碼及流程圖說明在 軟體程式中所採用的例外處理設計。 2.9 軟體整合說明:說明本系統與其他系統的整合;需提供本系 統與其他系統之間相關的整合機制與相關的介面呼叫說明。 2.10 備份與回復機制說明:提供本系統程式與資料庫的備份與 回復機制規劃。 2.11 安全機制說明:請說明軟體的安全機制相關設計;如防止 資料隱碼攻擊機制設計。
第三章:軟體程式設計 1 文件目的: 本文件為軟體專案開發中,縣府對於交付之軟體程式提供規範 ,詳實地記錄建置階段程式設計的實作方式,以進一步確保系 統之正確性及安全性,並提供縣府後續進行程式碼審查(Cod- e Review)時之重要參考資料、以及系統維護擴充之重要依據 。 2 工作說明: 「軟體程式設計書」文件中應詳實描述所有軟體程式之資訊, 其包含子項目及其項目說明如下: 2.1 使用語言:述明撰寫程式所使用之程式語言。 2.2 開發工具及其版本:述明開發時所使用之工具及其版本。 2.3 類別或程式編號:述明該程式之程式編號,類別或程式編號 為識別程式之用,不得重複。 2.4 類別或程式名稱:述明該程式之程式名稱,類別或程式名稱 為識別程式之用,於相同儲存位置中的名稱不得重複;不同 儲存位置中的名稱應避免重複。 2.5 副程式或操作名稱(methods) :若該程式內有可供其它程 式呼叫之副程式或操作,則述明副程式或操作之名稱;無則 免填。 2.6 副程式或操作編號:若該程式內有可供其它程式呼叫之副程 式或操作,則述明副程式或操作之編號;無則免填。 2.7 功能描述:述明該程式或操作之功能性描述。 2.8 輸入(參數)值:述明執行該程式時所需之輸入參數及其說 明;無則免填。 2.9 輸出(傳回)值:述明執行該程式後所產生之結果;無則免 填。 2.10 資料來源:執行該程式時,若有需要額外之資料源或需要 由資料庫中擷取資料,則應於此述明;無則免填。 2.11 資料去處:執行該程式或操作時,若需要將資料儲存到外 部儲存體或資料庫中,則應於此述明;無則免填。 2.12 呼叫程序:述明該程式於執行時所需呼叫之副程式或操作 ;無則免填。 2.13 演算法:述明該程式之詳細處理邏輯,可使用虛擬碼(P- seudo Code)、決策表、決策樹、IPO 圖、N-S 圖或程式 流程圖予以表示。 2.14 程式碼(含光碟):述明該程式之程式碼,程式碼中應使 用註解(Comment)說明程式功能,並將程式碼以光碟媒 體儲存交付。
第四章:軟體測試報告 1 文件目的: 本文件主要目的是做為程式碼審查(Code Review) 、需求審 查(Requirement Review)、設計審查(Design Review)、 測試案例審查(Test Case Review)等品質稽核各階段中,程 式碼測試審查之依據。 2 工作說明: 2.1 軟體測試概述:軟體測試計畫之工作內容,本規範將其分為 單元測試及整合測試兩部份來含括,相關流程請參考「軟體 測試報告」參考範本。 2.1.1 安全性要求測試: 2.1.1.1 輸入過濾及檢查:對於任何輸入功能,除對於輸入錯誤 之基本檢查外,都需要通過免於資料隱碼(SQL Injec- tion)攻擊的檢測。 2.1.1.2 若以機關真實資料作為測試之資料時,應要求取得該測 試資料之測試人員進行必要之保密措施。 2.1.2 相容性要求測試:需要測試系統所有畫面及操作其結果或 有列印需求時,須能同時在 Internet Explorer 6(含以 上)、Netscape 7(含以上)、Firefox 1.0 (含以上) 等瀏覽器上均能正常運作。 2.1.3 負載及壓力測試:測試程式物件功能承擔不同的工作量, 以評測和評估物件在不同工作量條件下的性能行為,以及 持續正常運作的能力。本測試目的在確保系統超出最大預 期工作量的情況下仍能正常運作或出現警示。 2.2 問題追蹤系統:廠商對於測試過程中所發現的程式問題或缺 失,必須要有問題處理流程或問題管理系統加以記錄及處理 ,且廠商須保證此問題處理程序是有效的被執行。 2.3 問題追蹤及處理流程必須做成紀錄。 2.4 軟體測試計畫書:廠商需提出軟體測試計畫書,其內容必須 列出進行測試的項目、產品功能的測試、所需進行的測試工 作、每位測試人員所應負責的測試項目,軟體測試計畫書內 容請參考「軟體測試報告」參考文件。 2.5 系統測試報告:針對審核通過之軟體測試計畫書進行系統測 試作業,其結果須做成系統測試報告。 2.6 系統驗收測試:針對審核通過發行之軟體版本,進行驗收測 試,以作為軟體系統交付之準備。
第五章:軟體維護使用手冊 1 文件目的: 在提供管理員、超級使用員及一般使用員能快速查閱系統之各 項功能,期引導上述使用者儘速熟悉系統操作方式,此文件為 縣府後續維護管理系統之重要文件。 2 工作說明: 2.1 文件大綱:「軟體維護使用手冊」文件應包含整個操作及維 護手冊的大綱及各章節所包含的內容描述,應包含項目說明 如下: 2.1.1 系統建置目的及預期目標。 2.1.2 系統功能摘要。 2.2 軟硬體環境需求:描述此系統發展環境所需的軟硬需求及該 設備的特性、處理速度、記憶體的容量、系統軟體使用規則 、備份與復原處理、系統安全管理及應注意事項。應包含項 目說明如下: 2.2.1 硬體需求。 2.2.2 作業系統及軟體需求。 2.2.3 系統軟硬體架構圖。 2.2.4 Client 端所需環境說明。 2.3 安裝指南:系統軟硬體建置應有 Step bye Step 的順序, 應包含項目說明如下: 2.3.1 安裝步驟 2.3.1.1 說明軟體安裝於硬體設備時的每一個步驟及先後順序。 2.3.2 安裝之注意事項。 2.4 操作手冊:主要供下列三個等級之使用者能快速查閱本系統 之各項功能,包含項目說明如下: 2.4.1 管理員 2.4.1.1 系統維運與管理。 2.4.1.2 資料備份。 2.4.1.3 歷史資料處理。 2.4.1.4 軟體相關工具說明。 2.4.2 超級使用員。 2.4.2.1 系統設定 2.4.3 一般使用員。
第六章:系統導入計畫 1 文件目的: 本文件主要目的係提供系統導入計劃之基本規範,將系統導入 的各個步驟及預計時程清楚的條列出來,俾使系統順利上線運 作。 2.工作說明: 2.1 系統目的:說明系統目的及實施的範圍,以供系統上線時檢 驗是否達成。 2.2 導入策略概述:說明系統導入的方式,現行作業與新作業運 作,全面性的導入或漸進式的導入之策略及理由。 2.3 時程規劃:列出各項規劃時程、流程、及查核點。 2.4 人員編組及分工: 2.4.1 列出執行計畫的人員及分工。 2.4.2 列出相關人員配合導入時程所需執行之工作項目。 2.5 系統導入問題處理流程:對於導入過程中所發現的問題或缺 失,需有問題處理的機制。 2.6 應變措施:說明對於導入過程中所發現的重大問題或臨時狀 況所採取的應變措施,以避免造成業務中斷。
第七章:系統組態管理 1 文件目的:本文件主要目的是提供專案人員執行組態管理可依 循之作業依據,以降低資訊環境變更對於業務造成的影響,亦 就是確保所有組態項目之間的整體一致性,隨時提供給每一位 專案成員及使用者系統最新的狀況。 2 工作說明: 組態管理文件應分四階段交付:軟體發展過程、驗收、維護, 以及在軟體建置過程中問題修改或需求變更的修訂過程。其中 應包括下列組態項目資訊,說明如下:(請參考「系統組態管 理」參考範本) 2.1 軟體建置基本資訊:詳列說明填寫日期、建置機關或單位、 案號及契約號、建置廠商名稱、標的名稱及數量摘要、採購 金額、決標日期、履約期限、完成履約日期、保固截止日、 履約地點、開始驗收日期、驗收完畢/驗收合格日期、履約 逾期總天數、不計違約金天數、應計違約金天數、逾期違約 金、其他違約金、契約金額、增減價款、驗收扣款(不包括 逾期違約金及其他違約金)、結算總價。 2.2 軟體組態(Server/Client)必須登錄之資訊:詳列說明組 態檔數量、組態檔檔名、組態檔格式說明(文字檔或特殊檔 案格式)、組態檔儲存之環境及路徑、組態檔操作說明、組 態檔備份機制說明、組態檔回存機制及詳細復原步驟說明。 2.3 軟體運作環境組態(Server/Client)必須登錄之資訊:詳 列說明所用作業系統、Service Pack版次、資料庫、其他需 搭配之應用軟體、系統(含資料庫及其他需搭配之應用軟體 )備份機制說明、系統(含資料庫及其他需搭配之應用軟體 )回存機制及詳細復原步驟說明。
本規範自發布日實施。
|