《科技文檔寫作實(shí)務(wù)》以“理論+實(shí)戰(zhàn)”的方式，幫助讀者在短時(shí)間內(nèi)掌握科技文檔寫作要領(lǐng)，提高職場(chǎng)競(jìng)爭(zhēng)力。全書系統(tǒng)地闡述了技術(shù)文檔的概念、寫作流程、質(zhì)量要素及典型技術(shù)文檔的寫作方法。為了幫助讀者更好地掌握這些原理，《科技文檔寫作實(shí)務(wù)》針對(duì)實(shí)際工作中經(jīng)常使用到的需求說明書、概要設(shè)計(jì)、軟件模塊詳細(xì)設(shè)計(jì)、測(cè)試用例、使用指導(dǎo)和故障處理進(jìn)行專題介紹，從內(nèi)容框架、寫作過程、寫作實(shí)例、寫作要點(diǎn)和常見問題進(jìn)行了詳細(xì)說明。 《科技文檔寫作實(shí)務(wù)》既可作為產(chǎn)品研發(fā)和測(cè)試人員、售后支持人員及用戶文檔開發(fā)人員的培訓(xùn)參考用書，也可作為高等院校的教學(xué)用書。
結(jié)合大量案例進(jìn)行深入淺出的說明，既有綜合性描述又從正反案例進(jìn)行剖析，極具針對(duì)性和應(yīng)用性。中興通訊學(xué)院擁有業(yè)界先進(jìn)的文檔開發(fā)系統(tǒng)、流程和規(guī)范, 培養(yǎng)了國(guó)內(nèi)第一批技術(shù)文檔職業(yè)從業(yè)者，從事寫作的20余名文檔專家們是中興通訊學(xué)院從文檔寫作團(tuán)隊(duì)中遴選出來的文檔精英，沉淀了他們豐富的文檔寫作經(jīng)驗(yàn)。案例對(duì)讀者在科技論文寫作、企業(yè)工作中間有直接借鑒作用。
目 錄
1 概述篇 1
1.1 什么是技術(shù)文檔 2
1.1.1 技術(shù)文檔的定義 2
1.1.2 技術(shù)文檔的范疇 2
1.1.3 技術(shù)文檔的特征 4
1.1.4 技術(shù)文檔的多種形式 4
1.2 技術(shù)文檔寫作的國(guó)際國(guó)內(nèi)現(xiàn)狀 5
1.3 技術(shù)文檔寫作的重要意義 6
2 基礎(chǔ)篇 7
2.1 技術(shù)文檔寫作流程 8
2.1.1 需求分析 9
2.1.2 架構(gòu)設(shè)計(jì) 10 目 錄
1 概述篇 1
1.1 什么是技術(shù)文檔 2
1.1.1 技術(shù)文檔的定義 2
1.1.2 技術(shù)文檔的范疇 2
1.1.3 技術(shù)文檔的特征 4
1.1.4 技術(shù)文檔的多種形式 4
1.2 技術(shù)文檔寫作的國(guó)際國(guó)內(nèi)現(xiàn)狀 5
1.3 技術(shù)文檔寫作的重要意義 6
2 基礎(chǔ)篇 7
2.1 技術(shù)文檔寫作流程 8
2.1.1 需求分析 9
2.1.2 架構(gòu)設(shè)計(jì) 10
2.1.3 文檔寫作 10
2.1.4 質(zhì)量控制 11
2.1.5 文檔發(fā)布 12
2.1.6 文檔交付 12
2.1.7 文檔維護(hù) 12
2.2 需求分析 13
2.2.1 信息收集 13
2.2.2 簡(jiǎn)化歸類 15
2.2.3 分析需求 18
2.2.4 確定文檔開發(fā)任務(wù) 20
2.3 架構(gòu)設(shè)計(jì) 21
2.3.1 架構(gòu)前的準(zhǔn)備和學(xué)習(xí) 21
2.3.2 設(shè)計(jì)架構(gòu) 22
2.3.3 架構(gòu)檢查 25
2.4 文檔寫作 26
2.4.1 寫作的邏輯 26
2.4.2 寫作6步法 28
2.4.3 寫作黃金法則 28
2.5 質(zhì)量控制 31
2.5.1 質(zhì)量控制活動(dòng) 31
2.5.2 高質(zhì)量文檔三要素 34
3 進(jìn)階篇 37
3.1 實(shí)用性 38
3.1.1 安全第一 39
3.1.2 內(nèi)容準(zhǔn)確 41
3.1.3 面向任務(wù) 45
3.1.4 合理組織 49
3.1.5 內(nèi)容完整 58
3.2 可讀性 61
3.2.1 易讀 62
3.2.2 易理解 75
3.3 舒適性 85
3.3.1 文檔獲取便捷 86
3.3.2 內(nèi)容檢索高效 87
3.3.3 閱讀感受舒適 92
4 實(shí)戰(zhàn)篇 101
4.1 如何寫需求說明書 102
4.1.1 需求說明書簡(jiǎn)介 102
4.1.2 需求說明書內(nèi)容框架 102
4.1.3 需求說明書寫作流程 104
4.1.4 需求說明書寫作實(shí)例 106
4.1.5 需求說明書寫作要點(diǎn) 111
4.1.6 需求說明書常見問題 111
4.2 如何寫概要設(shè)計(jì)文檔 112
4.2.1 概要設(shè)計(jì)文檔簡(jiǎn)介 112
4.2.2 概要設(shè)計(jì)文檔內(nèi)容框架 113
4.2.3 概要設(shè)計(jì)文檔寫作流程 114
4.2.4 概要設(shè)計(jì)文檔寫作實(shí)例 117
4.2.5 概要設(shè)計(jì)文檔寫作要點(diǎn) 121
4.2.6 概要設(shè)計(jì)文檔常見問題 121
4.3 如何寫軟件模塊詳細(xì)設(shè)計(jì)文檔 123
4.3.1 軟件模塊詳細(xì)設(shè)計(jì)文檔簡(jiǎn)介 123
4.3.2 軟件模塊詳細(xì)設(shè)計(jì)文檔內(nèi)容框架 123
4.3.3 軟件模塊詳細(xì)設(shè)計(jì)文檔寫作流程 124
4.3.4 軟件模塊詳細(xì)設(shè)計(jì)文檔寫作方法 125
4.3.5 軟件模塊詳細(xì)設(shè)計(jì)文檔寫作要求 131
4.4 如何編寫測(cè)試用例 144
4.4.1 測(cè)試用例簡(jiǎn)介 144
4.4.2 測(cè)試用例內(nèi)容框架 144
4.4.3 測(cè)試用例寫作流程 146
4.4.4 測(cè)試用例寫作實(shí)例 148
4.4.5 測(cè)試用例寫作要點(diǎn) 152
4.4.6 測(cè)試用例常見問題 152
4.5 如何寫使用指導(dǎo)文檔 155
4.5.1 使用指導(dǎo)文檔簡(jiǎn)介 155
4.5.2 使用指導(dǎo)文檔內(nèi)容框架 155
4.5.3 使用指導(dǎo)文檔寫作流程 156
4.5.4 使用指導(dǎo)文檔寫作實(shí)例 157
4.5.5 使用指導(dǎo)文檔寫作要點(diǎn) 171
4.5.6 使用指導(dǎo)文檔常見問題 171
4.6 如何寫故障處理文檔 173
4.6.1 故障處理文檔簡(jiǎn)介 173
4.6.2 故障處理文檔內(nèi)容框架 173
4.6.3 故障處理文檔寫作流程 174
4.6.4 故障處理文檔寫作實(shí)例 177
4.6.5 故障處理文檔寫作要點(diǎn) 179
4.6.6 故障處理文檔常見問題 179
5 附錄 主題類型 183
5.1 概念(Concept) 184
5.2 任務(wù)(Task) 185
5.3 參考(Reference) 186
書單推薦
![[超]文章法](/uploadfile/o_images/2014059051328841_1.jpg)
