軟件文檔

第1章 軟件工程標準化與軟件文檔1

1.1 軟件工程標準化1

1.2 軟件工程標準分類1

1.3 軟件工程標準層次4

1.4 中國軟件工程標準5第2章 軟件文檔及其類型9

2.1 軟件文檔的概念9

2.2 軟件文檔的作用9

2.3 軟件文檔的分類10

2.4 軟件文檔與使用對象的關係12

2.5 軟件文檔與軟件生存週期的關係12第3章 軟件文檔國家標準16

3.1 計算機軟件文檔編制規範16

3.1.1 文檔標準常用術語16

3.1.2 軟件的基本文檔17

3.1.3 文檔的編制格式20

3.2 計算機軟件需求規格説明規範38

3.2.1 SRS的編制目標39

3.2.2 SRS的編制格式39

3.2.3 SRS的方案選擇47

3.3 計算機軟件測試文檔編制規範50

3.3.1 標準的適用對象及範圍50

3.3.2 測試文檔的編制格式51

3.3.3 測試文檔的編制54

3.4 軟件文檔管理指南55

3.4.1 軟件文檔管理概述55

3.4.2 軟件文檔與文檔管理者56第4章 軟件文檔編制57

4.1 軟件文檔的編制原則57

4.2 文檔編制的靈活性57

4.3 制定文檔的編制策略59

4.4 建立文檔的企業標準60

4.5 制定文檔的編制計劃 61

4.6 建立文檔的編制規程62

4.7 軟件文檔的質量要求69

4.8 軟件文檔的編制技巧70

4.9 文檔編制的實例 71第5章 軟件開發文檔75

5.1 軟件需求文檔75

5.1.1 軟件需求文檔的特點76

5.1.2 軟件需求文檔的編寫要求78

5.1.3 軟件需求文檔的內容79

5.1.4 軟件需求文檔的表達方法84

5.1.5 軟件需求文檔的注意事項88

5.2 軟件設計文檔90

5.2.1 軟件設計文檔的編寫目標90

5.2.2 軟件設計文檔的編寫要求91

5.2.3 軟件設計文檔的內容91

5.2.4 軟件設計文檔的設計方法97

5.2.5 軟件設計文檔的描述形式101

5.3 軟件測試文檔105

5.3.1 軟件測試文檔的重要性105

5.3.2 軟件測試文檔的基本原則106

5.3.3 軟件測試過程及其文檔107

5.3.4 軟件測試文檔的內容114

5.3.5 軟件測試文檔的表達形式117第6章 軟件管理文檔120

6.1 管理文檔概述120

6.2 可行性分析報告121

6.2.1 可行性分析報告的內容121

6.2.2 可行性分析報告的要求121

6.2.3 可行性分析報告的描述方法122

6.2.4 可行性分析報告的評審124

6.3 軟件開發計劃124

6.3.1 軟件開發計劃的內容124

6.3.2 工作分解結構125

6.3.3 項目里程碑與階段性文檔126

6.3.4 項目進度127

6.3.5 運用圖和表描述項目進度128

6.4 軟件配置管理計劃130

6.4.1 軟件配置管理計劃的要求與作用131

6.4.2 軟件配置管理計劃的內容131

6.4.3 軟件配置管理計劃的表述方式132

6.5 軟件質量保證計劃133

6.5.1 軟件質量保證計劃的基本要求133

6.5.2 軟件質量保證計劃的內容134

6.5.3 軟件質量保證計劃的表述方式135

6.5.4 軟件質量保證計劃的輔助工具136

6.6 開發進度月報137

6.6.1 開發進度月報的類型137

6.6.2 開發進度月報的主要內容138

6.6.3 開發進度偏差139

6.6.4 開發進度圖形工具139

6.6.5 項目的變更141

6.7 項目開發總結報告142第7章 軟件產品文檔144

7.1 產品文檔的編制要求144

7.2 軟件用户手冊144

7.3 計算機操作手冊146

7.4 軟件產品規格説明146

7.5 軟件版本説明147

7.5.1 軟件運行系統的結構147

7.5.2 軟件維護方案148

7.5.3 軟件維護過程149

7.5.4 軟件版本説明的內容150第8章 軟件文檔管理151

8.1 軟件文檔管理的內容151

8.2 軟件文檔管理的方式153

8.3 軟件文檔的維護155

8.4 動態軟件文檔管理155

8.5 項目管理軟件156

8.5.1 項目管理軟件的功能 157

8.5.2 常見的項目管理軟件 158第9章 使用Visio 2007編制文檔160

9.1 Microsoft Visio 2007簡介160

9.2 Microsoft Visio 2007繪製圖表164

9.3 Microsoft Visio 2007數據發佈167附錄A 高級專業技術資格評審委員會專家庫信息管理系統文檔編制169

A1 引言171

A1.1 標識171

A1.2 系統概述171

A1.3 文檔概述171

A1.4 基線171

A1.5 引用文件171

A2 CSCI級設計決策172

A2.1 系統處理流程172

A2.2 系統開發與運行環境172

A3 CSCI體系結構設計172

A3.1 CSCI程序模塊劃分172

A3.2 程序模塊結構圖175

A3.3 程序模塊與數據結構175

A3.4 系統接口設計176

A4 數據庫結構設計176

A5 CSCI詳細設計179

A5.1 CSCI調用關係179

A5.2 CSCI內程序模塊詳細設計182

A6 系統出錯處理設計185

A6.1 出錯信息185

A6.2 補救措施185參考文獻186

本書依據軟件工程學的基本原理，強調了“軟件=程序+文檔”的思想，系統闡述了計算機軟件開發各個階段文檔寫作的步驟、內容、方法、工具、特點和要求。全書共分9章和一個附錄，分別介紹了軟件工程標準化意義、軟件文檔的概念和內容，軟件文檔國家最新標準，軟件文檔編制的原則、步驟、策略和技巧，對軟件需求文檔、軟件設計文檔和軟件測試文檔等軟件開發文檔，可行性分析報告、軟件開發計劃、軟件配置管理計劃、軟件質量保證計劃、開發進度月報和項目總結報告等軟件管理文檔，以及軟件用户手冊、計算機操作手冊、軟件產品規格説明、軟件版本説明等軟件產品文檔的編制方法和編制技巧進行了詳細介紹，並提供了軟件（結構）設計文檔作為實例。

軟件文檔編制貫穿於軟件產品開發的各個階段，是提高軟件產品開發效率、規範軟件產品開發過程、保證軟件產品質量的關鍵，國家發佈的一系列軟件文檔標準有力地促進了軟件產品開發的系統化、規範化和標準化。

為適應最新的軟件文檔國家標準，並結合近幾年教學實踐和項目開發的總結和體會，本書對2005年出版的《實用軟件文檔寫作》的內容進行了重新組織、補充和修訂，使書中的內容更加具有系統性和實用性。

本書分為9章和一個附錄。第1章介紹軟件工程標準化的意義、軟件工程標準的層次以及已經制定的軟件工程標準；第2章介紹軟件文檔的概念和作用，並對軟件文檔編制的內容與軟件生存週期的關係進行詳細介紹；第3章詳細介紹計算機軟件文檔編制規範、計算機軟件需求規格説明規範和計算機軟件測試文檔編制規範3個最新軟件文檔國家標準，討論了不同類型文檔的編制格式和要求；第4章詳細討論軟件文檔的編制原則、靈活性、策略、計劃、規程以及質量要求，並介紹軟件文檔編制的寫作技巧;第5章詳細介紹軟件需求文檔、軟件設計文檔和軟件測試文檔等軟件開發文檔的編制方法和編制技巧；第6章詳細介紹了可行性分析報告、軟件開發計劃、軟件配置管理計劃、軟件質量保證計劃、開發進度月報項目總結報告等軟件管理文檔的編制內容、方法和技巧；第7章詳細介紹軟件用户手冊、計算機操作手冊、軟件產品規格説明、軟件版本説明等軟件產品文檔的編制要求、方法和技巧；第8章介紹軟件文檔的管理和維護，並介紹了常用項目管理軟件；第9章介紹如何使用Visio 2007工具編制軟件文檔；附錄介紹了一個軟件項目的軟件（結構）設計文檔，供讀者參考。

本書第1～4章由肖剛、張元鳴編寫，第5～9章由肖剛、陸佳煒編寫，附錄由張元鳴編寫。全書由肖剛負責策劃、組織、整理和統稿。書中內容雖為作者多年從事教學和科研工作的總結和體會，但由於軟件技術仍在不斷髮展之中，以及作者的理論與實踐水平有限，難免存在錯誤和不足之處，敬請讀者批評指正。