工程學寫作指南

中文版總序
英文版總序
前言
第一章 定義工程學寫作的目的與讀者
工程師們為什麼寫作
工程學寫作能做什麼
用於分析的寫作
用於建議或提案的寫作
用於控制的寫作
讀者如何影響寫作的目的
瞭解讀者想要什麼
對讀者進行概念化
將我們的讀者和寫作目的結合起來

第二章 構建工程論證
工程論證的“五個公理”
任何主張都不是天然成立的
為主張找到依據
做出主張
提供理由和證據
在結論之前添加限制
關注可能的反面主張
總結：主張的所有組成部分
主張先行的論證最有力
什麼情況下適合總結性論證
讓主張先行變得自然
對數據的闡釋比分析更有價值
邏輯雖好，但不能獨善其身
為Ethos投資
負責任地使用情緒
理性、情感、信任
遵循常見模式的論證比結構獨特的論證更有說服力
問題—解決方案
比較和對照
成因—效果
定義和描述
使用這些模式來考慮問題
分析一位工程師的論證
搜集論證依據
建立主張
用理由和證據來支持主張
對論證做出限制
考慮反面主張
從例子中學習
將這五個公理運用在你的寫作中

第三章 使用視覺元素進行報告的策略
將視覺元素與文檔文本關聯起來
利用人類視覺感知進行視覺元素設計
選擇表格、圖形還是示意圖
表格：讓數據可視化且有意義
有效表格的例子
圖形和圖表：讓趨勢和模式可視化
製作圖形的四個注意事項
來自工業領域和學校的示例圖
示意圖：展現細節
設計圖紙和概念草圖的案例
建模輸出和照片的案例
製作視覺元素的啟發式方法

第四章 撰寫設計報告的策略
設計報告的邏輯結構
分階段撰寫設計報告
階段0 ：定好標題以表明主題和解決方案
階段1 ：撰寫引言以幫助讀者理解框架
階段2 ：定義問題以為解決方案做準備
階段3 ：定義需求
階段4 ：描述設計以解釋解決方案的細節
階段5 ：評估設計或解決方案
階段6 ：為下一步提出建議
階段7 ：用執行摘要來收尾
關於撰寫設計報告的最終建議

第五章 撰寫實驗報告、文獻綜述和海報的策略
撰寫實驗報告
引入假設和理論
解釋方法
呈現結果
討論重要意義
實驗報告中的結論
摘要：學術性的總結
比較實驗報告和設計報告
文獻綜述
總結綜合法
“整合論證”法
將文獻綜述應用於參考設計
展示海報
吸引注意力
創建直觀的閱讀路徑
準備社交媒體/摘要/故事版本
讓內容模塊化
最小化干擾
使用這些文體的最後思考

第六章 撰寫專利檢索、用例場景、代碼注釋和技術說明的策略
專利檢索和專利申請
瞭解專利
用例場景
代碼注釋
技術說明
使用支持性的文體

第七章 開發可讀性強的風格
建立強有力的段落
確保強有力的引子
保持聚焦
實現優美的排列
整合段落
提升寫作的流暢性
構建過渡
用並列連詞將內容連接在一起
用從屬連詞建立從屬關係
用連接副詞建立複雜關係
用關聯詞平衡強調的內容
回顧“過渡”這一步
從已知到新知
讓“從已知到新知”發揮作用
強化句子
使用主語—謂語—賓語的邏輯
提升動詞
在寫作中使用數學符號
發展你的寫作風格

第八章 管理文獻資源
工程師如何進行引用
像工程師一樣在寫作中精練和聚焦資源
如何進行總結概述
從總結概述到精練壓縮
創建引注和參考文獻
IEEE，一種編號式的文獻引用系統
引注
參考文獻列表
確保信息的可追溯性
致謝
附錄：制定寫作和修改的流程
注釋
參考文獻
索引