本書不同于一般的軟件文檔寫作教材,不僅講述軟件文檔寫作的基本內(nèi)容和方法,而且根據(jù)軟件工程領(lǐng)域的*新發(fā)展,結(jié)合典型開發(fā)案例,力求系統(tǒng)地描述可行性研究報告、項目建議書、投標(biāo)文件、需求分析書、概要設(shè)計書、詳細(xì)設(shè)計書、項目驗收報告和項目總結(jié)報告等文檔的寫作規(guī)范和技巧。以典型的軟件系統(tǒng)開發(fā)項目為案例,重點講述開發(fā)過程中形成的三大文檔,指導(dǎo)學(xué)生如何書寫軟件開發(fā)過程中的相關(guān)文檔。
馬平, 北京航空航天大學(xué)軟件學(xué)院教授, 長期從事軟件工程領(lǐng)域的教學(xué)與研究工作, 著有<小波與圖像分析>等作品, 發(fā)表論文多篇.
第1章 緒論 1
1.1 軟件文檔的意義 1
1.2 軟件文檔的作用 2
1.3 軟件文檔的分類 3
1.4 軟件文檔必備的條件 6
1.5 軟件文檔的管理 8
本章小結(jié) 12
參考文獻(xiàn) 12
第2章 軟件文檔的寫作規(guī)范 13
2.1 項目立項階段文檔的寫作規(guī)范 13
2.2 需求分析書的寫作規(guī)范 27
2.3 概要設(shè)計書的寫作規(guī)范 31
2.4 詳細(xì)設(shè)計書的寫作規(guī)范 36
2.5 項目結(jié)束階段文檔的寫作規(guī)范 39
本章小結(jié) 47
參考文獻(xiàn) 47
習(xí)題 48
第3章 軟件項目立項階段文檔寫作案例分析――某市軌道交通突發(fā)事件實時應(yīng)急
集成指揮系統(tǒng)案例分析 49
3.1 項目的目的和意義 49
3.2 國內(nèi)外研究開發(fā)現(xiàn)狀和發(fā)展趨勢 51
3.3 項目現(xiàn)有工作基礎(chǔ) 52
3.4 項目實施目標(biāo) 54
3.5 主要研究開發(fā)內(nèi)容 55
3.6 社會經(jīng)濟(jì)效益分析和風(fēng)險分析 59
3.7 年度目標(biāo)和年度實施計劃 61
3.8 預(yù)期主要成果 62
本章小結(jié) 62
參考文獻(xiàn) 62
習(xí)題 63
第4章 需求分析書案例分析一――研究生教務(wù)管理系統(tǒng)案例分析 64
4.1 引言 64
4.2 任務(wù)概述 67
4.3 需求規(guī)定 68
4.4 運行環(huán)境規(guī)定 76
本章小結(jié) 78
參考文獻(xiàn) 78
習(xí)題 78
第5章 需求分析書案例分析二――奧運綜合服務(wù)系統(tǒng)案例分析 80
5.1 系統(tǒng)概述 80
5.2 功能和非功能需求 82
5.3 數(shù)據(jù)需求 92
5.4 接口需求 94
5.5 環(huán)境需求 101
本章小結(jié) 103
參考文獻(xiàn) 103
習(xí)題 104
第6章 需求分析書案例分析三――地鐵綜合信息查詢系統(tǒng)案例分析 105
6.1 概述 106
6.2 系統(tǒng)需求 108
6.3 總體結(jié)構(gòu) 116
6.4 用戶培訓(xùn) 117
本章小結(jié) 117
參考文獻(xiàn) 117
習(xí)題 118
第7章 概要設(shè)計書案例分析一――研究生教務(wù)管理系統(tǒng)案例分析 119
7.1 引言 119
7.2 總體設(shè)計 121
7.3 接口設(shè)計 126
7.4 運行設(shè)計 127
7.5 系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計 128
7.6 系統(tǒng)出錯處理設(shè)計 133
本章小結(jié) 134
參考文獻(xiàn) 135
習(xí)題 135
第8章 概要設(shè)計書案例分析二――辦公自動化系統(tǒng)案例分析 136
8.1 引言 136
8.2 概要設(shè)計 137
8.3 各子系統(tǒng)概要設(shè)計 140
8.4 接口設(shè)計 144
8.5 系統(tǒng)出錯處理設(shè)計 144
本章小結(jié) 162
參考文獻(xiàn) 162
習(xí)題 162
第9章 概要設(shè)計書案例分析三――某企業(yè)建筑業(yè)信息化系統(tǒng)案例分析 164
9.1 軟件體系結(jié)構(gòu)的確立 164
9.2 框架選型 166
9.3 軟件開發(fā)模型選擇 167
9.4 總體設(shè)計 170
9.5 數(shù)據(jù)庫設(shè)計 172
本章小結(jié) 174
參考文獻(xiàn) 174
習(xí)題 174
第10章 詳細(xì)設(shè)計書案例分析一――研究生教務(wù)管理系統(tǒng)案例分析 176
10.1 引言 177
10.2 程序系統(tǒng)的結(jié)構(gòu) 178
10.3 程序設(shè)計說明 179
10.4 算法 188
10.5 接口 191
10.6 存儲分配 191
10.7 注釋設(shè)計 191
10.8 限制條件 192
10.9 測試計劃 193
本章小結(jié) 193
參考文獻(xiàn) 193
習(xí)題 194
第11章 詳細(xì)設(shè)計書案例分析二――中國教育信息化系統(tǒng)案例分析 195
11.1 案例分析 195
11.2 詳細(xì)設(shè)計的工具 199
11.3 詳細(xì)設(shè)計書的注意事項 201
11.4 詳細(xì)設(shè)計的評審 202
本章小結(jié) 204
參考文獻(xiàn) 204
習(xí)題 205
第12章 軟件項目結(jié)束階段文檔寫作案例分析――校園博客系統(tǒng)案例分析 206
12.1 測試概述 207
12.2 測試計劃執(zhí)行情況 208
12.3 測試總結(jié) 210
12.4 綜合評價 213
本章小結(jié) 214
參考文獻(xiàn) 214
習(xí)題 214
第13章 總結(jié) 216