軟件文檔寫作與管理

目錄

第1章軟件工程基礎
1.1軟件與軟件工程
1.1.1軟件定義與軟件特點
1.1.2軟件危機與軟件工程
1.2軟件過程
1.2.1瀑布模型對應的軟件過程
1.2.2以架構為核心的軟件過程
1.3軟件過程中的文檔
1.3.1軟件文檔
1.3.2撰寫軟件文檔的目的與作用
1.3.3軟件文檔的范圍及分類
1.3.4項目開發(fā)與文檔的關系
1.3.5軟件過程角色與文檔的關系
1.3.6軟件過程中的文檔編制
1.3.7撰寫軟件文檔應考慮的因素
1.3.8軟件文檔的管理
第2章項目規(guī)劃類文檔寫作
2.1項目立項過程
2.2商業(yè)計劃書
2.2.1商業(yè)計劃書寫作要求
2.2.2商業(yè)計劃書內容框架
2.3可行性研究報告
2.3.1可行性研究報告寫作要求
2.3.2可行性研究報告內容框架
2.4項目方案書
2.4.1項目方案書寫作要求
2.4.2項目方案書內容框架
2.5項目開發(fā)計劃
2.5.1項目開發(fā)計劃寫作要求
2.5.2項目開發(fā)計劃內容框架
第3章需求類文檔寫作
3.1需求概述
3.2軟件需求的分類
3.3需求過程
3.3.1需求分析
3.3.2需求過程的管理
3.3.3需求獲取的流程
3.3.4需求管理的角色
3.4需求說明書的撰寫要求
3.4.1需求文檔的文字敘述要求
3.4.2對用例說明的要求
3.4.3非功能需求的說明要求
3.5需求說明書內容框架
3.6需求原型工具Axure
第4章設計類文檔寫作
4.1軟件設計過程
4.2軟件架構設計
4.2.1架構的概念
4.2.2以架構為中心的迭代開發(fā)周期模型
4.2.3領域建模
4.2.4非功能需求驅動的架構設計
4.3軟件架構文檔
4.3.1軟件架構文檔寫作要求
4.3.2軟件架構文檔內容框架
4.4概要設計說明書
4.4.1概要設計說明書寫作要求
4.4.2概要設計說明書內容框架
4.5詳細設計說明書
4.5.1詳細設計說明書寫作要求
4.5.2詳細設計說明書內容框架
4.6數(shù)據(jù)庫設計說明書
4.6.1數(shù)據(jù)庫設計的步驟
4.6.2數(shù)據(jù)庫設計說明書內容框架
4.7用戶界面設計文檔
第5章測試類文檔寫作
5.1測試過程
5.1.1測試概述
5.1.2集成測試過程
5.1.3系統(tǒng)測試過程
5.2測試用例的撰寫
5.2.1測試用例寫作要求
5.2.2測試用例內容框架
5.3測試計劃
5.4測試分析報告
第6章項目結束類文檔寫作
6.1部署過程
6.2用戶培訓計劃
6.3開發(fā)組織內部的培訓課程
6.4用戶手冊
6.4.1用戶手冊要求
6.4.2用戶手冊內容框架
6.5產(chǎn)品手冊要求
6.6項目總結
6.6.1項目總結要求
6.6.2項目總結報告內容框架
第7章項目管理過程類文檔寫作
7.1項目管理過程
7.2項目風險管理
7.3時間進度管理
7.4項目估算管理
7.5項目管理過程文檔
第8章質量保證文檔寫作
8.1軟件質量保證定義
8.2軟件質量保證管理
8.2.1SQA過程
8.2.2SQA偏差過程
第9章軟件文檔配置管理
9.1軟件配置管理過程
9.1.1軟件配置管理出現(xiàn)的背景
9.1.2軟件配置管理發(fā)展現(xiàn)狀
9.1.3軟件配置管理的目的
9.1.4軟件配置管理的基本活動
9.2配置管理過程規(guī)范
9.2.1配置管理計劃
9.2.2實施配置管理
9.3配置管理工具
9.4軟件文檔的配置管理方案
9.4.1軟件配置管理環(huán)境的設置
9.4.2軟件配置管理機制的組成和建立
9.4.3軟件配置管理活動的實施流程
9.4.4軟件配置管理基本任務的相關規(guī)范
9.4.5配置管理的標識規(guī)范
9.4.6配置管理的建議
9.5需求文檔變更的管理
9.5.1需求變更的原因
9.5.2需求變更的處理流程
第10章企業(yè)軟件文檔的管理
10.1企業(yè)軟件文檔分類
10.2企業(yè)軟件文檔管理要求
10.3企業(yè)軟件文檔管理流程
10.4項目文檔的管理
附錄A文檔封面模板
附錄B項目規(guī)劃期文檔模板
B.1可行性研究報告模板
B.2項目方案書模板
附錄C需求類文檔模板
C.1需求調研報告
C.2需求規(guī)格說明書
C.3用例使用場景模版與實例
C.4用例描述模板
C.5需求評審報告
C.6需求分析報告檢查表
附錄D文檔設計模板
D.1軟件架構設計說明書
D.2概要設計說明書
D.2.1模板1
D.2.2模板2
D.3詳細設計說明書
D.3.1模板1
D.3.2模板2
D.4數(shù)據(jù)庫設計說明書
附錄E設計文檔模板
E.1軟件配置管理規(guī)范
E.2軟件修改報告
附錄F單元測試報告文檔模板
附錄G項目管理文檔模板
G.1風險列表
G.2周報
附錄H質量保證文檔模板
H.1質量保證計劃
H.2SQA匯總報告
H.3SQA每周報告
H.4SQA偏差報告
附錄I軟件文檔評分標準
參考文獻