我是如何寫好一篇技術(shù)博客的

前言

很多同學(xué)的進(jìn)階都是從寫文章開始的勉吻,沒錯监婶,說的是我。

不可否認(rèn)的是齿桃,好的文章能夠幫助一些背景不那么出色的同學(xué)面試加分惑惶,好吧,也是我短纵。

今天我來和同學(xué)們分享一下带污,如何去寫好一篇技術(shù)文章。


是時候表演真正的技術(shù)了

目錄

目錄

一香到、寫文章之前

1. 明確目標(biāo)

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

  • 分享:提供快捷通道面向有同樣需求的開發(fā)者鱼冀。
  • 復(fù)習(xí):僅為了自己復(fù)習(xí),我不建議將這類文章發(fā)表到博客平臺悠就。

為什么我不建議將復(fù)習(xí)的文章發(fā)表到博客平臺上千绪?

因?yàn)楫?dāng)我們閱讀到這類文章的時候,有時不能夠明白作者的意圖梗脾,只有作者自己能懂荸型,對于此類文章,我的建議是將他們放在筆記平臺上炸茧,比如印象筆記帆疟。

2. 明確類型

通常的技術(shù)文章題材有:

(1)技術(shù)介紹型

一般用來介紹最新新出的技術(shù),比如 Android 中的 Android Jetpack 和 Flutter宇立,風(fēng)格有點(diǎn)類似于技術(shù)文檔。在我們學(xué)習(xí)了某項(xiàng)技術(shù)自赔,并有了使用的經(jīng)驗(yàn)之后妈嘹,就可以著手來一篇,它通常面向的是此類技術(shù)的小白绍妨。比如我的即學(xué)即用Android Jetpack系列:

《即學(xué)即用Android Jetpack - Navigation》

(2)技術(shù)深入型

這類文章通常是從原理的角度深入分析某項(xiàng)技術(shù)润脸,面向的是想要進(jìn)階的一群人柬脸。比如郭神的:

《Glide最全解析》

(3)解決問題型

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

二倒堕、寫文章之中

即使明確了寫作內(nèi)容,有的時候電腦打開了爆价,還是不知道如何寫...


除了菜什么都沒有

1. 擬定標(biāo)題

先從標(biāo)題開始吧垦巴,有如下幾個要求:

(1)標(biāo)題不要太寬泛

比如你想寫一個RxJava系列的文章,于是你定了一個《一文搞懂RxJava》铭段,結(jié)果你就寫了一個RxJava操作符怎么用骤宣,下面保準(zhǔn)給你來個評論:?序愚?憔披?

如果實(shí)在想將標(biāo)題定的寬泛些,那我們該怎么辦呢爸吮?可以將文章寫成一個系列芬膝,這樣既可以保證每一篇的篇幅,讓讀者讀的舒服形娇,也可以實(shí)現(xiàn)自己的想法锰霜。

(2)不要標(biāo)題黨

看過很多標(biāo)題黨,比如(無意冒犯):《Java那么多鎖埂软,能鎖住滅霸嗎锈遥?》。

作為一個寫博客的人勘畔,標(biāo)題黨確實(shí)用時一時爽所灸,不過,如果文章的內(nèi)容不能夠讓人信服炫七,被拉黑也是再所難免的爬立。

從短期來看,一個好的標(biāo)題確實(shí)能提升閱讀量万哪,但是站在長期的角度侠驯,大家之后搜索出相關(guān)的鎖文章,比起《Java那么多鎖奕巍,能鎖住滅霸嗎吟策?》,更愿意看到《Java中的鎖[原理的止、鎖優(yōu)化檩坚、CAS、AQS]》。

所以匾委,我們盡量選擇一個簡短的題目拖叙,并且要從題目中可以看出,我們要介紹什么知識赂乐。

2. 使用前言和目錄

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

如果可以的話挨措,也可以用腦圖制作一些目錄挖滤,像本文中的目錄。

這樣运嗜,文章的脈絡(luò)就一目了然了壶辜。

3. 列個提綱

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

  • Android Jetpack 是什么担租?
  • 為什么使用 Android Jetpack砸民?
  • Android Jetpack 對應(yīng)哪些庫,每個庫具體的功能奋救?

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

4. 寫作手法

記得小學(xué)寫作文的時候尝艘,老師經(jīng)常念叨演侯,如果不知道如何寫作文,總分總就是一個很好的方法背亥,比如說秒际,我們?nèi)ソ榻B某一項(xiàng)技術(shù)的時候,可以這么寫:

  • 開頭(總):這個技術(shù)是一個什么樣的技術(shù)狡汉,可以給我們帶來什么娄徊?里面的主要功能是什么?
  • 介紹(分):這個技術(shù)每項(xiàng)功能如何使用盾戴。
  • 總結(jié)(總):這個技術(shù)使用的優(yōu)缺點(diǎn)寄锐,在具體的實(shí)踐中如何幫助我們。

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

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

《Android Bitmap的內(nèi)存大小是如何計算的畏梆?》

5. 注意排版

一些同學(xué)的文章雖然技術(shù)深度達(dá)到了椎扬,但是排版卻不盡人意惫搏,導(dǎo)致讀者去閱讀的時候一點(diǎn)閱讀的欲望也沒有。

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

  • 總是出現(xiàn)大段大段的代碼或者文字蚕涤。
  • 使用幾級標(biāo)題全看心情。
  • 中英文處理起來不太好看铣猩。
  • ...

可以參看阮一峰的:

《中文技術(shù)文檔的寫作規(guī)范》

當(dāng)然揖铜,寫文章并非寫技術(shù)文檔,可以根據(jù)自己的需求做一些修改达皿。

三天吓、寫文章之后

文章寫完以后,別著急發(fā)表峦椰,因?yàn)槲覀冞€有一些事情要做龄寞。

1. 從讀者角度閱讀文章

現(xiàn)在忘掉自己是一個作者,把自己當(dāng)做一個讀者汤功,一步步的閱讀物邑,看自己是否能夠從這些文字中掌握到這些技術(shù),假設(shè)不能滔金,你就應(yīng)該去思考如何完善這篇文章了色解。

2. 檢查文章

錯字、病句和英文單詞是經(jīng)常發(fā)生的問題餐茵,所以當(dāng)我們寫好文章以后科阎,需要至少再讀一遍去避免這些低級錯誤。

3. 美化文章

也許你已經(jīng)對博客平臺上樣式產(chǎn)生了一些審美疲勞忿族,沒關(guān)系锣笨,掘金和微信公眾號的 Markdown(MD) 格式都支持 html,幫助你的文章從外表給人一亮的感覺道批。

對于我這種前端菜雞错英,html 寫是不可能寫的,有沒有什么好的辦法呢屹徘?當(dāng)然有走趋,可以借助一些第三方的網(wǎng)站,比如:Markdown Nice噪伊,它可以幫助你自動生成好一些美觀的樣式簿煌,之后CV到對應(yīng)的博客的平臺,本文就是這么操作的鉴吹。

閑聊一下

如果你有關(guān)于寫博客的一些好的小技巧姨伟,歡迎下方討論。

最后說一下豆励,我把Id改了夺荒,由原來的「TeaOf」改成了「九心」瞒渠,為什么改呢?覺得 「TeaOf」這個Id不太好記技扼,然后想改成「九五」伍玖,名字被注冊了,最后隨便輸入一個字剿吻,變成了「九心」窍箍。

文章引用:

《分享下寫技術(shù)文章的思路》
《知乎:程序員怎樣才能寫出一篇好的博客或者技術(shù)文章?》
《如何寫好一篇技術(shù)文章丽旅?》

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末椰棘,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子榄笙,更是在濱河造成了極大的恐慌邪狞,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,270評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件茅撞,死亡現(xiàn)場離奇詭異帆卓,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)乡翅,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,489評論 3 395
  • 文/潘曉璐 我一進(jìn)店門鳞疲,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人蠕蚜,你說我怎么就攤上這事尚洽。” “怎么了靶累?”我有些...
    開封第一講書人閱讀 165,630評論 0 356
  • 文/不壞的土叔 我叫張陵腺毫,是天一觀的道長。 經(jīng)常有香客問我挣柬,道長潮酒,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,906評論 1 295
  • 正文 為了忘掉前任邪蛔,我火速辦了婚禮急黎,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘侧到。我一直安慰自己勃教,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,928評論 6 392
  • 文/花漫 我一把揭開白布匠抗。 她就那樣靜靜地躺著故源,像睡著了一般。 火紅的嫁衣襯著肌膚如雪汞贸。 梳的紋絲不亂的頭發(fā)上绳军,一...
    開封第一講書人閱讀 51,718評論 1 305
  • 那天印机,我揣著相機(jī)與錄音,去河邊找鬼门驾。 笑死射赛,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的奶是。 我是一名探鬼主播咒劲,決...
    沈念sama閱讀 40,442評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼诫隅!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起帐偎,我...
    開封第一講書人閱讀 39,345評論 0 276
  • 序言:老撾萬榮一對情侶失蹤逐纬,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后削樊,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體豁生,經(jīng)...
    沈念sama閱讀 45,802評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,984評論 3 337
  • 正文 我和宋清朗相戀三年漫贞,在試婚紗的時候發(fā)現(xiàn)自己被綠了甸箱。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,117評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡迅脐,死狀恐怖芍殖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情谴蔑,我是刑警寧澤豌骏,帶...
    沈念sama閱讀 35,810評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站隐锭,受9級特大地震影響窃躲,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜钦睡,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,462評論 3 331
  • 文/蒙蒙 一蒂窒、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧荞怒,春花似錦洒琢、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,011評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至撩嚼,卻和暖如春停士,著一層夾襖步出監(jiān)牢的瞬間挖帘,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,139評論 1 272
  • 我被黑心中介騙來泰國打工恋技, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留拇舀,地道東北人。 一個月前我還...
    沈念sama閱讀 48,377評論 3 373
  • 正文 我出身青樓蜻底,卻偏偏與公主長得像骄崩,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子薄辅,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,060評論 2 355