一篇技術文章合格的標準

yanwushu發表於2014-09-29

原文地址

前言

作為一個開發者,經常需要在網上查詢各種資料,但是一個讓人倍受打擊的事實是,現在網上的大多數文章質量都太糟糕。行文混亂,觀點不清,結構失調,甚至有些都不能算是一篇真正的文章。作為一個有正確價值觀的人,我覺得應該自己建立一個部落格,寫一些質量相對較高的文章(當然是自認為)來提升國內網際網路內容的質量。理所當然,任何人都有對這些文章中觀點懷疑和評論的權利,我也很願意針對自己認為有意義的評論進行討論。

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

非轉載

沒有任何修改,直接貼上複製別人的文章到自己的部落格。這種行為唯一產生的意義就是浪費了網際網路上大量的硬碟空間。這種東西(是的,它們不能稱之為文章)沒有任何新的知識和觀點,不會對網際網路做出絲毫建設性的貢獻。

有些人會說,我將這些文章放到我的部落格,可以記錄自己的學習軌跡,對自己是一個激勵,並且我可以隨時參考這些文章。如果是這樣,那麼你應該認識到一點,絕大多數的網站都有收藏功能,即便沒有,你也能夠很容易的找到類似pocket的網路資源收藏工具。

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

結構完整

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

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

觀點或主題

觀點是寫文章的動機,一篇文章不可能沒有觀點就直接寫出來。對於技術文章來說,觀點可能就是一個具體的知識點。但是,一旦主題確定,文章中任何內容都必須為主題服務。避免不必要的、和主題無關的內容出現在文章中是明智的選擇。並且,文章中的所有段落都應該為主題進行合理的安排。

案例

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

參考

寫文章之前多參考一些資料,是一個好的習慣。如果文章寫完,末尾沒有參考資料或者資源引用的連結,那要麼是你版權意識不夠,要麼是你沒有意識到參考資源對讀者的作用有多大,當然,還有一個最不應該的可能,就是你根本就沒有參考其他資源。對於同一個觀點,不同的人有不同的思考角度和思維方式,辯證和批判性思維是全面、深入理解一個問題有利的工具。

排版

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

相關文章