一篇技術文章合格的標準

原文地址

前言

做爲一個開發者，常常須要在網上查找各類資料，可是一個讓人倍受打擊的事實是，如今網上的大多數文章質量都太糟糕。行文混亂，觀點不清，結構失調，甚至有些都不能算是一篇真正的文章。做爲一個有正確價值觀的人，我以爲應該本身創建一個博客，寫一些質量相對較高的文章（固然是自認爲）來提高國內互聯網內容的質量。理所固然，任何人都有對這些文章中觀點懷疑和評論的權利，我也很願意針對本身認爲有意義的評論進行討論。

筆者認爲一篇合格的文章應該遵循如下原則。

非轉載

沒有任何修改，直接粘貼複製別人的文章到本身的博客。這種行爲惟一產生的意義就是浪費了互聯網上大量的硬盤空間。這種東西（是的，它們不能稱之爲文章）沒有任何新的知識和觀點，不會對互聯網作出絲毫建設性的貢獻。

有些人會說，我將這些文章放到個人博客，能夠記錄本身的學習軌跡，對本身是一個激勵，而且我能夠隨時參考這些文章。若是是這樣，那麼你應該認識到一點，絕大多數的網站都有收藏功能，即使沒有，你也可以很容易的找到相似pocket的網絡資源收藏工具。

根據非轉載原則，筆者認爲，csdn博客撰寫頁面上的那個原創和轉載選項是一個充滿負能量、毫無正面意義的垃圾功能。網絡上的任何資源都應該是原創的。

結構完整

任何一篇文章都應該擁有完整的結構。詩、詞做爲文學做品中最精簡的體裁，也會包括起、承、轉、合的簡約架構。體量比詩詞更大的文章（普通技術文章、散文、雜文、論文）更須要良好的結構來支撐。沒有一個說的過去的結構，文章就很難站起來，就是人心渙散，沒有精神。這樣的文章看起來沒有任何節奏，對讀者來講是一種耐心的挑戰。

一篇文章的結構最低的要求是完整。尤爲是技術文章，結構並不要求精巧，可是必須是完整的。你能夠寫地詳細也能夠寫地籠統，可是不能寫的不完整。

觀點或主題

觀點是寫文章的動機，一篇文章不可能沒有觀點就直接寫出來。對於技術文章來講，觀點可能就是一個具體的知識點。可是，一旦主題肯定，文章中任何內容都必須爲主題服務。避免沒必要要的、和主題無關的內容出如今文章中是明智的選擇。而且，文章中的全部段落都應該爲主題進行合理的安排。

案例

對於說明觀點來講，舉例是很好的方式，好的文章應該儘可能包含合理、貼切的案例。記得早些時候看過錢鍾書先生的一些文章，好比《圍城》《寫在人生的邊上》，文章中的比喻用的恰到好處，爲觀點進行了簡單、巧妙的詮釋。甚至連「寫在人生的邊」上這個標題都是一個絕妙的比擬。固然，比喻是最簡單的案例。對於技術文章來講，有時候，一個簡潔恰當的案例，要比大篇幅的解釋還要更加深刻人心和更容易令人理解。

參考

寫文章以前多參考一些資料，是一個好的習慣。若是文章寫完，末尾沒有參考資料或者資源引用的連接，那要麼是你版權意識不夠，要麼是你沒有意識到參考資源對讀者的做用有多大，固然，還有一個最不該該的可能，就是你根本就沒有參考其餘資源。對於同一個觀點，不一樣的人有不一樣的思考角度和思惟方式，辯證和批判性思惟是全面、深刻理解一個問題有利的工具。

排版

排版是開發者必備的基礎能力之一。沒有基礎的排版能力，是沒法寫出閱讀性良好的文檔的。文檔算是最簡單的文章，連文檔的排版都不會，那麼請自學word排版知識，再來寫文章。一個版面雜亂的文章是會倒讀者胃口的。