-
>
宇宙、量子和人類心靈
-
>
氣候文明史
-
>
南極100天
-
>
考研數學專題練1200題
-
>
希格斯:“上帝粒子”的發明與發現
-
>
神農架疊層石:10多億年前遠古海洋微生物建造的大堡礁
-
>
聲音簡史
科技文檔寫作實務 版權信息
- ISBN:9787115320742
- 條形碼:9787115320742 ; 978-7-115-32074-2
- 裝幀:一般膠版紙
- 冊數:暫無
- 重量:暫無
- 所屬分類:>
科技文檔寫作實務 本書特色
結合大量案例進行深入淺出的說明,既有綜合性描述又從正反案例進行剖析,具有針對性和應用性。 中興通訊學院擁有業界先進的文檔開發系統、流程和規范, 培養了國內一批技術文檔職業從業者,從事寫作的20余名文檔專家們是中興通訊學院從文檔寫作團隊中遴選出來的文檔精英,沉淀了他們豐富的文檔寫作經驗。 案例對讀者在科技論文寫作、企業工作中間有直接借鑒作用。
科技文檔寫作實務 內容簡介
《科技文檔寫作實務》以“理論+實戰”的方式,幫助讀者在短時間內掌握科技文檔寫作要領,提高職場競爭力。全書系統地闡述了技術文檔的概念、寫作流程、質量要素及技術文檔的寫作方法。為了幫助讀者更好地掌握這些原理,《科技文檔寫作實務》針對實際工作中經常使用到的需求說明書、概要設計、軟件模塊詳細設計、測試用例、使用指導和故障處理進行專題介紹,從內容框架、寫作過程、寫作實例、寫作要點和常見問題進行了詳細說明。 《科技文檔寫作實務》既可作為產品研發和測試人員、售后支持人員及用戶文檔開發人員的培訓參考用書,也可作為高等院校的教學用書。
科技文檔寫作實務 目錄
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
科技文檔寫作實務 作者簡介
國家體育總局青少年體育司是國家體育總局直屬單位,其主要職責是指導和推進青少年體育工作,擬訂青少年體育工作的有關政策、規章、制度和發展規劃草案,指導和推動青少年體育服務體系建設和指導開展青少年體育工作研究和相關培訓等。 國家體育總局體育科學研究所是國家體育總局直屬、科技部保留和發展的***、多學科、綜合性的社會公益類體育科研事業單位,其主要任務是引領和推動我國體育科技事業發展,把握國際體育科學前沿領域和未來體育事業發展中的重大科技問題,以國民體質監測和健身方法研究、優秀運動員競技能力研究、體育政策研究、體育工程技術研究等領域為主要方向開展基礎研究和應用研究,為我國群眾體育、競技體育和體育產業的可持續發展及提高國際競爭力提供科技支持和服務。
- >
姑媽的寶刀
- >
苦雨齋序跋文-周作人自編集
- >
我與地壇
- >
莉莉和章魚
- >
大紅狗在馬戲團-大紅狗克里弗-助人
- >
名家帶你讀魯迅:故事新編
- >
李白與唐代文化
- >
回憶愛瑪儂