實用軟件文檔寫作

第1章 軟件工程標(biāo)準(zhǔn)化與軟件文檔 1
1.1 軟件工程標(biāo)準(zhǔn) 1
1.2 軟件工程標(biāo)準(zhǔn)化的意義 3
1.3 軟件工程標(biāo)準(zhǔn)的層次 3
1.4 中國的軟件標(biāo)準(zhǔn) 5
1.5 ISO 9000-3標(biāo)準(zhǔn) 8
1.5.1 ISO 9000標(biāo)準(zhǔn)產(chǎn)生的背景 8
1.5.2 ISO 9000系列標(biāo)準(zhǔn)的內(nèi)容 9
第2章 軟件文檔及其組成 16
2.1 軟件文檔的概念 16
2.2 軟件文檔的作用 16
2.3 軟件文檔的分類 18
2.4 軟件文檔與使用者的關(guān)系 20
2.5 軟件文檔編制與軟件生存周期的關(guān)系 20
第3章 軟件文檔國家標(biāo)準(zhǔn) 23
3.1 計算機(jī)軟件產(chǎn)品開發(fā)文檔編制指南 23
3.1.1 軟件文檔的組成 23
3.1.2 各類文檔的內(nèi)容要求 25
3.2 計算機(jī)軟件需求說明編制指南 35
3.2.1 軟件需求文檔的編制目標(biāo) 35
3.2.2 軟件需求文檔的基本要求 36
3.2.3 軟件需求標(biāo)準(zhǔn)適用范圍 36
3.2.4 需求文檔的編寫大綱 37
3.2.5 需求文檔的編制說明 41
3.3 計算機(jī)軟件測試文檔編制規(guī)范 46
3.3.1 標(biāo)準(zhǔn)的適用對象及范圍 46
3.3.2 測試文檔的內(nèi)容 47
3.3.3 測試文檔與測試過程 47
3.3.4 測試文檔的結(jié)構(gòu) 49
3.3.5 測試文檔的編制 51
3.3.6 測試文檔編制實例 51
3.4 軟件文檔管理指南 52
3.4.1 軟件文檔管理概述 52
3.4.2 軟件文檔與文檔管理者 52
第4章 軟件文檔寫作要求 54
4.1 軟件文檔的編寫原則 54
4.2 文檔編寫的靈活性 55
4.3 制定文檔的編寫策略 57
4.4 建立文檔的企業(yè)標(biāo)準(zhǔn) 58
4.5 制定文檔的編制計劃 59
4.6 建立文檔的編制規(guī)程 60
4.7 軟件文檔的質(zhì)量要求 66
4.8 軟件文檔的編寫技巧 67
4.9 文檔編寫的實例 68
第5章 軟件開發(fā)文檔 71
5.1 可行性研究報告 71
5.1.1 可行性研究報告的內(nèi)容 71
5.1.2 可行性研究報告的要求 72
5.1.3 可行性研究報告的描述方法 73
5.1.4 可行性研究報告的評審 74
5.2 軟件需求文檔 74
5.2.1 軟件需求文檔的特點 75
5.2.2 軟件需求文檔的內(nèi)容 77
5.2.3 軟件需求文檔的編寫要求 79
5.2.4 軟件需求文檔的表達(dá)方法 80
5.2.5 軟件需求文檔的注釋 82
5.2.6 軟件需求文檔的表達(dá)重點 83
5.2.7 需求表達(dá)中的常見問題 83
5.3 概要設(shè)計文檔 84
5.3.1 結(jié)構(gòu)化表現(xiàn)形式 84
5.3.2 面向?qū)ο笤O(shè)計表現(xiàn)形式 88
5.4 詳細(xì)設(shè)計文檔 96
5.4.1 詳細(xì)設(shè)計文檔的內(nèi)容 96
5.4.2 詳細(xì)設(shè)計文檔的描述方法 97
第6章 軟件管理文檔 102
6.1 管理文檔概述 102
6.2 項目開發(fā)計劃 103
6.2.1 項目開發(fā)計劃書 103
6.2.2 工作分解結(jié)構(gòu) 104
6.2.3 項目里程碑與階段性文檔 105
6.2.4 項目進(jìn)度 106
6.2.5 運(yùn)用圖和表描述項目進(jìn)度 107
6.2.6 風(fēng)險管理 110
6.3 軟件測試計劃與測試報告 113
6.3.1 軟件測試、軟件檢查與調(diào)試 114
6.3.2 測試的成本 115
6.3.3 測試的原則 116
6.3.4 軟件測試過程 117
6.3.5 測試計劃的導(dǎo)出與測試計劃的結(jié)構(gòu) 118
6.3.6 幾種常見的測試用圖表工具 119
6.3.7 設(shè)計軟件測試 121
6.3.8 軟件測試計劃文檔 133
6.3.9 軟件測試報告 134
6.4 開發(fā)進(jìn)度報告 136
6.4.1 項目狀態(tài)報告類型 137
6.4.2 報告的主要內(nèi)容 138
6.4.3 開發(fā)進(jìn)度偏差 138
6.4.4 圖形報告工具 139
6.4.5 成本進(jìn)度控制描述 141
6.4.6 項目的變更 144
6.5 項目開發(fā)總結(jié)報告 146
第7章 軟件用戶文檔 147
7.1 編寫用戶文檔的基本要求 147
7.2 軟件常用表示形式 148
7.2.1 容器模型 148
7.2.2 客戶機(jī)/服務(wù)器模型 148
7.2.3 抽象機(jī)模型 148
7.2.4 接口描述 149
7.2.5 控制模型 150
7.2.6 數(shù)據(jù)流模型 151
7.2.7 狀態(tài)機(jī)模型 152
7.2.8 數(shù)據(jù)模型 152
7.2.9 對象模型 154
7.3 用戶手冊 156
7.4 操作手冊 157
7.5 維護(hù)修改文檔 157
7.5.1 軟件運(yùn)行系統(tǒng)的結(jié)構(gòu) 158
7.5.2 維護(hù)修改方案 159
7.5.3 維護(hù)過程與記載 159
7.5.4 維護(hù)修改建議 161
第8章 軟件文檔管理 163
8.1 軟件文檔的管理 163
8.2 軟件文檔的管理方式 165
8.3 軟件文檔的維護(hù) 167
8.4 動態(tài)文檔管理 168
8.5 項目管理軟件 169
8.5.1 項目管理軟件的功能 169
8.5.2 常見的項目管理軟件 171
附錄A 軟件文檔國家標(biāo)準(zhǔn) 173
附錄A-1 軟件產(chǎn)品開發(fā)文件編制指南（GB 8567-1988） 173
A-1.1 《可行性研究報告》編寫參考指南 173
A-1.2 《項目開發(fā)計劃》編寫參考指南 178
A-1.3 《軟件需求說明書》編寫參考指南 180
A-1.4 《數(shù)據(jù)要求說明書》編寫參考指南 181
A-1.5 《概要設(shè)計說明書》編寫參考指南 183
A-1.6 《詳細(xì)設(shè)計說明書》編寫參考指南 185
A-1.7 《數(shù)據(jù)庫設(shè)計說明書》編寫參考指南 187
A-1.8 《用戶手冊》編寫參考指南 188
A-1.9 《操作手冊》編寫參考指南 191
A-1.10 《模塊開發(fā)卷宗》編寫參考指南 193
A-1.11 《測試計劃》編寫參考指南 194
A-1.12 《測試分析報告》編寫參考指南 195
A-1.13 《開發(fā)進(jìn)度月報》編寫參考指南 197
A-1.14 《開發(fā)總結(jié)報告》編寫參考指南 198
附錄A-2 計算機(jī)軟件測試文件編制規(guī)范（GB 9386-1988）《軟件測試文件》
編寫參考指南 200
附錄B 高評委專家?guī)煨畔⒐芾硐到y(tǒng)文檔編制 206
附錄C 銀河偵探游戲軟件文檔編制 227
參考文獻(xiàn) 260