技術寫作和繪畫

09-06

技術寫作和繪畫

來自專欄重構經濟學1 人贊了文章

Peter 從事技術寫作有幾年了，總是會思考的一個問題是，技術文章到底區別於官方文檔的價值在哪裡？官方文檔的特點是精準詳細，但是術語多難看懂，而技術文章要做到的就是跟講故事一樣，讓聽眾一遍就懂，輕鬆快速的學會知識。本文的主體內容就是我自己的技術寫作的一些心法，跟繪畫有很多相通的地方，因為二者都是表達的藝術。

要有靈魂

我反對技術文章就是乾貨的堆疊，我認為一篇文章最重要的是要有中心，就像一幅繪畫作品要有靈魂。但是不是說有中心了，就有靈魂了。技術文章的起筆前，一定是我自己讀了很多資料，頓悟了一個點，這樣才有了可分享的價值。如果沒有頓悟，我就不寫文章，隨便記下幾行筆記就完了，如果頓悟了多個點，那就寫多篇文章，不寫到一篇中。那具體怎麼執行呢？

首先就是要選定角度。世界上任何事物都是多面的，一個技術其實是可以從很多方面去聊的，如果面面俱到就是文檔，不是文章了。哪個角度能讓讀者去把握這個知識點的最關鍵思想，就非常體現一個作者的品味和見識，也是技術寫作最吸引人的地方。就像畫一幅人像，首先需要要讓模特擺一個最美的角度。文章一旦選定角度就要全文貫徹下來，不然內容就寫散了，讀者就容易迷惑。

角度有了，還要選擇焦點。一個技術的知識點肯定很多，也要有取捨的去講。要選出最能支撐起靈魂的幾個點來展開文章的內容。同時，我想強調的是，焦點部分當然要仔細描繪，但是其他局部細節越簡略越好，原則是離焦點越遠的內容越簡略。就像你去繪畫，重點是要描繪一個人的憂鬱的眼神，那麼離眼睛越遠的部分越簡略越好。如果這幅作品中你發現這個人頭髮也很漂亮，然後就細緻的畫了頭髮，那就喧賓奪主，整個畫面看起來會很俗氣。

總之，文章和繪畫一樣就是要有靈魂，角度選擇越正確，文章價值就越大，而所有焦點的選擇都是服務靈魂的，所有細節的展開都要圍繞焦點。偏離主題的內容越多，讀者就會越走神，越難把握作者的意思。

著力烘托

所以說不必要的細節越少越好，但是對於重點內容就剛好相反，一定要講透徹。是陰影讓物體變得更立體，所以重點的突出，離不開合理的烘托。

如果是寫一本書，那麼每篇文章的標題都是為了烘托這一章的靈魂和中心。每一章的標題，都要烘托這本書的靈魂。到一篇文章內部，內容的展開當然是要烘托本文的中心。一般一篇文章我會拆分成幾個小知識點來講解，每個知識點盡量是層層遞進的關係，每個知識點形成一個二級標題。每個二級標題內部，要提出幾個言之有物的論點或者概念，這個就像我們畫畫的時候要有線條。如果我找不到明確的線條，說明我對這個話題根本沒有理解，任何概念如果不能用一句話說的很清楚，就證明我還需要繼續查資料，繼續理解。

線條有了，下一步就是要渲染。可以用類比來讓晦澀的概念變得好懂，例如用一棵樹來類比文件系統結構。可以舉例子讓概念變得生動，比如說某某項目中就用到了這個知識點。也可以指出常見的理解誤區，來限定一下概念的範圍。另外很重要的一點，就是要對定義概念過程中的引出的其他生僻概念再做出適當的解釋，保證讀者能跟上的思路。這個地方還是需要特別注意的，講的太少讀者不理解，講的太多心就會跑題。我自己的做法是，拓展性的知識點一定要略講，保證正確就可以了，不必精確。

烘托，是官方文檔上一般沒有的技巧，但是也正是這些，讓文章凸顯出了高於文檔的價值。根據資訊理論原理，冗餘信息越多，傳播效率就越高，因為傳播過程中的抗噪能力高了。

感情充沛

最後一點我想強調的就是寫作的時候是要有感情的。表達本身是人和人之間的交流，所以感情因素就肯定不能忽視。如果作者不能做到真正在意讀者，體會他們的困難和需求，就肯定寫不出合格的文章。

簡單點說就是要有服務心態，不是寫自己想寫的，而是要寫讓別人有收穫的。文字的目的不是炫耀自己的能力，而是要讓讀者聽懂。所以，我自己寫完文章之後，會仔細的看看全篇的內容是不是能夠形成一個一氣呵成的故事，整個的結構如果能環環相扣就能很好的鎖定讀者的注意力。文字流淌的過程中也要用各種技巧達成理解上的通暢，比喻，排比，重複，轉折，這些文學上的技巧其實都可以用一些，保證自己的文字是有溫度的，增加帶入感。所以我寫文章的時候，會想像有一個好朋友坐在我身邊聽我講這個技術，於是我會隨時在意，自己有沒有用最自然的語言來表達，有沒有地方跳躍過於急促，有沒有地方單位內容內的新概念過於密集，讓讀者即使能聽懂，也會覺得非常急促和不舒服。

感情充沛，人文關懷。引用邏輯思維的羅振宇的一句話：死磕自己，愉悅大家。

總結

這篇中談寫作心法。最想表達給大家的中心是：技術文章也是文章，要有清晰的中心，要有明確的間架結構，也要有行文技巧。乾貨當然要干，但是不講究表達技巧的文章，讀者啃起來吃力，時間也就浪費了。我寫寫作技巧的文章還有一篇，大家搜《我的即興寫作技巧》就可以在簡書上搜到那篇文章，主要講操作步驟，跟本文互補。