軟件文檔質量評價方法研究

陳琪 葛志松 許駿龍

摘要：隨著軟件開發工程化的發展，人們已經注意到開發文檔是軟件產品的重要組成部分，軟件文檔質量的好壞直接影響到軟件的開發、使用和維護。在相關軟件測試標準中，已將文檔審查列為一種正式的測試類型，但是相較于傳統的測試類型，文檔測評還沒有形成較為系統、形式化的方法。基于此，該文提出一種適用于軟件文檔質量評價的綜合方法。

關鍵詞：軟件文檔；質量評價；評價模型

中圖分類號：TP311 文獻標識碼：A 文章編號：1009-3044（2018）30-0060-02

1 概述

文檔測評范圍應根據上級要求、測評任務書、合同或其他等效文件綜合確定，一般包括被測軟件需求規格說明、設計說明、用戶手冊等。文檔測試與程序測試有很大不同，文檔是不可運行的。經過長期試驗，筆者認為比較有效的文檔測試方法主要分為兩類：審查，參照編寫依據閱讀文檔，與同一系列或相關軟件文檔產品相對比；驗證，文檔與程序運行情況相比對。

在實際工作中，文檔審查工作經常在軟件測試之前實施，基于人力資源有限，文檔驗證通常由測試人員在測試工作中同步實施，發現的問題通常會歸類到軟件問題。在該文中文檔質量評價適用于文檔審查方法。

2 文檔質量模型

在GJB5236-2004《軟件質量度量》中適用于文檔質量度量是“易用性”和“可維護性”2個質量特性中的部分子特性，但這2個質量特性的評價對象還包括可執行程序，且“易用性”以最終用戶為評價者，增大了評價實施的復雜度，因此必須建立適合文檔特點的質量度量模型。

在該文中，參考GJB5236-2004《軍用軟件質量度量》的質量度量框架將文檔質量歸納為4個質量特性：完整性、一致性、準確性和規范性；結合最新的文檔評估國際標準[1][2]、GJB438-88《軍用軟件文檔編制規范》[3]、GJB438A-97《武器軟件開發文檔》[4]等工程化標準，將質量特性進一步細分為若干個度量，規定了度量準則，形成了一個文檔質量度量模型。

2.1 完整性度量

完整性度量指文檔產品為指定的軟件和功能提供完整說明的能力。

2.1.1 一致性度量

一致性度量指文檔內部和文檔之間說明的一致性能力。

2.1.2 正確性度量

2.1.3 規范性度量

3 文檔質量評價模型

文檔質量評價模型由文檔質量要素評價、單個文檔質量評價和文檔質量綜合評價3級評價體系結構組成，如圖1所示。 圖中實線表示組成關系，虛線箭頭表示評價過程。

文檔審查是基于評審組的測評方式，并依據通過認可的文檔審查單對文檔進行審查和打分。在此基礎上依據文檔問題和專家打分情況對文檔質量進行評價。

3.1 文檔質量要素評價

文檔質量要素評價，是指對組成文檔質量的各項要素進行評價。質量要素基于度量元，結合文檔類型、文檔所依據的國家及軍用標準要求及測試要求確定。質量要素確定后，需根據質量要素要求分類制定詳細的文檔審查內容，形成審查單，審查單需通過評審確認。

文檔質量要素評價完成后，需根據文檔質量要素所屬的度量元評價結果計算每個度量元的度量結果。

3.2 單個文檔質量評價

依據每個度量元的結果計算所屬質量特性的結果。

3.3 文檔綜合質量評價

根據單個文檔質量評價結果，計算軟件文檔質量的綜合質量結果。

3.4 計算公式

對文檔質量進行評價時，每一級都需考慮其下級各質量因素的權重，因此通用的文檔質量評價結果計算公式如下：

3.5 權值計算方法

AHP是一種被廣泛應用的決策方法，適用于建立了層次機構的評價模型，它可以更好地對專家經驗進行處理，使得權重值的確定結果更加合理。但該方法依賴于數據的長期積累，且實施時計算量較大，因此，該方法適用于數據積累到一定程度且時間比較充裕的評價過程。該文中主要選用AHP中的判斷矩陣構造和權重向量求解方法。

參考文獻：

[1] ISO-IEC， ISO-IEC_26513_（E）. Software and systems engineering — Requirements for assessors and testers of user documentation[Z]. ISO-IEC， 2007.

[2] ISO-IEC， ISO/IEC25051. Software engineering – Software product Quality Requirements and Evaluation （SQuaRE） – Requirements for quality of Commercial Off-The-Self （COTS） software product and instructions for testing[Z]. ISO-IEC， 2006.

[3] 總裝備部， GJB 438-88. 軍用軟件文檔編制規范[Z]. 北京： 總裝備部， 1988.

[4] 總裝備部， GJB 438A-97. 武器軟件開發文檔[Z]. 北京： 總裝備部， 1997.

【通聯編輯：謝媛媛】