如何寫好一篇技術文章?

已禁用發表於2017-10-20

本文主要針對想在掘金等技術社群公開發表文章的同學,面向個人寫作的筆記等內容不在本文討論範圍內。同時,我認為面向個人寫作的任何東西都不宜在社群公開。

選擇合理的內容
技術那麼多,到底哪種適合寫哪種不適合寫?

常見的適合成文的內容有:

  • 新出現的技術
  • 工程中解決問題的方法
  • 高深問題的剖析
  • 被大多數人忽略的重要細節

文章內容的範圍不宜過大,寫大而全的東西對作者的水平要求非常高且需要消耗大量精力。如果真想寫,也請先把思路理清,與有經驗的人交流之後再下筆。

一個小技巧是:在寫文章之前,先把自己想寫的主題用搜尋引擎中搜一下,考慮自己是否有信心有能力超過已有文章。如果沒有相關文章,那麼可以先寫入門級的內容,根據社群反饋逐步深入。

確保內容的準確性

自己挑選的寫作內容多是自己摸透了的東西,但是在細節上可能有模糊不清的地方。注意,你模糊不清的地方也正是許多人看此文的動機,務必查閱文獻將此處敘述清楚!但又不可沉溺於細節之中,以能講明白上下文為宜(更深入的細節適合另起一文)。另外,類似選型、對比、趨勢一類的文章,對行業整體的把握也非常重要,在表達自己的觀點之前,應該充分了解其它人的看法,尤其是和自己觀點相左的看法。

寫作手法

技術文章的一大特點是文章邏輯嚴密,層級分明。因此在寫作之前,應先列好提綱,根據內容層級由淺入深。

大部分技術知識可以用程式碼講清楚,那麼此處務必貼出程式碼。程式碼應該結構清晰,邏輯簡單,能講清楚問題就好了。一些關鍵程式碼需要有清晰的註釋。如果有 demo,可以放上 demo 的連結。

文章第一段應該交代清楚文章的受眾以及所需的前序知識。最好能用 2~3 句話對文章所要表述的內容進行概括。

文章的遣詞造句也很重要,在深入敘述細節之前,宜先主動丟擲一個問題。比如接下來要講矩陣相關知識,就可以提問:什麼是矩陣呢?然後再對矩陣做出介紹。這樣可以引導讀者思考,跟上作者的寫作思維。

在對高深內容或者細節進行描述時,即使前文已對相關名詞做出瞭解釋,也不應該堆砌專有名詞。儘量用白話或者類比的形式將問題解釋清楚,文字敘述不清楚的地方,請作圖。

版面

相信大部分技術人都有輕度潔癖,所以版面的整齊和縮排無需多言。提幾點會讓版面看起來清爽的建議:

  • 將“ ”替換為「 」
  • 英文與中文之間空一格。比如 juejin.im 這樣的形式。
  • 段與段之間空一行
  • 程式碼塊務必渲染。

標題

UC 式的標題的確可以吸引人,但是技術文章的受眾是長期活躍在網際網路上的人,對震驚體早已有抵抗力。不如務實一些,讓讀者能根據標題就對文章要講什麼有大概的瞭解。短期看損失了閱讀量,但從長遠來看,是樹立個人品牌的好辦法。

總結

總的來說,一篇優秀的技術文需要有

  • 簡潔樸實的標題
  • 不易重複的內容
  • 內容表述準確
  • 細節描述清析
  • 良好的格式和排版

成文之後,須通讀一遍文章。將自己代入讀者的思維,邊讀邊考慮在沒有為寫作本文而學習的知識的前提下,能否讀懂文章。

寫文章是個非常消耗腦力、體力和時間的事情,在動筆之前,Think Twice ~

另外,在掘金寫文章可以換百元好書

感謝:@守候你 @zw.will @sunshine小小倩 @zimo @axuebin @天方夜 @染陌 對本文的建議。

相關文章