基本介紹
- 書名：軟體開發與測試文檔編寫指南
- 作者：劉文紅、董銳、張衛祥、馬賢穎、陳青
- 出版社：清華大學出版社
- ISBN：9787302518181
內容簡介,圖書目錄,
內容簡介
本書是軟體開發與測試叢書中的一冊，是一本指導軟體開發與測試文檔編寫的實用指南。全書以大型軟體開發常用開發過程為例，參考相關標準規範要求，系統地介紹了軟體需求文檔、軟體設計文檔、軟體測試文檔、軟體使用性文檔和軟體項目管理文檔五大類20種具體文檔的編寫要求，給出了文檔內容模板和部分文檔內容的具體示例，並總結了常見的文檔編寫問題。
圖書目錄
第1章軟體開發和測試文檔要求3
1.1軟體開發過程概述3
1.2相關術語5
1.3軟體開發文檔要求5
1.3.1文檔的作用5
1.3.2軟體文檔標準6
1.3.3軟體文檔的種類6
1.4軟體文檔裁剪指南8
1.4.1軟體規模等級9
1.4.2軟體關鍵等級9
1.4.3文檔的裁剪10
第二篇軟體需求文檔
第2章系統規格說明15
2.1系統規格說明的編寫要求15
2.2系統規格說明的內容16
2.3系統規格說明編寫示例20
2.3.1系統概述20
2.3.2系統功能21
2.3.3系統外部接口需求22
2.3.4安全性需求22
2.3.5操作需求22
2.4系統規格說明的常見問題23
第3章軟體研製任務書24
3.1軟體研製任務書的編寫要求24
3.2軟體研製任務書的內容25
3.3軟體研製任務書編寫示例26
3.3.1軟體概述27
3.3.2總體開發要求28
3.3.3功能要求28
3.3.4性能要求28
3.3.5接口關係29
3.3.6運行環境30
3.3.7支持環境31
3.3.8設計約束31
3.3.9管理要求31
3.3.10驗收與交付32
3.3.11維護33
3.4軟體研製任務書的常見問題33
第4章軟體需求規格說明35
4.1軟體需求規格說明的編寫要求35
4.2軟體需求規格說明的內容36
4.2.1軟體需求規格說明（結構化方法）36
4.2.2軟體需求規格說明（面向對象方法）40
4.3軟體需求規格說明編寫示例42
4.3.1外部接口需求43
4.3.2功能需求說明44
4.3.3性能需求說明46
4.3.4設計約束47
4.3.5運行環境要求47
4.3.6合格性需求47
4.3.7交付需求48
4.3.8維護保障需求48
4.4軟體需求規格說明的常見問題49
第5章接口需求規格說明51
5.1接口需求規格說明的編寫要求51
5.2接口需求規格說明的內容51
5.3接口需求規格說明編寫示例53
5.3.1接口示意圖53
5.3.2接口需求55
5.4接口需求規格說明的常見問題57第三篇軟體設計文檔
第6章系統設計說明61
6.1系統設計說明的編寫要求61
6.2系統設計說明的內容62
6.3系統設計說明示例63
6.3.1系統設計63
6.3.2CSCI標識65
6.3.3接口關係66
6.3.4軟體配置項關鍵與規模等級劃分66
6.4系統設計說明的常見問題67
第7章軟體接口設計說明68
7.1軟體接口設計說明的編寫要求68
7.2軟體接口設計說明的內容69
7.3軟體接口設計說明示例70
7.3.1接口示意圖70
7.3.2數據元素72
7.3.3訊息描述73
7.3.4通信協定74
7.4軟體接口設計說明的常見問題74
第8章資料庫設計說明75
8.1資料庫設計說明的編寫要求75
8.2資料庫設計說明的內容76
8.3資料庫設計說明示例78
8.3.1資料庫概要設計78
8.3.2資料庫詳細設計80
8.3.3資料庫訪問和操作軟體單元設計82
8.4資料庫設計說明的常見問題84
第9章軟體概要設計說明85
9.1軟體概要設計說明的編寫要求85
9.2軟體概要設計說明的內容87
9.3結構化設計方法概要設計說明示例92
9.3.1CSCI結構設計92
9.3.2CSCI接口設計92
9.3.3記憶體和處理時間分配94
9.3.4CSCI設計說明94
9.3.5CSCI數據98
9.3.6CSCI數據檔案99
9.4面向對象設計方法概要設計說明示例100
9.4.1邏輯視圖100
9.4.2進程視圖101
9.4.3實現視圖103
9.4.4部署視圖104
9.5軟體概要設計說明的常見問題104
第10章軟體詳細設計說明106
10.1軟體詳細設計說明的編寫要求106
10.2軟體詳細設計說明的內容107
10.3結構化方法詳細設計說明示例110
10.4面向對象方法詳細設計說明示例112
10.5軟體詳細設計說明的常見問題116
第四篇軟體測試文檔
第11軟體測試計畫123
11.1軟體測試計畫的編寫要求124
11.2軟體測試計畫的內容125
11.2.1軟體測試計畫模板125
11.2.2軟體測評大綱模板129
11.3軟體測試計畫編寫示例131
11.3.1被測軟體概述131
11.3.2測試總體要求的描述133
11.3.3測試項及測試方法134
11.3.4測試環境142
11.3.5測試結束條件144
11.3.6軟體質量評價方法與內容144
11.3.7測試通過準則147
11.4軟體測試計畫的常見問題147
第12章軟體測試說明150
12.1軟體測試說明的編寫要求150
12.2軟體測試說明的內容152
12.3軟體測試說明編寫示例154
12.3.1文檔審查154
12.3.2代碼審查155
12.3.3靜態分析163
12.3.4邏輯測試165
12.3.5功能測試166
12.3.6性能及餘量測試168
12.3.7接口測試170
12.3.8強度測試172
12.3.9安全性測試174
12.3.10恢復性測試177
12.3.11邊界測試178
12.3.12互操作性測試179
12.3.13安裝性測試181
12.4軟體測試說明的常見問題183
第13章軟體測試報告185
13.1軟體測試報告編寫要求186
13.2軟體測試報告內容186
13.3軟體測試報告示例191
13.3.1測試過程概述191
13.3.2未執行測試用例情況說明192
13.3.3測試有效性、充分性說明193
13.3.4評價結論193
13.3.5改進建議196
13.3.6軟體問題報告197
13.4軟體測試報告常見問題198
第14章軟體回歸測試方案200
14.1軟體回歸測試方案的編寫要求201
14.2軟體回歸測試方案的內容203
14.3軟體回歸測試方案編寫示例206
14.3.1文檔概述206
14.3.2回歸測試策略206
14.3.3軟體更動影響域分析207
14.4軟體回歸測試方案的常見問題208
第五篇軟體使用文檔
第15章軟體產品規格說明211
15.1軟體產品規格說明的編寫要求211
15.2軟體產品規格說明的內容211
15.3軟體產品規格說明編寫示例213
15.3.1可執行軟體213
15.3.2源檔案214
15.3.3“已建成”軟體設計217
15.3.4計算機硬體資源使用218
15.4軟體產品規格說明的常見問題218
第16章軟體版本說明220
16.1軟體版本說明的編寫要求220
16.2軟體版本說明的內容220
16.3軟體版本說明編寫示例222
16.3.1發布的材料清單222
16.3.2軟體內容清單222
16.3.3更改說明223
16.3.4適應性數據224
16.3.5有關的文檔224
16.3.6安裝說明224
16.3.7可能的問題和已知的錯誤224
16.4軟體版本說明的常見問題225
第17章軟體用戶手冊226
17.1軟體用戶手冊的編寫要求226
17.2軟體用戶手冊的內容227
17.3軟體用戶手冊編寫示例229
17.3.1安裝和設定229
17.3.2處理規程230
17.3.3錯誤、故障和緊急情況下的恢復233
17.4軟體用戶手冊的常見問題234
第六篇軟體項目管理文檔
第18章軟體開發計畫243
18.1軟體開發計畫編寫要求244
18.2軟體開發計畫內容244
18.3軟體開發計畫示例247
18.3.1環境資源247
18.3.2軟體開發模型249
18.3.3軟體開發標準251
18.3.4項目估計252
18.3.5進度計畫255
18.3.6關鍵依賴關係258
18.3.7風險管理259
18.3.8利益相關方管理259
18.3.9知識和技能獲取計畫260
18.3.10數據管理計畫261
18.3.11需求管理計畫263
18.3.12項目監控計畫265
18.3.13用戶交付要求266
18.4軟體開發計畫常見問題267
第19章軟體配置管理計畫268
19.1軟體配置管理計畫編寫要求269
19.2軟體配置管理計畫內容270
19.3軟體配置管理計畫示例272
19.3.1基線劃分與配置標識272
19.3.2配置控制276
19.3.3配置狀態報告277
19.3.4配置審核279
19.4軟體配置管理計畫常見問題280
第20章軟體質量保證計畫281
20.1軟體質量保證計畫的編寫要求282
20.2軟體質量保證計畫的內容283
20.3軟體質量保證計畫編寫示例285
20.3.1與其他文檔的關係285
20.3.2組織與人員285
20.3.3資源286
20.3.4審核依據287
20.3.5過程評價活動287
20.3.6產品評價活動288
20.3.7質量保證進度290
20.3.8過程檢查準則292
20.3.9產品檢查準則292
20.4軟體質量保證計畫的常見問題293
第21章軟體研製總結報告295
21.1軟體研製總結報告的編寫要求296
21.2軟體研製總結報告的內容297
21.2.1軟體研製總結報告模板297
21.2.2軟體階段/里程碑總結報告模板301
21.3軟體研製總結報告編寫示例303
21.3.1設計原則和指導思想303
21.3.2軟體開發工作綜述303
21.3.3軟體管理工作綜述306
21.4軟體研製總結報告的常見問題311
參考文獻313
