行文規範，文章百贊 | 得到推薦的六個要點

「本文已參與好文召集令活動，點擊查看：後端、大前端雙賽道投稿，2萬元獎池等你挑戰！」

讀書須用意，一字值千金。

6月30日晚，聽了美女編輯 @大茹 主講的掘金寫做直播課，結合着閱讀官方小冊，收穫滿滿，將相關規範總結成了如下六個要點：

• 文章類型
• 讀者定位
• 主題與邊界
• 結構與銜接
• 論據充分
• 排版優雅

但願本身每次發佈文章前，都能按照規範清單，校訂覈對，提升質量，使其更清晰優美，更暢通地技術交流，給讀者提供更好的閱讀體驗！

寫做審查規範

歡迎評論區交流補充！

文章類型

屬於傳授知識、闡述經驗、表達觀點？

知識

文章屬哪一個領域：前端，後端，該領域前沿在解決什麼問題？最好是配圖說明。

例如，「闡述ArrayList與LinkedList不一樣」，搭配Java的集合類圖，會顯得脈絡清晰，考慮全面，讀者視野也更開闊。

經驗

踩過坑 OR 秀智商？

踩坑的詳細過程：項目從需求->開發->交付->維護，哪一個階段出了問題？損失如何？如何避免，除了問題後續又是如何彌補的？

秀你的算法/方案/代碼：解決了問題亦或避免了問題的發生？

如「混合支付如何保證付款、退款的一致性」，能夠闡述未保證一致性狀況下發生了什麼問題？錯誤的訂單後續又是如何處理避免損失的？

與離散的注意事項相比，一個完整的解決方案更有收藏價值！

觀點

大衆或某類人的觀點是怎樣的？

信息差？缺乏哪些關鍵信息，才獲得如此的觀點，片面/侷限/錯誤，亦或缺乏角度/態度？

或在補充了文章的關鍵信息後，便可獲得文中結論？

固然，也可根據其餘信息，從另外的側面佐證大衆觀點。

好比前些天的雲原生大會，能夠收集資料與實驗，去試圖證實「Quarkus在雲原生領域比Springboot更有優點和發展前景」，也能夠去反證「Spring在雲原生領域也將一統江湖」。

讀者定位

外行/初學者/學生/編程人員/架構師/項目經理/你的老闆/你的同事？

針對你的讀者羣：

讀者痛點

該文可輔助讀者解決什麼問題，帶來何種效益？

(1) 填補容易遺漏/遺忘的知識點？

(2) 能升職加薪？進入大廠，迎娶白富美？

(3) 是能節省時間，提升效率的快捷工具？

(4) 總結/彙總性質，幫助讀者理清領域問題？

(5) 給讀者補充信息，表達不一樣的觀點/經驗/維度？

(6) ...

文章主題與邊界

講什麼，不講什麼

可否用一句話概述核心？且其與標題、開頭與讀者預期是否一致？

要作標題黨

固然，並非起那種語不驚人死不休的（具體參考各手機瀏覽器小文章），而是讓你們經過標題，清晰的給文章主題劃定界限。

小冊中講，選題就是「定義問題」的過程，尋找你與讀者之間的認知差異。換句話說，文章的全部內容都應圍繞「選題」，聚焦題目，分清主次，切忌喧賓奪主，不能作羅丹的雕塑手【我問了一下週圍的人，好多不知道「羅丹砍手」這一典故】。

對於其餘略有相關的內容，能夠經過「這裏我額外說一下……」管理讀者預期。【小冊】

並列出了幾種掘金文章選題：

• 技術細節型
• 乾貨型：如介紹開源軟件。
• 翻譯文章，如翻譯英文的技術文章
• 實踐總結型
• 行業看法，職業選擇

注重開頭

文章開頭是否能看出全文主旨、解決的問題、你的觀點？

好的開始是成功的一半。

在網絡上找到一些文章開頭寫法，雖然不滿是技術文章相關，但但願對本身，對讀者有所啓發：

• 開門見山
• 提示中心
• 描寫引入
• 設置懸念（反問、設問、疑問）
• 對比
• 故事導入
• 名人名句引入
• 背景介紹
• 倒敘
• 形象比喻式開頭
• 抒發感情式開頭
• 交代緣由式開頭
• 夢幻幻想式開頭
• 心語訴說式開頭
• 與讀者交談式開頭

結構與銜接

結構

文章結構是橫向平鋪、縱向遞進、總分、總分總？

• 是否有清晰的層次？
• 側重點是什麼？
• 是如何從總體到局部，從局部到細節推動的？

最好的技術文章當屬論文。通常說來，論文的結構框架大體分爲：文摘、引言、正文、結論、參考文獻。能夠給技術文章一些啓發。

銜接

包括邏輯的銜接，語感的銜接。

邏輯的銜接，即A是否能推導出B？或每一個段落的行文理由、主旨關聯是怎樣的？

例如，「想要理解XXX，需先了解其是如何發展至今的？」，就給出了爲何要闡述事物的發展歷史與背景。

語感的銜接，即與大多數人的閱讀習慣是否一致。最基本的句子「口感」通順嗎？長句子是否很容易理解？大多數人看好文章看不出來，可是壞文章很容易感受出來。

短句比長句好

論據充分

百字不如一圖。說中國發展最好的證據即是GDP曲線圖。說股票漲跌起起伏伏也不如貼一張價格曲線圖。

論據包括：真實的數據（圖、表），案例？，也能夠是實驗的關鍵代碼及其執行結果？

表：實驗結果/參考數據

圖：框架圖、路線圖、思惟導圖、設計圖、流程圖、調用圖、時序圖、實驗截圖/gif？

排版優雅

排版見仁見智吧！最基礎的目錄清晰，易於查找，符合邏輯吧。

好比下面的兩種排版：

有人喜歡簡約，有人喜歡動畫。

如下是小冊中概述的文章注意事項原文：

有沒有明確交代要講什麼問題的開頭；

小標題間符不符合縱向或橫向的關係；

內容是否是先總體再具體；

文章結構是否能夠抽象和拓展。

總結

內容具體，論據輔助，邏輯恰當，語句通順

寫做服務他人，啓發本身。寫做的惟一技巧就是「一直寫」，高中最喜歡的一句英文：

Practice Makes Perfect

最後，祝你們

文章天成，妙手常得。

歡迎點贊評論！