如何寫好一篇技術文章？

本文主要針對想在掘金等技術社區公開發表文章的同窗，面向我的寫做的筆記等內容不在本文討論範圍內。同時，我認爲面向我的寫做的任何東西都不宜在社區公開。

選擇合理的內容
技術那麼多，到底哪一種適合寫哪一種不適合寫？

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

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

文章內容的範圍不宜過大，寫大而全的東西對做者的水平要求很是高且須要消耗大量精力。若是真想寫，也請先把思路理清，與有經驗的人交流以後再下筆。

一個小技巧是：在寫文章以前，先把本身想寫的主題用搜索引擎中搜一下，考慮本身是否有信心有能力超過已有文章。若是沒有相關文章，那麼能夠先寫入門級的內容，根據社區反饋逐步深刻。

確保內容的準確性

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

寫做手法

技術文章的一大特色是文章邏輯嚴密，層級分明。所以在寫做以前，應先列好提綱，根據內容層級由淺入深。

大部分技術知識能夠用代碼講清楚，那麼此處務必貼出代碼。代碼應該結構清晰，邏輯簡單，能講清楚問題就行了。一些關鍵代碼須要有清晰的註釋。若是有 demo，能夠放上 demo 的連接。

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

文章的遣詞造句也很重要，在深刻敘述細節以前，宜先主動拋出一個問題。好比接下來要講矩陣相關知識，就能夠提問：什麼是矩陣呢？而後再對矩陣作出介紹。這樣能夠引導讀者思考，跟上做者的寫做思惟。

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

版面

相信大部分技術人都有輕度潔癖，因此版面的整齊和縮進無需多言。提幾點會讓版面看起來清爽的建議：

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

標題

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

總結

總的來講，一篇優秀的技術文須要有

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

成文以後，須通讀一遍文章。將本身代入讀者的思惟，邊讀邊考慮在沒有爲寫做本文而學習的知識的前提下，可否讀懂文章。

寫文章是個很是消耗腦力、體力和時間的事情，在動筆以前，Think Twice ~

另外，在掘金寫文章能夠換百元好書。

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