軟件開發(fā)與測試文檔編寫指南

目錄


第1章軟件開發(fā)和測試文檔要求3
1.1軟件開發(fā)過程概述3
1.2相關(guān)術(shù)語5
1.3軟件開發(fā)文檔要求5
1.3.1文檔的作用5
1.3.2軟件文檔標(biāo)準(zhǔn)6
1.3.3軟件文檔的種類6
1.4軟件文檔裁剪指南8
1.4.1軟件規(guī)模等級9
1.4.2軟件關(guān)鍵等級9
1.4.3文檔的裁剪10

第二篇軟件需求文檔
第2章系統(tǒng)規(guī)格說明15
2.1系統(tǒng)規(guī)格說明的編寫要求15
2.2系統(tǒng)規(guī)格說明的內(nèi)容16
2.3系統(tǒng)規(guī)格說明編寫示例20
2.3.1系統(tǒng)概述20
2.3.2系統(tǒng)功能21
2.3.3系統(tǒng)外部接口需求22
2.3.4安全性需求22
2.3.5操作需求22
2.4系統(tǒng)規(guī)格說明的常見問題23

第3章軟件研制任務(wù)書24
3.1軟件研制任務(wù)書的編寫要求24
3.2軟件研制任務(wù)書的內(nèi)容25
3.3軟件研制任務(wù)書編寫示例26
3.3.1軟件概述27
3.3.2總體開發(fā)要求28
3.3.3功能要求28
3.3.4性能要求28
3.3.5接口關(guān)系29
3.3.6運行環(huán)境30
3.3.7支持環(huán)境31
3.3.8設(shè)計約束31
3.3.9管理要求31
3.3.10驗收與交付32
3.3.11維護(hù)33
3.4軟件研制任務(wù)書的常見問題33

第4章軟件需求規(guī)格說明35
4.1軟件需求規(guī)格說明的編寫要求35
4.2軟件需求規(guī)格說明的內(nèi)容36
4.2.1軟件需求規(guī)格說明（結(jié)構(gòu)化方法）36
4.2.2軟件需求規(guī)格說明（面向?qū)ο蠓椒ǎ?0
4.3軟件需求規(guī)格說明編寫示例42
4.3.1外部接口需求43
4.3.2功能需求說明44
4.3.3性能需求說明46
4.3.4設(shè)計約束47
4.3.5運行環(huán)境要求47
4.3.6合格性需求47
4.3.7交付需求48
4.3.8維護(hù)保障需求48
4.4軟件需求規(guī)格說明的常見問題49

第5章接口需求規(guī)格說明51
5.1接口需求規(guī)格說明的編寫要求51
5.2接口需求規(guī)格說明的內(nèi)容51
5.3接口需求規(guī)格說明編寫示例53
5.3.1接口示意圖53
5.3.2接口需求55
5.4接口需求規(guī)格說明的常見問題57第三篇軟件設(shè)計文檔
第6章系統(tǒng)設(shè)計說明61
6.1系統(tǒng)設(shè)計說明的編寫要求61
6.2系統(tǒng)設(shè)計說明的內(nèi)容62
6.3系統(tǒng)設(shè)計說明示例63
6.3.1系統(tǒng)設(shè)計63
6.3.2CSCI標(biāo)識65
6.3.3接口關(guān)系66
6.3.4軟件配置項關(guān)鍵與規(guī)模等級劃分66
6.4系統(tǒng)設(shè)計說明的常見問題67

第7章軟件接口設(shè)計說明68
7.1軟件接口設(shè)計說明的編寫要求68
7.2軟件接口設(shè)計說明的內(nèi)容69
7.3軟件接口設(shè)計說明示例70
7.3.1接口示意圖70
7.3.2數(shù)據(jù)元素72
7.3.3消息描述73
7.3.4通信協(xié)議74
7.4軟件接口設(shè)計說明的常見問題74

第8章數(shù)據(jù)庫設(shè)計說明75
8.1數(shù)據(jù)庫設(shè)計說明的編寫要求75
8.2數(shù)據(jù)庫設(shè)計說明的內(nèi)容76
8.3數(shù)據(jù)庫設(shè)計說明示例78
8.3.1數(shù)據(jù)庫概要設(shè)計78
8.3.2數(shù)據(jù)庫詳細(xì)設(shè)計80
8.3.3數(shù)據(jù)庫訪問和操作軟件單元設(shè)計82
8.4數(shù)據(jù)庫設(shè)計說明的常見問題84

第9章軟件概要設(shè)計說明85
9.1軟件概要設(shè)計說明的編寫要求85
9.2軟件概要設(shè)計說明的內(nèi)容87
9.3結(jié)構(gòu)化設(shè)計方法概要設(shè)計說明示例92
9.3.1CSCI結(jié)構(gòu)設(shè)計92
9.3.2CSCI接口設(shè)計92
9.3.3內(nèi)存和處理時間分配94
9.3.4CSCI設(shè)計說明94
9.3.5CSCI數(shù)據(jù)98
9.3.6CSCI數(shù)據(jù)文件99
9.4面向?qū)ο笤O(shè)計方法概要設(shè)計說明示例100
9.4.1邏輯視圖100
9.4.2進(jìn)程視圖101
9.4.3實現(xiàn)視圖103
9.4.4部署視圖104
9.5軟件概要設(shè)計說明的常見問題104

第10章軟件詳細(xì)設(shè)計說明106
10.1軟件詳細(xì)設(shè)計說明的編寫要求106
10.2軟件詳細(xì)設(shè)計說明的內(nèi)容107
10.3結(jié)構(gòu)化方法詳細(xì)設(shè)計說明示例110
10.4面向?qū)ο蠓椒ㄔ敿?xì)設(shè)計說明示例112
10.5軟件詳細(xì)設(shè)計說明的常見問題116
第四篇軟件測試文檔
第11軟件測試計劃123
11.1軟件測試計劃的編寫要求124
11.2軟件測試計劃的內(nèi)容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測試環(huán)境142
11.3.5測試結(jié)束條件144
11.3.6軟件質(zhì)量評價方法與內(nèi)容144
11.3.7測試通過準(zhǔn)則147
11.4軟件測試計劃的常見問題147

第12章軟件測試說明150
12.1軟件測試說明的編寫要求150
12.2軟件測試說明的內(nèi)容152
12.3軟件測試說明編寫示例154
12.3.1文檔審查154
12.3.2代碼審查155
12.3.3靜態(tài)分析163
12.3.4邏輯測試165
12.3.5功能測試166
12.3.6性能及余量測試168
12.3.7接口測試170
12.3.8強(qiáng)度測試172
12.3.9安全性測試174
12.3.10恢復(fù)性測試177
12.3.11邊界測試178
12.3.12互操作性測試179
12.3.13安裝性測試181
12.4軟件測試說明的常見問題183

第13章軟件測試報告185
13.1軟件測試報告編寫要求186
13.2軟件測試報告內(nèi)容186
13.3軟件測試報告示例191
13.3.1測試過程概述191
13.3.2未執(zhí)行測試用例情況說明192
13.3.3測試有效性、充分性說明193
13.3.4評價結(jié)論193
13.3.5改進(jìn)建議196
13.3.6軟件問題報告197
13.4軟件測試報告常見問題198

第14章軟件回歸測試方案200
14.1軟件回歸測試方案的編寫要求201
14.2軟件回歸測試方案的內(nèi)容203
14.3軟件回歸測試方案編寫示例206
14.3.1文檔概述206
14.3.2回歸測試策略206
14.3.3軟件更動影響域分析207
14.4軟件回歸測試方案的常見問題208
第五篇軟件使用文檔
第15章軟件產(chǎn)品規(guī)格說明211
15.1軟件產(chǎn)品規(guī)格說明的編寫要求211
15.2軟件產(chǎn)品規(guī)格說明的內(nèi)容211
15.3軟件產(chǎn)品規(guī)格說明編寫示例213
15.3.1可執(zhí)行軟件213
15.3.2源文件214
15.3.3“已建成”軟件設(shè)計217
15.3.4計算機(jī)硬件資源使用218
15.4軟件產(chǎn)品規(guī)格說明的常見問題218

第16章軟件版本說明220
16.1軟件版本說明的編寫要求220
16.2軟件版本說明的內(nèi)容220
16.3軟件版本說明編寫示例222
16.3.1發(fā)布的材料清單222
16.3.2軟件內(nèi)容清單222
16.3.3更改說明223
16.3.4適應(yīng)性數(shù)據(jù)224
16.3.5有關(guān)的文檔224
16.3.6安裝說明224
16.3.7可能的問題和已知的錯誤224
16.4軟件版本說明的常見問題225

第17章軟件用戶手冊226
17.1軟件用戶手冊的編寫要求226
17.2軟件用戶手冊的內(nèi)容227
17.3軟件用戶手冊編寫示例229
17.3.1安裝和設(shè)置229
17.3.2處理規(guī)程230
17.3.3錯誤、故障和緊急情況下的恢復(fù)233
17.4軟件用戶手冊的常見問題234
第六篇軟件項目管理文檔
第18章軟件開發(fā)計劃243
18.1軟件開發(fā)計劃編寫要求244
18.2軟件開發(fā)計劃內(nèi)容244
18.3軟件開發(fā)計劃示例247
18.3.1環(huán)境資源247
18.3.2軟件開發(fā)模型249
18.3.3軟件開發(fā)標(biāo)準(zhǔn)251
18.3.4項目估計252
18.3.5進(jìn)度計劃255
18.3.6關(guān)鍵依賴關(guān)系258
18.3.7風(fēng)險管理259
18.3.8利益相關(guān)方管理259
18.3.9知識和技能獲取計劃260
18.3.10數(shù)據(jù)管理計劃261
18.3.11需求管理計劃263
18.3.12項目監(jiān)控計劃265
18.3.13用戶交付要求266
18.4軟件開發(fā)計劃常見問題267

第19章軟件配置管理計劃268
19.1軟件配置管理計劃編寫要求269
19.2軟件配置管理計劃內(nèi)容270
19.3軟件配置管理計劃示例272
19.3.1基線劃分與配置標(biāo)識272
19.3.2配置控制276
19.3.3配置狀態(tài)報告277
19.3.4配置審核279
19.4軟件配置管理計劃常見問題280

第20章軟件質(zhì)量保證計劃281
20.1軟件質(zhì)量保證計劃的編寫要求282
20.2軟件質(zhì)量保證計劃的內(nèi)容283
20.3軟件質(zhì)量保證計劃編寫示例285
20.3.1與其他文檔的關(guān)系285
20.3.2組織與人員285
20.3.3資源286
20.3.4審核依據(jù)287
20.3.5過程評價活動287
20.3.6產(chǎn)品評價活動288
20.3.7質(zhì)量保證進(jìn)度290
20.3.8過程檢查準(zhǔn)則292
20.3.9產(chǎn)品檢查準(zhǔn)則292
20.4軟件質(zhì)量保證計劃的常見問題293

第21章軟件研制總結(jié)報告295
21.1軟件研制總結(jié)報告的編寫要求296
21.2軟件研制總結(jié)報告的內(nèi)容297
21.2.1軟件研制總結(jié)報告模板297
21.2.2軟件階段/里程碑總結(jié)報告模板301
21.3軟件研制總結(jié)報告編寫示例303
21.3.1設(shè)計原則和指導(dǎo)思想303
21.3.2軟件開發(fā)工作綜述303
21.3.3軟件管理工作綜述306
21.4軟件研制總結(jié)報告的常見問題311

參考文獻(xiàn)313