軟件文檔寫作

第1章 軟件工程標準化與軟件文檔
1.1 軟件生存周期與軟件文檔
1.2 軟件文檔的作用
1.3 軟件文檔分類
1.3.1 開發(fā)文檔
1.3.2 產(chǎn)品文檔
1.3.3 管理文檔
1.4 軟件工程標準化
1.4.1 軟件工程標準化的意義
1.4.2 軟件工程標準的層次
1.4.3 中國的軟件標準
1.4.4 五種常見的國際軟件標準
1.5 軟件文檔編寫要求
1.5.1 軟件文檔的編寫原則
1.5.2 文檔編寫的靈活性
1.5.3 制定文檔編寫策略
1.5.4 建立企業(yè)的文檔標準
1.5.5 制訂文檔編寫計劃
1.5.6 建立文檔管理規(guī)程
1.5.7 軟件文檔的質(zhì)量要求
1.6 項目開發(fā)的文檔化
本章小結(jié)
習題

第2章 CASE工具與軟件文檔編寫
2.1 CAsE概述
2.2 CAsE支持下的軟件建模和文檔編寫工具
2.2.1 ProccssAnalYst和DataArchitcCt
2.2.2 SoDA自動化文檔設(shè)計和生成
2.2.3 P!ayCASE
本章小結(jié)
習題

第3章 可行性研究報告
3.1 可行性研究概述
3.1.1 可行性研究的任務(wù)
3.1.2 可行性研究的步驟
3.2 可行性研究報告的內(nèi)容要求與編寫指南
3.2.1 可行性研究報告的引言
3.2.2 可行性研究的前提
3.2.3 對現(xiàn)有系統(tǒng)的分析
3.2.4 對所建議系統(tǒng)的分析
3.2.5 可行性分析
3.2.6 可行性分析結(jié)論
3.3 可行性研究報告編寫示例
本章小節(jié)
習題
實訓(xùn)

第4章 基于結(jié)構(gòu)化方法的軟件文檔
4.1 軟件需求規(guī)格說明書
4.1.1 需求分析概述
4.1.2 軟件需求規(guī)格說明書的目的和編寫要求
4.1.3 軟件需求規(guī)格說明書的內(nèi)容要求與編寫指南
4.1.4 軟件需求規(guī)格說明書示例
4.2 概要設(shè)計說明書
4.2.1 概要設(shè)計概述
4.2.2 概要設(shè)計說明書的內(nèi)容要求與編寫指南
4.2.3 概要設(shè)計說明書示例
4.3 詳細設(shè)計說明書
4.3.1 詳細設(shè)計概述
4.3.2 詳細設(shè)計說明書的內(nèi)容要求和編寫指南
4.3.3 詳細設(shè)計說明書示例
本章小結(jié)
習題
實訓(xùn)

第5章 基于面向?qū)ο蠓椒ǖ能浖枨笠?guī)格說明書
5.1 面向?qū)ο蟮能浖枨蠓治龈攀?br /> 5.2 軟件需求規(guī)格說明書的內(nèi)容要求與編寫指南
5.2.1 引言
5.2.2 項目概述
5.2.3 需求規(guī)定
5.3 用例說明書的內(nèi)容及編寫要點
5.4 基于面向?qū)ο蠓椒ǖ能浖枨笠?guī)格說明書示例
本章小結(jié)
習題
實訓(xùn)

第6章 基于面向?qū)ο蠓椒ǖ能浖O(shè)計說明書
6.1 面向?qū)ο筌浖O(shè)計概述
6.2 面向?qū)ο蟮能浖O(shè)計說明書的內(nèi)容要求和編寫指南
6.2.1 類報告
6.2.2 用例實現(xiàn)報告
6.2.3 設(shè)計模型報告
6.3 面向?qū)ο笤O(shè)計文檔的編寫示例
本章小結(jié)
實訓(xùn)

第7章 程序代碼的文檔化
7.1 程序代碼規(guī)范
7.2 Doxygen應(yīng)用基礎(chǔ)
7.2.1 安裝Doxygen
7.2.2 設(shè)置項目的Doxygen配置文件模板
7.2 ‘3編寫正確格式的注釋
7.2.4 制作說明文件
7.2.5 Doxygen使用步驟及范例
本章小結(jié)
習題
實訓(xùn)

第8章 面向?qū)ο鬁y試文檔
8.1 面向?qū)ο鬁y試概述
8.1.1 面向?qū)ο鬁y試的具體任務(wù)
8.1.2 面向?qū)ο鬁y試的步驟
8.2 面向?qū)ο鬁y試文檔
8.2.1 測試計劃
8.2.2 測試用例
8.2.3 測試報告
8.3 面向?qū)ο鬁y試文檔的內(nèi)容要求和編寫指南
8.3.1 引言
8.3.2 項目背景
8.3.3 質(zhì)量目標
8.3.4 測試資源
8.3.5 測試策略
8.3.6 測試計劃
本章小結(jié)
習題
實訓(xùn)
參考文獻