前言
很多同學(xué)的進(jìn)階都是從寫文章開始的勉吻,沒錯监婶,說的是我。
不可否認(rèn)的是齿桃,好的文章能夠幫助一些背景不那么出色的同學(xué)面試加分惑惶,好吧,也是我短纵。
今天我來和同學(xué)們分享一下带污,如何去寫好一篇技術(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系列:
(2)技術(shù)深入型
這類文章通常是從原理的角度深入分析某項(xiàng)技術(shù)润脸,面向的是想要進(jìn)階的一群人柬脸。比如郭神的:
(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í)踐中如何幫助我們。
除了總分總尖啡,還有一種常用的套路是:
在文章的開始階段先拋出問題橄仆,讓讀者去思考,接著衅斩,從回答問題的角度盆顾,如何去解決問題。類似的文章有:
5. 注意排版
一些同學(xué)的文章雖然技術(shù)深度達(dá)到了椎扬,但是排版卻不盡人意惫搏,導(dǎo)致讀者去閱讀的時候一點(diǎn)閱讀的欲望也沒有。
如果你的文章有下列情形:
- 總是出現(xiàn)大段大段的代碼或者文字蚕涤。
- 使用幾級標(biāo)題全看心情。
- 中英文處理起來不太好看铣猩。
- ...
可以參看阮一峰的:
當(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ù)文章丽旅?》