目　錄
1　概述篇　1
1.1　什麼是技術文檔　2
1.1.1　技術文檔的定義　2
1.1.2　技術文檔的範疇　2
1.1.3　技術文檔的特徵　4
1.1.4　技術文檔的多種形式　4
1.2　技術文檔寫作的國際國內現狀　5
1.3　技術文檔寫作的重要意義　6
2　基礎篇　7
2.1　技術文檔寫作流程　8
2.1.1　需求分析　9
2.1.2　架構設計　10
2.1.3　文檔寫作　10
2.1.4　質量控製　11
2.1.5　文檔發布　12
2.1.6　文檔交付　12
2.1.7　文檔維護　12
2.2　需求分析　13
2.2.1　信息收集　13
2.2.2　簡化歸類　15
2.2.3　分析需求　18
2.2.4　確定文檔開發任務　20
2.3　架構設計　21
2.3.1　架構前的準備和學習　21
2.3.2　設計架構　22
2.3.3　架構檢查　25
2.4　文檔寫作　26
2.4.1　寫作的邏輯　26
2.4.2　寫作6步法　28
2.4.3　寫作黃金法則　28
2.5　質量控製　31
2.5.1　質量控製活動　31
2.5.2　高質量文檔三要素　34
3　進階篇　37
3.1　實用性　38
3.1.1　安全第一　39
3.1.2　內容準確　41
3.1.3　麵嚮任務　45
3.1.4　閤理組織　49
3.1.5　內容完整　58
3.2　可讀性　61
3.2.1　易讀　62
3.2.2　易理解　75
3.3　舒適性　85
3.3.1　文檔獲取便捷　86
3.3.2　內容檢索高效　87
3.3.3　閱讀感受舒適　92
4　實戰篇　101
4.1　如何寫需求說明書　102
4.1.1　需求說明書簡介　102
4.1.2　需求說明書內容框架　102
4.1.3　需求說明書寫作流程　104
4.1.4　需求說明書寫作實例　106
4.1.5　需求說明書寫作要點　111
4.1.6　需求說明書常見問題　111
4.2　如何寫概要設計文檔　112
4.2.1　概要設計文檔簡介　112
4.2.2　概要設計文檔內容框架　113
4.2.3　概要設計文檔寫作流程　114
4.2.4　概要設計文檔寫作實例　117
4.2.5　概要設計文檔寫作要點　121
4.2.6　概要設計文檔常見問題　121
4.3　如何寫軟件模塊詳細設計文檔　123
4.3.1　軟件模塊詳細設計文檔簡介　123
4.3.2　軟件模塊詳細設計文檔內容框架　123
4.3.3　軟件模塊詳細設計文檔寫作流程　124
4.3.4　軟件模塊詳細設計文檔寫作方法　125
4.3.5　軟件模塊詳細設計文檔寫作要求　131
4.4　如何編寫測試用例　144
4.4.1　測試用例簡介　144
4.4.2　測試用例內容框架　144
4.4.3　測試用例寫作流程　146
4.4.4　測試用例寫作實例　148
4.4.5　測試用例寫作要點　152
4.4.6　測試用例常見問題　152
4.5　如何寫使用指導文檔　155
4.5.1　使用指導文檔簡介　155
4.5.2　使用指導文檔內容框架　155
4.5.3　使用指導文檔寫作流程　156
4.5.4　使用指導文檔寫作實例　157
4.5.5　使用指導文檔寫作要點　171
4.5.6　使用指導文檔常見問題　171
4.6　如何寫故障處理文檔　173
4.6.1　故障處理文檔簡介　173
4.6.2　故障處理文檔內容框架　173
4.6.3　故障處理文檔寫作流程　174
4.6.4　故障處理文檔寫作實例　177
4.6.5　故障處理文檔寫作要點　179
4.6.6　故障處理文檔常見問題　179
5　附錄　主題類型　183
5.1　概念(Concept)　184
5.2　任務(Task)　185
5.3　參考(Reference)　186
· · · · · · (收起)