《實用軟體文檔寫作》是2005年2月1日清華大學出版社出版的圖書，作者是肖剛。該書依據軟體工程學的基本原理，強調了軟體=程式+文檔的思想，系統地闡述了計算機軟體開發各個階段文檔寫作的步驟、內容、方法、工具、特點和要求。
基本介紹
- 書名：實用軟體文檔寫作
- 作者：肖剛 等
- ISBN：10位[7302103739] 13位[9787302103738]
- 定價：￥23.00 元
- 出版社：清華大學出版社
- 出版時間：2005年2月1日
內容提要,圖書目錄,
內容提要
全書共8章，3個附錄，分別對軟體工程標準化意義、軟體文檔的概念和內容、軟體文檔有關國家標準、軟體文檔編寫的原則和步驟、軟體文檔的管理和維護等進行了介紹，對可行性研究報告、軟體需求報告、概要設計說明書、詳細設計說明書等開發文檔，項目開發計畫、軟體測試計畫、開發進度報告、項目開發總結報告等管理文檔和用戶文檔的寫作方法和寫作技巧進行了詳細介紹。本書既可作為高等院校計算機科學與技術、軟體工程等相關專業的本科生和研究生的教學用書，也可作為軟體研究和開發人員知識培訓與繼續教育參考用書。
圖書目錄
第1章 軟體工程標準化與軟體文檔
1.1 軟體工程標準
1.2 軟體工程標準化的意義
1.3 軟體工程標準的層次
1.4 中國的軟體標準
1.5 ISO 9000-3標準
1.5.1 ISO 9000標準產生的背景
1.5.2 ISO 9000系列標準的內容
第2章 軟體文檔及其組成
2.1 軟體文檔的概念
2.2 軟體文檔的作用
2.3 軟體文檔的分類
2.4 軟體文檔與使用者的關係
2.5 軟體文檔編制與軟體生存周期的關係
第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.3 計算機軟體測試文檔編制規範
3.3.1 標準的適用對象及範圍
3.3.2 測試文檔的內容
3.3.3 測試文檔與測試過程
3.3.4 測試文檔的結構
3.3.5 測試文檔的編制
3.3.6 測試文檔編制實例
3.4 軟體文檔管理指南
3.4.1 軟體文檔管理概述
3.4.2 軟體文檔與文檔管理者
第4章 軟體文檔寫作要求
4.1 軟體文檔的編寫原則
4.2 文檔編寫的靈活性
4.3 制定文檔的編寫策略
4.4 建立文檔的企業標準
4.5 制定文檔的編制計畫
4.6 建立文檔的編制規程
4.7 軟體文檔的質量要求
4.8 軟體文檔的編寫技巧
4.9 文檔編寫的實例
第5章 軟體開發文檔
5.1 可行性研究報告
5.1.1 可行性研究報告的內容
5.1.2 可行性研究報告的要求
5.1.3 可行性研究報告的描述方法
5.1.4 可行性研究報告的評審
5.2 軟體需求文檔
5.2.1 軟體需求文檔的特點
5.2.2 軟體需求文檔的內容
5.2.3 軟體需求文檔的編寫要求
5.2.4 軟體需求文檔的表達方法
5.2.5 軟體需求文檔的注釋
5.2.6 軟體需求文檔的表達重點
5.2.7 需求表達中的常見問題
5.3 概要設計文檔
5.3.1 結構化表現形式
5.3.2 面向對象設計表現形式
5.4 詳細設計文檔
5.4.1 詳細設計文檔的內容
5.4.2 詳細設計文檔的描述方法
第6章 軟體管理文檔
6.1 管理文檔概述
6.2 項目開發計畫
6.2.1 項目開發計畫書
6.2.2 工作分解結構
6.2.3 項目里程碑與階段性文檔
6.2.4 項目進度
6.2.5 運用圖和表描述項目進度
6.2.6 風險管理
6.3 軟體測試計畫與測試報告
6.3.1 軟體測試、軟體檢查與調試
6.3.2 測試的成本
6.3.3 測試的原則
6.3.4 軟體測試過程
6.3.5 測試計畫的導出與測試計畫的結構
6.3.6 幾種常見的測試用圖表工具
6.3.7 設計軟體測試
6.3.8 軟體測試計畫文檔
6.3.9 軟體測試報告
6.4 開發進度報告
6.4.1 項目狀態報告類型
6.4.2 報告的主要內容
6.4.3 開發進度偏差
6.4.4 圖形報告工具
6.4.5 成本進度控制描述
6.4.6 項目的變更
6.5 項目開發總結報告
第7章 軟體用戶文檔
7.1 編寫用戶文檔的基本要求
7.2 軟體常用表示形式
7.2.1 容器模型
7.2.2 客戶機/伺服器模型
7.2.3 抽象機模型
7.2.4 接口描述
7.2.5 控制模型
7.2.6 數據流模型
7.2.7 狀態機模型
7.2.8 數據模型
7.2.9 對象模型
7.3 用戶手冊
7.4 操作手冊
7.5 維護修改文檔
7.5.1 軟體運行系統的結構
7.5.2 維護修改方案
7.5.3 維護過程與記載
7.5.4 維護修改建議
第8章 軟體文檔管理
8.1 軟體文檔的管理
8.2 軟體文檔的管理方式
8.3 軟體文檔的維護
8.4 動態文檔管理
8.5 項目管理軟體
8.5.1 項目管理軟體的功能
8.5.2 常見的項目管理軟體
附錄A 軟體文檔國家標準
附錄A-1 軟體產品開發檔案編制指南（GB 8567-1988）
A-1.1 《可行性研究報告》編寫參考指南
A-1.2 《項目開發計畫》編寫參考指南
A-1.3 《軟體需求說明書》編寫參考指南
A-1.4 《數據要求說明書》編寫參考指南
A-1.5 《概要設計說明書》編寫參考指南
A-1.6 《詳細設計說明書》編寫參考指南
A-1.7 《資料庫設計說明書》編寫參考指南
A-1.8 《用戶手冊》編寫參考指南
A-1.9 《操作手冊》編寫參考指南
A-1.10 《模組開發卷宗》編寫參考指南
A-1.11 《測試計畫》編寫參考指南
A-1.12 《測試分析報告》編寫參考指南
A-1.13 《開發進度月報》編寫參考指南
A-1.14 《開發總結報告》編寫參考指南
附錄A-2 計算機軟體測試檔案編制規範（GB 9386-1988）《軟體測試檔案》編寫參考指南
附錄B 高評審專家庫信息管理系統文檔編制
附錄C 銀河偵探遊戲軟體文檔編制
參考文獻
