軟件文檔編寫（簡體書）

《軟件文檔寫作》是普通高等教育“十一五”國家級規劃教材。《軟件文檔寫作》遵循國家有關計算機軟件開發文檔編制的標準和規範，從基於結構化方法和面向對象方法兩個方面，介紹了可行性研究報告、軟件需求規格說明書、概要設計說明書、詳細設計說明書、軟件測試說明書等幾個重要的軟件開發文檔的編寫要求與方法，強調了CASE工具在文檔編寫過程中的作用，并給出了軟件文檔編寫的詳細實例。《軟件文檔寫作》可作為應用型、技能型人才培養的各類教育相關專業“軟件工程”、“軟件文檔寫作”課程的教學用書，也可供參加各類培訓的人員、計算機從業人員和愛好者參考。

第1章 軟件工程標準化與軟件文檔
1.1 軟件生存周期與軟件文檔
1.2 軟件文檔的作用
1.3 軟件文檔分類
1.3.1 開發文檔
1.3.2 產品文檔
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 建立企業的文檔標準
1.5.5 制訂文檔編寫計劃
1.5.6 建立文檔管理規程
1.5.7 軟件文檔的質量要求
1.6 項目開發的文檔化
本章小結
習題

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

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

第4章 基於結構化方法的軟件文檔
4.1 軟件需求規格說明書
4.1.1 需求分析概述
4.1.2 軟件需求規格說明書的目的和編寫要求
4.1.3 軟件需求規格說明書的內容要求與編寫指南
4.1.4 軟件需求規格說明書示例
4.2 概要設計說明書
4.2.1 概要設計概述
4.2.2 概要設計說明書的內容要求與編寫指南
4.2.3 概要設計說明書示例
4.3 詳細設計說明書
4.3.1 詳細設計概述
4.3.2 詳細設計說明書的內容要求和編寫指南
4.3.3 詳細設計說明書示例
本章小結
習題
實訓

第5章 基於面向對象方法的軟件需求規格說明書
5.1 面向對象的軟件需求分析概述
5.2 軟件需求規格說明書的內容要求與編寫指南
5.2.1 引言
5.2.2 項目概述
5.2.3 需求規定
5.3 用例說明書的內容及編寫要點
5.4 基於面向對象方法的軟件需求規格說明書示例
本章小結
習題
實訓

第6章 基於面向對象方法的軟件設計說明書
6.1 面向對象軟件設計概述
6.2 面向對象的軟件設計說明書的內容要求和編寫指南
6.2.1 類報告
6.2.2 用例實現報告
6.2.3 設計模型報告
6.3 面向對象設計文檔的編寫示例
本章小結
實訓

第7章 程序代碼的文檔化
7.1 程序代碼規範
7.2 Doxygen應用基礎
7.2.1 安裝Doxygen
7.2.2 設置項目的Doxygen配置文件模板
7.2 ‘3編寫正確格式的注釋
7.2.4 製作說明文件
7.2.5 Doxygen使用步驟及範例
本章小結
習題
實訓

第8章 面向對象測試文檔
8.1 面向對象測試概述
8.1.1 面向對象測試的具體任務
8.1.2 面向對象測試的步驟
8.2 面向對象測試文檔
8.2.1 測試計劃
8.2.2 測試用例
8.2.3 測試報告
8.3 面向對象測試文檔的內容要求和編寫指南
8.3.1 引言
8.3.2 項目背景
8.3.3 質量目標
8.3.4 測試資源
8.3.5 測試策略
8.3.6 測試計劃
本章小結
習題
實訓
參考文獻