技術文章是怎樣煉成的?
思維導圖
介紹
最近看到很多這方面的文章,我就想了想,我認為的好的技術文章是什麼樣的?
這文章主要是寫給自己的,對我以後的技術文章有警醒作用。
目標群體
不是讓你在文章開頭寫下,你的文章適合什麼樣的人讀?——這是什麼意思,鄙視我看不懂你的文章。
我所說的“目標群體”是大家,也包括你自己。你的文章是給大家讀的,也是給自己讀的。
大家能看你的文章,應該是我們的榮幸,我們應該高興。現在的網際網路是個資訊大爆炸的時代,什麼文章沒有,能看你的文章,有人關注你,難道你不應該慶幸嗎?
如果大家能在看你文章的時候,給你寫評論,那你更應該高興,因為人家確實看了你的文章。而且如果給你寫一些建議,那你更應該高興不已。因為你得到了意外收穫。
簡單、明瞭
你寫的文章,儘量應該簡單,明白。——寫技術文章,應該把複雜的弄簡單,而不是把簡單的弄複雜,畢竟不是寫書。
很多“牛人”,很會賣弄風騷,把文章寫的跟舊社會女人的裹腳布一樣,又臭,又長。——有的時候我也經常犯這樣的錯誤,雖然我不是”牛人“。
那麼怎樣寫的簡單、明瞭呢?
1、少說廢話,把主題句(關鍵句)給我們拿出來看就行了,甭寫一堆的廢話。——很多人本來一句話能解釋清楚的事情,用上百行字去讓人明白。這很大程度上也說明他自己也在迷糊中。
2、可以加一些解釋,最多用四句話。——如果超過四句話,說明你還在糊塗中,你就需要“重構“了,把內容儘量縮短。——畢竟你有時間看,但不要浪費大家的時間。
3、用影像把主題意思提煉出來。如果你的圖,能說明你的問題,那你就用圖表示,再加一些輔助的文字說明(這是大家不明白的時候才看的)
4、技術名詞給個連線。——很多人寫文章有個特點,當提到某個技術的時候,先介紹這個技術是什麼?這用你說嗎?現在的百科,wiki哪一個說的不比你清楚啊,你只需要給個連線就行了。
順序
你最好把你最主要、最重要的東西往前排。——畢竟不會每個人都看完你的文章。大家都是忙人,還要幹別的事呢?哪有心思看完你整片文章。
我記得我想看一些技術類的書籍的時候,剛開始很興致勃勃的去買了相關書籍,結果我看了前兩章,實在沒心思再往後看了,這種書我通常用半年或者一年的時間去看完。畢竟用我辛苦掙得錢買的,如果不看完,心裡虧得晃。
但是我發現,很多開始提不起興趣的書,越到後面越讓我來了興致,越到後面越精彩,越到後面我的收穫就越大。——為什麼學點有用的東西就那麼難呢?
簡短
你的文章儘量要簡短。看長長的文章,跟看長函式一樣,讓人望而生畏。
如果你的文章很長才能說明問題,那我建議你,可以把文章做成系列,分幾個系列給大家看。每次回頭想看的時候,更有針對性。——這就跟我們寫程式碼一樣,不要讓你的類太長,如果太長,那你該重構了——Extract Class。
重構
不要以為你能一下就能把你的文章寫好,你也不是完人,就算是再牛的作家,也還要不停的修改他的文章呢?何況你只是一個coder而已?
我們寫完文章,要經常性的翻看自己的文章。看文章的過程,是我們再一次學習的過程。
翻看的時候,我們自己經常能發現一些問題。如標點符號、錯別字、程式碼錯誤、語病、文章樣式...
配圖
儘量配置一些圖片,很多時候圖片很能說明問題。——如果能配置動畫視訊,那就更爽了。
很多時候圖能說明的問題,是文字無法比擬的。
準確
不要害怕自己的觀點錯誤,或者技術錯誤,大膽的寫,如果有人給你指正出來,那你就去找資料去核實下,然後再去改正,這中間你也能學到很多東西。
不要怕錯誤——勇者無敵嗎!
總結
我知道,很多人看了我的文章有可能會吐血,會拍磚。那就猛拍吧?拍死我算了。
相關文章
- SnapKit 是怎樣煉成的 | 掘金技術徵文APK
- 黑客是怎樣煉成的黑客
- mybatis是怎樣煉成的MyBatis
- React 是怎樣煉成的React
- 黑客是怎樣煉成的?黑客
- 開源是怎樣煉成的?
- 大師是怎樣煉成的
- Flutter bot_toast是怎樣煉成的FlutterAST
- 【iOS開發】SnapKit是怎樣煉成的iOSAPK
- 出色的技術分享是如何煉成的?
- 航空公司系統是怎樣煉成的?
- 千億級HttpDNS服務是怎樣煉成的httpdDNS
- 盲人程式設計師是怎樣煉成的程式設計師
- 專業的技術支援是如何煉成的
- 走近原始碼:壓縮列表是怎樣煉成的原始碼
- 【進階】前端幸福感是怎樣煉成的(下)前端
- 【進階】前端幸福感是怎樣煉成的(上)前端
- 田永強:優秀的JavaScript模組是怎樣煉成的JavaScript
- 規模化敏捷 LeSS(三):LeSS Huge 是怎樣煉成的?敏捷
- 一家法律智慧公司的CTO是怎樣煉成的?
- HarmonyOS智慧座艙體驗是怎樣煉成的?立即檢視
- 新手指南——優秀平面設計師是怎樣煉成的
- 菜鳥指南——優秀平面設計師是怎樣煉成的
- 《塞爾達傳說:曠野之息》技術分析:神作是怎麼煉成的
- 小島秀夫:全世界粉絲最多的遊戲製作人是怎樣煉成的遊戲
- 軟體設計是怎樣煉成的(1)——什麼是優秀的設計?
- 讓維護人員抓狂的程式設計師是怎樣煉成的程式設計師
- 簡易版Swiper是怎麼煉成的
- 【Flutter 元件集錄】Switch 是怎樣煉成的| 8月更文挑戰Flutter元件
- 軟體設計是怎樣煉成的(7)——細節決定成敗(詳細設計)
- 一個簡單RPC框架是怎樣煉成的(V)——引入傳輸層RPC框架
- 基於TensorFlow打造強化學習API:TensorForce是怎樣煉成的?強化學習API
- 軟體設計是怎樣煉成的(4)——軟體設計的“大道理”
- 軟體設計是怎樣煉成的(3)——軟體系統不是木桶型的
- 優秀的資料分析師是這樣煉成的
- 蘋果2020最新財報出爐,“史上最高季度營收”是怎樣煉成的蘋果營收
- 掌控遊戲風評的水軍是怎麼煉成?遊戲
- 遊戲語音解決方案是怎麼煉成的遊戲