我是如何寫好一篇技術博客的

2021-03-02 鴻洋

連結:

https://juejin.im/post/5ec29c16e51d454d9b12677f

本文由作者授權發布。

很多同學的進階都是從寫文章開始的,沒錯,說的是我。


不可否認的是,好的文章能夠幫助一些背景不那麼出色的同學面試加分,好吧,也是我。


今天我來和同學們分享一下,如何去寫好一篇技術文章。


目錄
1. 明確目標


我們寫文章通常會有兩種:


複習:僅為了自己複習,我不建議將這類文章發表到博客平臺。


為什麼我不建議將複習的文章發表到博客平臺上?


因為當我們閱讀到這類文章的時候,有時不能夠明白作者的意圖,只有作者自己能懂,對於此類文章,我的建議是將他們放在筆記平臺上,比如印象筆記。


2. 明確類型


通常的技術文章題材有:


(1)技術介紹型


一般用來介紹最新新出的技術,比如 Android 中的 Android Jetpack 和 Flutter,風格有點類似於技術文檔。


在我們學習了某項技術,並有了使用的經驗之後,就可以著手來一篇,它通常面向的是此類技術的小白。比如我的即學即用Android Jetpack系列:

《即學即用Android Jetpack - Navigation》

https://www.jianshu.com/p/66b93df4b7a6


(2)技術深入型


這類文章通常是從原理的角度深入分析某項技術,面向的是想要進階的一群人。比如郭神的:


《Glide最全解析》

https://blog.csdn.net/sinyu890807/category_9268670.html


(3)解決問題型


通常是遇到問題的解決方案,此類文章面向的是同樣遇到此坑的開發者。


即使明確了寫作內容,有的時候電腦打開了,還是不知道如何寫...



1. 擬定標題


先從標題開始吧,有如下幾個要求:


(1)標題不要太寬泛


比如你想寫一個RxJava系列的文章,於是你定了一個《一文搞懂RxJava》,結果你就寫了一個RxJava操作符怎麼用,下面保準給你來個評論:???


如果實在想將標題定的寬泛些,那我們該怎麼辦呢?


可以將文章寫成一個系列,這樣既可以保證每一篇的篇幅,讓讀者讀的舒服,也可以實現自己的想法。


(2)不要標題黨


看過很多標題黨,比如(無意冒犯):《Java那麼多鎖,能鎖住滅霸嗎?》。


作為一個寫博客的人,標題黨確實用時一時爽,不過,如果文章的內容不能夠讓人信服,被拉黑也是再所難免的。


從短期來看,一個好的標題確實能提升閱讀量,但是站在長期的角度,大家之後搜索出相關的鎖文章,比起《Java那麼多鎖,能鎖住滅霸嗎?》,更願意看到《Java中的鎖[原理、鎖優化、CAS、AQS]》。


所以,我們儘量選擇一個簡短的題目,並且要從題目中可以看出,我們要介紹什麼知識。


2. 使用前言和目錄


使用前言的意圖在於告訴讀者本文的大致方向,讓讀者讀完前言以後就知道這篇文章適不適合自己。


如果可以的話,也可以用腦圖製作一些目錄,像本文中的目錄。


這樣,文章的脈絡就一目了然了。


3. 列個提綱


最好舉的例子就是介紹新技術的時候,比如介紹 Android Jetpack:


Android Jetpack 對應哪些庫,每個庫具體的功能?


提綱寫好了,就不至於文章寫到一半寫不下去了。


4. 寫作手法


記得小學寫作文的時候,老師經常念叨,如果不知道如何寫作文,總分總就是一個很好的方法,比如說,我們去介紹某一項技術的時候,可以這麼寫:


開頭(總):這個技術是一個什麼樣的技術,可以給我們帶來什麼?裡面的主要功能是什麼?總結(總):這個技術使用的優缺點,在具體的實踐中如何幫助我們。


除了總分總,還有一種常用的套路是:


在文章的開始階段先拋出問題,讓讀者去思考,接著,從回答問題的角度,如何去解決問題。類似的文章有:


《Android Bitmap的內存大小是如何計算的?》

https://ivonhoe.github.io/2017/03/22/Bitmap&Memory/


5. 注意排版


一些同學的文章雖然技術深度達到了,但是排版卻不盡人意,導致讀者去閱讀的時候一點閱讀的欲望也沒有。


如果你的文章有下列情形:



可以參看阮一峰的:


《中文技術文檔的寫作規範》

https://github.com/ruanyf/document-style-guide


當然,寫文章並非寫技術文檔,可以根據自己的需求做一些修改。


文章寫完以後,別著急發表,因為我們還有一些事情要做。


1. 從讀者角度閱讀文章


現在忘掉自己是一個作者,把自己當做一個讀者,一步步的閱讀,看自己是否能夠從這些文字中掌握到這些技術,假設不能,你就應該去思考如何完善這篇文章了。


2. 檢查文章


錯字、病句和英文單詞是經常發生的問題,所以當我們寫好文章以後,需要至少再讀一遍去避免這些低級錯誤。


3. 美化文章


也許你已經對博客平臺上樣式產生了一些審美疲勞,沒關係,掘金和微信公眾號的 Markdown(MD) 格式都支持 html,幫助你的文章從外表給人一亮的感覺。


對於我這種前端菜雞,html 寫是不可能寫的,有沒有什麼好的辦法呢?當然有,可以藉助一些第三方的網站,比如:Markdown Nice,它可以幫助你自動生成好一些美觀的樣式,之後CV到對應的博客的平臺,本文就是這麼操作的。

https://www.mdnice.com/


文章引用:


《分享下寫技術文章的思路》

https://blog.fundebug.com/2018/09/29/how-to-write-technology-blog/

《知乎:程式設計師怎樣才能寫出一篇好的博客或者技術文章?》

https://www.zhihu.com/question/40716838

《如何寫好一篇技術文章?》

https://juejin.im/post/59e86ee76fb9a045257739d4

推薦閱讀:

掃一掃 關注我的公眾號

如果你想要跟大家分享你的文章,歡迎投稿~

┏(^0^)┛明天見!

相關焦點

  • 快速學習的我該如何寫好博客?
    當然在學習的過程中就遇到了一些困惑,比如Vancen就在星球裡提問,想知道自己如何更好地對學習成果輸出,我覺得大部分同學都有這個困惑,就把星球的文章再加工下,在這裡和大家分享。Vancen問道:躍哥,有個問題一直困擾我,就是博客到底應該怎麼寫才能成為簡歷上的加分項?
  • 如何寫好一篇符合seo優化的文章
    這段時間有很多的seo新手在問我應該怎麼去寫好一篇符合seo優化的文章,他們看了我的網站的文章就說是不是要寫原創的文章?其實小峰seo博客是這樣認為的,不管文章是原創的還是偽原創的或者是直接抄襲的,只要有一點做到了,那麼這篇文章就存在意義,這點就是針對於這個文章的標題去相對應的去解決這類的問題,那麼就是一篇非常有價值的文章,當然如你還需要有很好的排名,那麼這個時候就需要做好一些seo技術上面的優化操作了,接下來我們就一起來看看。
  • 如何編寫一篇的技術BLOG
    基於我個人近幾年寫博客的一些經驗和收穫,聊聊如何寫一篇高質量(主題明確、結構清晰、乾貨滿滿)的技術BLOG。品牌建設我個人寫了四年多博客,從剛開始的無人問津,到現在幾千關注、百萬閱讀量,也漸漸的在小範圍內樹立了個人品牌。寫的博客可以通過公眾號來對外輸出,或者一些技術大會合作,引流,還可以將自己的沉澱輸出寫一本書。當我們面試跳槽,演講分享時,個人品牌就自然會帶來不一樣的影響力。
  • 利用博客寫英文評論賺錢
    上次寫了一篇關於PayPerPost的推介文章,但是那個方法雖然可以賺錢,但是不是很多,今天我就介紹下其主業務:用博客寫英文評論賺錢。前期準備:PayPerPost只接受英語類評論,所以你得準備英文博客,用免費的也可以但是接不到好的廣告,所以我建議自己做一個屬於自己的獨立博客,也就是自己的域名自己的空間那種。
  • 程式設計師為什麼值得寫博客?
    技術和遊玩的相同之處在於技術玩得越多,也就越熟悉,當你試著去寫一篇博文的時候,你也回顧了過程。遊玩的回味可以再次歡樂,博文的書寫可以再次熟悉。2、你的過程正是別人所需要的。不要以為你手上的那點點關於編碼的小知識不是別人所需要的,有時候人們就需要像《七周七語言 理解多種編程範型》這種書。 3、你的作品有可能因此重構。
  • 你為什麼有那麼多時間寫博客?
    ;可以聊聊你是如何做時間管理的嗎?平時多積累先說一個事實,寫技術文章真的挺耗時的,有時候寫一篇技術文章需要8小時,深度一點的文章需要幾天都很正常,但有的時候卻只需要幾個小時,這是為什麼呢?先拋一個截圖,這是我在2017年的時候在博客園給一個讀者的回覆:
  • 寫博客能月入 10K?
    其次,我想說的就是寫博客能夠很好的鍛鍊你的寫作能力,我記得在大學的時候,我問過一個做培訓的大佬,我問他,我說:「在工作中什麼能力是最重要的呢」?當時,他給了我幾個答案,第一是技術能力,第二是寫文檔的能力,第三是溝通能力。當時,我剛剛大三,對於技術只是一知半解,學的並不深入,但是,從這個回答中我得到了一個很重要的能力,那就是寫作能力。
  • 初寫博客的人克服寫作障礙
    寫博客是我一段時間以來一直熱衷的事情,那些了解我的人見證了我多年來寫博客的起起伏伏。我成為一個博客的旅程是一個無止境的嘗試和錯誤的旅程,說實話,它仍然是。當我第一次開始寫博客的時候,我認為我所需要做的就是選擇一個主題來寫,坐在電腦前,讓文字自由地從我的腦海中流淌到我的指尖。我很快意識到這不是博客的工作方式。我努力寫作,因為我不知道我想寫什麼,最終我失去了繼續寫博客的動力。我會對自己說:「為什麼這對我來說這麼難?
  • 程式設計師要不要寫博客?如何寫博客?十年 bloger 經驗分享!
    為什麼要寫 blog,石頭覺得有如下幾個好處:可以把它作為整理學習筆記的地方,方便沉澱學習,就跟當初我開始玩一樣。更多的是寫給自己看,玩玩「建站」流程(獨立博客),也算一個小技能。(要不要寫博客看個人興趣,但學會總結沉澱是必須的)「成就自己、幫助他人」。在日常工作中,你肯定也有通過別人的博客解決了你的某個問題,這個時候「反哺」一下開放的網際網路也何嘗不是一件快事。
  • 寫博客是一種寫作式學習
    對於職場人士有三種能力必須不可少:想清楚(批判性思維)、說清楚(演講能力)、寫清楚(寫作能力),寫作能力的重要性如何強調都不為過,而博客無疑是職場人記錄專業知識以及工作經驗的重要平臺之一,今天的文章就是關於寫博客的好處。
  • 寫博客是一種「寫作式學習」
    今天是Blog的周年紀念,今天很忙沒時間寫文章,把去年今天寫的文章再發一遍,再過一個月運營微信也快一年了,現在每天都能堅持閱讀、寫作、日記和運動,這些已經成為生活中的一部分了。當天的文章的簡單做個總結,從錢、個人提升和影響力三個方面說了一下,今天花些時間單獨寫篇文章來說說寫博客到底帶來了什麼好處: 當時在微博中順手歸納16條好處,從新整理合併一下成為7部分1、寫作能力對於職場人士有三種能力必須不可少:想清楚(批判性思維)、說清楚(演講能力)、寫清楚(寫作能力),寫作能力的重要性如何強調都不為過
  • 小哥拿它寫「雞湯」狂漲粉,還成了技術博客最火文章
    可不止能寫高考作文。 最近,一位美國小哥用GPT-3寫的博客,就打敗了一票人類作者,登上了新聞平臺技術板塊熱榜第一?? 你沒聽錯。這位小哥名叫Liam Porr,來自加州大學伯克利分校計算機科學系。他參考最熱的網文風格,用GPT-3生成了幾篇文章,用筆名「adolos」開了個博客,開始連續產出文章。
  • 最後,我選擇了博客園
    這是一篇記錄我為什麼選擇了博客園並如何調♂教她的文章。看完這篇文章你可以收穫什麼?你會再也不想寫CSS!最近想找個地方整理一些自己的想法,研究了一些熱門站點。後來看一些博客的時候,嗯?這些博客好炫啊,怎麼都是cnblogs開頭的。真香,自定義CSS天下第一。
  • 50家矽谷IT公司技術博客-吐槽篇
    之前筆者寫過一篇「這些矽谷創業的公司,哪一家驚豔了你」,算是處女作吧,還寫過一篇介紹「美國大數據創業公司」。其實介紹矽谷公司有不同的角度,有參觀訪問的角度,有從面試的角度,從食堂的角度(據說Dropbox是米其林標準),甚至從廁所的角度(如果大家去AirBnB可以開開眼界),今天我就從技術博客(Engineering Blog)給大家分享一下50家矽谷優秀IT公司技術博客,從中可以了解企業文化,技術特色和設計語言,如果直接列出來很單調,筆者就放上大圖,加上點評,算吐槽版吧。
  • 如何搭建自己的個人博客
    寫博客有很多好處,其一是它能夠迫使你總結你學習的知識,你需不但的消化自己的知識點,使你對知識有了更深刻的認識;其二是你的博客如同你的個人簡歷,記錄了你的學習歷程,通過寫博客,可以讓別人認識你,可以結交更多的行業朋友;其三,博客起到了傳播知識的作用,特別是技術類的博客能夠幫助別人解決技術問題,幫助人是一件快樂的事,何樂而不為。
  • 【原創】程式設計師寫博客很重要嗎?
    我用的我自己的個人經歷總結了 5 點寫博客的好處:正文如下:我自己從大二開始寫博客,當時最開始的時候就是很簡單地總結自己課堂上學習的基礎知識,比如計算機網絡、數據結構等等,平時也會記錄一些自己學習中遇到的一些問題。寫博客的好處有哪些呢?
  • 博客網站如何獲取流量
    那麼應該博客如何獲取流量呢1、博客評論推廣這 種方法是現在博主們最喜歡也是最常用的推廣方法,這也是主動吸引流量的方法之一,而更主要的原因是這種方法被知名博主盧松松發揚光大,於是這種方法得到了 大家的廣泛使用,其實誰都希望自己的博客能夠得到別人的訪問以及評論,這也是博客互動的要素。
  • 如何寫好一篇標題是《我的老師》的作文? | 鬼首天龍
    說沒有寫過的請站起來,我不罰你們。有20個人是吧,GET OUT!出去!在走廊裡站一排,一會兒我給你媽媽打電話! 直到現在我都百思不得其解,中國的老師們哪裡來的這麼大底氣,非得讓學生們寫一篇《我的老師》這樣一篇作文?我想,他們一定覺得自己言行是可圈可點的,自己的形象是光輝燦爛的,往次處說是百花園裡培土澆花的園丁,往高處講那就是人類靈魂的工程師。是那麼回事兒嗎?
  • 現在我最喜歡的獨立博客程序是ZBLOG
    前段時間寫過一篇文章《三個主流的獨立博客系統,哪個才是適合你的?》        今天這篇文章不涉及什麼技術內容,只因為昨天看了一篇文章是一位自媒體人講述自己為什麼要使用Wordpress博客程序,介紹的挺全面的,因此今天我也詳細說說自己為什麼喜歡ZBLOG,讓更多人認識一下ZBLOG博客程序。
  • 周記怎麼寫 如何寫一篇好的周記
    對於一篇周記,我們應該如何去寫好呢?下面是小編整理的寫一篇好周記的方法,供各位閱讀和借鑑。