內容簡介
本書不同於一般的軟體文檔寫作教材,不僅講述軟體文檔寫作的基本內容和方法,而且根據軟體工程領域的最新發展,結合典型開發案例,力求系統地描述可行性研究報告、項目建議書、投標檔案、需求分析書、概要設計書、詳細設計書、項目驗收報告和項目總結報告等文檔的寫作規範和技巧。以典型的軟體系統開發項目為案例,重點講述開發過程中形成的三大文檔,指導學生如何書寫軟體開發過程中的相關文檔。《軟體文檔寫作教程》可作為軟體工程,計算機科學與技術等專業本科生及研究生的參考書,也可作為相關研究開發人員的參考書和工具書。
圖書目錄
目 錄
第1章 緒論
1.1 軟體文檔的意義
1.2 軟體文檔的作用
1.3 軟體文檔的分類
1.4 軟體文檔必備的條件
1.5 軟體文檔的管理
1.6 本章小結
1.7 參考文獻
第2章 軟體文檔的寫作規範
2.1 項目立項階段文檔的寫作規範
2.2 需求分析書的寫作規範
2.3 概要設計書的寫作規範
2.4 詳細設計書的寫作規範
2.5 項目結束階段文檔的寫作規範
2.6本章小結
2.7 參考文獻
2.8習題
第3章 軟體項目立項階段文檔寫作案例分析
—— 某市軌道交通突發事件實時應急集成指揮系統案例分析
3.1 項目的目的和意義
3.2 國內外研究開發現狀和發展趨勢
3.3 項目現有工作基礎
3.4 項目實施目標
3.5 主要研究開發內容
3.6 社會經濟效益分析和風險分析
3.7 年度目標和年度實施計畫
3.8 預期主要成果
3.9本章小結
3.10參考文獻
3.11習題
第4章 需求分析書案例分析一
—— 研究生教務管理系統案例分析
4.1 引言
4.2 任務概述
4.3需求規定
4.4 運行環境規定
4.5本章小結
4.6 參考文獻
4.7 習題
第5章 需求分析書案例分析二
—— 奧運綜合服務系統案例分析
5.1 系統概述
5.2 功能和非功能需求
5.3 數據需求
5.4 接口需求
5.5 環境需求
5.6本章小結
5.7參考文獻
5.8習題
第6章 需求分析書案例分析三
—— 捷運綜合信息查詢系統案例分析
6.1 概述
6.2 系統需求
6.3 總體結構
6.4 用戶培訓
6.5本章小結
6.6參考文獻
6.7習題
第7章 概要設計書案例分析一
—— 研究生教務管理系統案例分析
7.1 引言
7.2 總體設計
7.3 接口設計
7.4 運行設計
7.5 系統數據結構設計
7.6 系統出錯處理設計
7.7本章小結
7.8 參考文獻
7.9習題
第8章 概要設計書案例分析二
—— 辦公自動化系統案例分析
8.1 引言
8.2 概要設計
8.3 各子系統概要設計
8.4 接口設計
8.5 系統出錯處理設計
8.6本章小結
8.7參考文獻
8.8習題
第9章 概要設計書案例分析三
—— 某企業建築業信息化系統案例分析
9.1 軟體體系結構的確立
9.2 框架選型
9.3 軟體開發模型選擇
9.4 總體設計
9.5 資料庫設計
9.6本章小結
9.7參考文獻
9.8習題
第10章 詳細設計書案例分析一
—— 研究生教務管理系統案例分析
10.1 引言
10.2 程式系統的結構
10.3 程式設計說明
10.4 算法
10.5 接口
10.6 存儲分配
10.7 注釋設計
10.8 限制條件
10.9 測試計畫
10.10本章小結
10.11參考文獻
10.12習題
第11章 詳細設計書案例分析二
—— 中國教育信息化系統案例分析
11.1 案例分析
11.2 詳細設計的工具
11.3 詳細設計書的注意事項
11.4 詳細設計的評審
11.5本章小結
11.6參考文獻
11.7習題
第12章 軟體項目結束階段文檔寫作案例分析
—— 校園部落格系統案例分析
12.1 測試概述
12.2 測試計畫執行情況
12.3 測試總結
12.4 綜合評價
12.5本章小結
12.6參考文獻
12.7習題
第13章 總結
……