天天看點

如何寫出高品質的技術文章

如何寫出高品質的技術文章

作者 | 張建飛

來源 |

阿裡技術公衆号

對于一個從小不喜歡國文、不喜歡閱讀、作文很少及格的理科生來說,做夢也沒想到,有一天我會寫一篇文章教人如何寫文章:)

一 為什麼要寫文章

懂了,不一定能說出來,說的出來,不一定能寫出來。這就是寫文章最大的好處,官方術語叫“費曼教學法”。寫文章是一個逼迫自己深入了解問題、把問題想清楚,整理好思路,并能清晰表達出來的過程。其本質是一種自我學習、自我提升、建構知識體系的最佳方法。

除此之外,寫文章還有一個副産品——幫助我們擴大影響力。就拿我來說,我大概是在4年前,開始有規劃地搭建自己的知識體系,包括閱讀、記筆記、寫文章、分享。

在這期間,我連續3年獲得最佳年度作者,上頭條的文章也不少。另外,阿裡技術公衆号,也發表了我10篇左右的文章,其中有2篇入選了創刊最佳文章,很多篇文章都有3萬+閱讀的不錯表現。

基于這些總結沉澱,我在人民郵電出版社出版了一本書《代碼精進之路:從碼農到工匠》,我本人也憑借本書獲得了人郵IT類年度最佳作者。

二 什麼是好的技術文章

關于優質文章的标準,有一個對好文章的判斷是:“文章架構完整、思考深入清晰、正文至少80%以上為原創技術幹貨。”這引起了不少的争議。

有争議很正常,沒有争議才奇怪呢,好的技術文章,就和好的技術績效一樣,主觀性太強......很難有一個客觀标準。

如果硬要對文章品質進行量化的話,有些名額可能有幫助。 比如文章的浏覽量、點贊數、評論數、收藏數等名額。有用,但也隻是參考作用,最後還是需要人的評判。

是以抛開這些因素不看,我認為好的技術文章至少應該滿足兩個條件:

  • 一個是要傳達有價值的資訊。
  • 另一個是要結構和邏輯清晰,具備一定可讀性和可了解性。

在此基礎之上,如果能做到有文采、夠風趣那就更好了。

三 如何寫好技術文章

内容有用

一篇好文章,一本好書,最重要的是要讓讀者有獲得感,要對讀者有用,要言之有物。

這裡的“物”可大可小,不一定非要是一個很大的命題,恰恰相反,一篇文章的篇幅有限,能把一件“小事情”說清楚就已經很不錯了。

我曾經發表過一篇文章——《阿裡縮寫和專業術語大全》,做的事情很簡單,就是把我在阿裡碰到的縮寫全都整理成冊。就這麼一篇“小文章”,卻成了我最火的一篇文章,有将近100K的閱讀,3K的點贊。

為什麼大家會如此關注這篇沒有“技術含量”的文章?很簡單,很多人都有好奇心,大家都希望了解縮寫背後的全稱和來曆,這正是這篇文章的價值所在。

類似的,像雲原生技術介紹、前端技術體系大全、新人入職手冊、《馬總演講集》等都屬于這種資訊整合類的文章。

除此之外,那些有自己技術見解和思考,敢說真話的文章,也會受到大家的歡迎。

比如,我覺得很多技術團隊不應該有架構師這個崗位,是以寫了《人人都是架構師:架構是一種能力,不是title!》。我覺得很多的軟體複雜度來自于工程師的亂作為,比如濫用流程引擎,治理複雜度的根本是抽象思維和結構化思維,于是寫了《一文教會你如何寫複雜業務代碼》。

這些文章之是以受到歡迎,是因為引起了很多同學的共鳴,對他們有幫助。

結構清晰

有了好的内容,還要注意文章的結構。就像一道菜,要講究色香味俱全,即使有了最好的食材,但是做出來的樣子一團糟,也會影響食欲,稱不上是一道好菜。

關于結構,我推薦你去看一本書——《金字塔原理》,我本人也寫過不少關于結構化思維的文章。金字塔原理教導我們在寫作、表達的時候,要建構清晰的結構。

如何寫出高品質的技術文章

對于一篇文章來說,金字塔的頂點是中心論點——通常就是文章的标題。圍繞着這個中心論點,我們可以用多個觀點去支撐中心論點,如果表達的内容很多,觀點還可以進一步往下細分。形成一個“以上統下、邏輯遞進”的金字塔結構。

通過這種形式寫出的文章,就會顯得邏輯清晰,結構緊湊。

對于技術文章來說,我們可以考慮使用3W2H模型來幫助我們建構結構。比如我要寫一篇關于抽象能力的文章,就可以通過以下角度去說:

  1. What:什麼是抽象;
  2. Why:抽象為什麼重要;
  3. How:如何進行抽象;
  4. Where:抽象可以用在什麼地方;
  5. How much:抽象到什麼程度;

同樣,我現在正在寫的這篇文章,我也是通過這種方式來搭建結構的:

如何寫出高品質的技術文章

刻意練習

開篇說過了,我以前沒有寫作的習慣,小時候國文作文也經常不及格。後面竟然出版了自己的書,說明寫作作為一項技能,是可以習得的,是可以通過練習提高的。

因為寫的多了,練習的多了,水準自然就會提高。然而,所謂的《刻意練習》(也是一本書),不是簡單地重複,而是要給自己階段性的設定更高的目标,這樣才會持續地進步。

比如,我現在已經能比較流暢地寫作,我就會去追求如何把文章寫的更加引人入勝。在《風格感覺:21世紀寫作指南》裡面提到一篇文章,它的開頭是這樣寫的:“我們都會死,我們是幸運的...”,像這種沖突感和懸念,就會很自然地吸引讀者繼續閱讀下去。

我這篇文章也借用了同樣的手法 :)

疊代優化

寫文章和寫代碼有非常多相似的地方。我會經常拿寫文章和寫代碼做類比。比如,文章和代碼都需要結構清晰。又如,好的系統不是設計出來的,是疊代出來的。好的文章也是如此,需要不斷的打磨、修改,我的很多文章都是經過多次修改,重新編排結構,補充删除資訊,調整措詞,直到我覺得滿意為止。

就拿現在這篇文章來說,也是修改了好幾版,第一遍的時候内容很散點,結構也不清晰,有點糾結,不知道要如何寫下去,後面想到一個“以身作則”的方法,即這篇文章本身應該就可以作為一個sample來介紹如何寫文章。帶着這個思路,疊代幾次之後,就逐漸成了一篇像樣的文章了。

是以,重要的是要敢于去“動筆”,不要擔心一開始的粗枝大葉,萬事開頭難,寫着...寫着... 你就有感覺了。