詳細設計說明書評測規範

2021-05-22 12:47:50 字數 1775 閱讀 2819

詳細設計說明書的評測規範可歸納如下:

填表說明:y—是,tbd—不確定,n—否,na—不適用 編

號 評測

項 評測結果

y/tbd/n/na

清晰性

1所有單元或過程的目的都已文件化 2

包括了資料流、控制流和介面的單元設計是否已清晰的說明

完整性

3是否已定義和初始化所有的變數、指標和常量 4

是否已描述單元的全部功能 5

是否已詳細說明用來實現該單元的關鍵演算法(例如:用自然語言或pdl) 6

是否已列出該單元的呼叫

依從性

7該文件是否遵守了公司規定的文件編寫標準 8

是否採用了所要求的方法和工具來進行單元設計

一致性

9資料元素的命名和使用在整個單元和單元介面之間是否一致 10

所有介面的設計是否相互一致並且和更高階別文件一致

正確性

11是否處理所有條件(>0、=0、

<0、switch/case),是否存在處理「case not found」的條件 12

是否正確的規定了分支(邏輯沒有顛倒)

資料使用

13是否所有宣告的資料都被實際使用到 14

是否所有該單元的資料結構都被詳細說明 15

是否所有修改共享資料(或檔案)的程式都考慮到了其他程式對該共享資料(或檔案)的訪問許可權 16

是否所有邏輯單元、時間標誌和同步標誌都被定義和初始化

介面

17介面引數在數量、型別和順序上是否匹配 18

是否所有的輸入和輸出都被正確定義和檢查 19

是否傳遞引數序列都被清楚的描述 20

是否所有引數和控制標誌由已描述的單元傳遞或返回 21

是否詳細說明了引數的度量單位、取值範圍、正確度和精度 22

共享資料區域及其訪問規定的對映是否一致

可維護性

23單元是否具有高內聚度和低耦合度(例如:對該單元的更改不會在該單元有任何無法預料的影響並對其他單元的影響很小

效能

24是否該單元的所有約束(例如:過程時間和規模)都被詳細說明

可靠性

25初始化是否使用到預設值,預設值是否正確 26

是否在記憶體訪問的時候執行了邊界檢查(例如:陣列、資料結構、指標等)來確保只是改變了目標儲存位置 27

是否執行輸入、輸出、介面和結果的檢查 28

是否對所有錯誤情況都發出有意義的資訊 29

對特殊情況返回的**是否和已規定的全域性定義的返回**相匹配 30

是否考慮到意外事件

易測性

31是否能夠對每個單元進行測試、演示、分析或檢查來說明它們是滿足需求的 32

該設計是否包含檢查點來幫助測試(例如:有條件的編譯**和資料宣告測試) 33

是否所有的邏輯都能被測試 34

是否已描述測試程式、測試資料集和測試結果

可追溯性

35是否設計的每一部分都能追溯到其他專案文件的要求,也能追溯到更高階別文件的要求 36

是否所有的設計決定都能追溯到權衡考慮 37

單元需求是否都能上溯到更好級別的文件,更改級別文件的需求是否已經在單元中體現

詳細設計說明書

詳細設計說明書 1 引言 1.1 編寫目的 闡明編寫詳細設計說明書的目的,指明讀者物件。1.2 專案背景 應包括專案的 和主管部門等。1.3 定義 列出本文件中所用到的專門術語的定義和縮寫詞的願意。1.4 參考資料 列出有關資料的作者 標題 編號 發表日期 出版單位或資料 專案經核准的計畫任務書 合...

詳細設計說明書

1 引言 1.1 編寫目的 說明編寫這份詳細設計說明書的目的,指出預期的讀者。1.2 背景 說明 a 待開發軟體系統的名稱 b 本專案的任務提出者 開發者 使用者和執行該程式系統的計算中心。1.3 定義 列出本檔案中用到專門術語的定義和外文首字母組詞的原片語。1.4 參考資料 列出有關的參考資料,如...

詳細設計說明書

1 引言 1 1編寫目的 說明編寫這份詳細設計說明書的目的,指出預期的讀者。1 2背景 說明 a 待開發軟體系統的名稱 b 本專案的任務提出者 開發者 使用者和執行該程式系統的計算中心。1 3定義 列出本檔案中用到專門術語的定義和外文首字母組詞的原片語。1 4參考資料 a 本專案的經核准的計畫任務書...