文章整理自：

掘金YoungZ 、Github ruanyf、知乎 敖天羽

很多開發者都喜歡在各類社群平臺分享一些寫作內容，一方面可以對人生的一些經歷進行記錄，同時將開發中的經驗總結分享給其他人。當然寫作本身益處也是不少的，不僅能鍛鍊邏輯思維能力，還能訓練日益退化的語言表達能力，個人影響力上也能夠達到一定的傳播積累。

但更多的開發者會問，文章到底怎麼寫？什麼的樣的文章可以得到別人的認可與喜愛？

在寫一篇文章之前，先想清楚以下幾個問題：

• 這篇文章是寫給誰看的？

• 這篇文章主要講些什麼?

• 文章具體怎麼寫？

給誰看

首先分析文章會給誰看，有了目標使用者，你才知道需要產出一篇怎麼樣的文章。

比如，你的目標是小白使用者，他們可能連 Node.js 都沒有安裝過，你上來就讓他們配個 webpack 以達到什麼目的，這多半是沒什麼指望了，你就得先告訴他們如何去安裝 Node.js。

但如果你的文章面向的是更深層次的探討和分析，為了這部分小白使用者去增加篇幅大可不必，只會讓那些中高階程式設計師覺得這篇文章廢話連篇，原本的價值大打折扣。

實際上，一篇文章不可能面面俱到，所謂《從入門到精通系列》，即使是書，都是為了照顧新入門的準開發者們從零基礎開始的，涵蓋不了精通所需的很多東西。

寫什麼

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

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

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

怎麼寫

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

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

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

版面規範補充

字間距：全形中文字元與半形英文字元之間，應有一個半形空格。

錯誤：本文介紹如何快速啟動Windows系統。

正確：本文介紹如何快速啟動 Windows 系統。

全形中文字元與半形阿拉伯數字之間，有沒有半形空格都可，但必須保證風格統一，不能兩種風格混雜。

正確：2011年5月15日，我訂購了5檯筆記本電腦與10臺平板電腦。

正確：2011 年 5 月 15 日，我訂購了 5 檯筆記本電腦與 10 臺平板電腦。

半形的百分號，視同阿拉伯數字。

英文單位若不翻譯，單位前的阿拉伯數字與單位間不留空格。

錯誤：一部容量為 16 GB 的智慧手機

正確：一部容量為 16GB 的智慧手機

半形英文字元和半形阿拉伯數字，與全形標點符號之間不留空格。

錯誤：他的電腦是 MacBook Air 。

正確：他的電腦是 MacBook Air。

文章句子，不包含任何標點符號的單個句子，或者以逗號分隔的句子構件，長度儘量保持在 20 個字以內；20～29 個字的句子，可以接受；30～39 個字的句子，語義必須明確，才能接受；多於 40 個字的句子，在任何情況下都不能接受。

避免使用長句。句子內部不使用逗號時，總長度不應該超過 40 個字；使用逗號時，總長度不應該超過 100 字或者正文的 3 行。

儘量使用簡單句和並列句，避免使用複合句。

表示中文時，英文省略號（…）應改為中文省略號（……）。

英文：5 minutes later…

中文：5 分鐘過去了……

英文書名或電影名改用中文表達時，雙引號應改為書名號。

英文：He published an article entitled "The Future of the Aviation".

中文：他發表了一篇名為《航空業的未來》的文章。

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

•  取好標題，醒目突出中心

•  圖文並茂，適當配圖說明

•  篇幅適宜，不宜過短也避免冗長

•  格式統一，基本排版規則需要遵守

•  細節處理，錯別字標點處理正確

LeanCloud正在發起線上徵文活動，詳情請點選活動海報  ↓ ↓ ↓

end

LeanCloud，領先的 BaaS 提供商，為移動開發提供強有力的後端支援。更多內容請關注「 LeanCloud 通訊」