連結:
https://juejin.im/post/5ec29c16e51d454d9b12677f
本文由作者授權發布。
很多同學的進階都是從寫文章開始的,沒錯,說的是我。
不可否認的是,好的文章能夠幫助一些背景不那麼出色的同學面試加分,好吧,也是我。
今天我來和同學們分享一下,如何去寫好一篇技術文章。
我們寫文章通常會有兩種:
為什麼我不建議將複習的文章發表到博客平臺上?
因為當我們閱讀到這類文章的時候,有時不能夠明白作者的意圖,只有作者自己能懂,對於此類文章,我的建議是將他們放在筆記平臺上,比如印象筆記。
通常的技術文章題材有:
一般用來介紹最新新出的技術,比如 Android 中的 Android Jetpack 和 Flutter,風格有點類似於技術文檔。
在我們學習了某項技術,並有了使用的經驗之後,就可以著手來一篇,它通常面向的是此類技術的小白。比如我的即學即用Android Jetpack系列:
《即學即用Android Jetpack - Navigation》
https://www.jianshu.com/p/66b93df4b7a6
這類文章通常是從原理的角度深入分析某項技術,面向的是想要進階的一群人。比如郭神的:
《Glide最全解析》
https://blog.csdn.net/sinyu890807/category_9268670.html
通常是遇到問題的解決方案,此類文章面向的是同樣遇到此坑的開發者。
即使明確了寫作內容,有的時候電腦打開了,還是不知道如何寫...
先從標題開始吧,有如下幾個要求:
比如你想寫一個RxJava系列的文章,於是你定了一個《一文搞懂RxJava》,結果你就寫了一個RxJava操作符怎麼用,下面保準給你來個評論:???
如果實在想將標題定的寬泛些,那我們該怎麼辦呢?
可以將文章寫成一個系列,這樣既可以保證每一篇的篇幅,讓讀者讀的舒服,也可以實現自己的想法。
看過很多標題黨,比如(無意冒犯):《Java那麼多鎖,能鎖住滅霸嗎?》。
作為一個寫博客的人,標題黨確實用時一時爽,不過,如果文章的內容不能夠讓人信服,被拉黑也是再所難免的。
從短期來看,一個好的標題確實能提升閱讀量,但是站在長期的角度,大家之後搜索出相關的鎖文章,比起《Java那麼多鎖,能鎖住滅霸嗎?》,更願意看到《Java中的鎖[原理、鎖優化、CAS、AQS]》。
所以,我們儘量選擇一個簡短的題目,並且要從題目中可以看出,我們要介紹什麼知識。
使用前言的意圖在於告訴讀者本文的大致方向,讓讀者讀完前言以後就知道這篇文章適不適合自己。
如果可以的話,也可以用腦圖製作一些目錄,像本文中的目錄。
這樣,文章的脈絡就一目了然了。
最好舉的例子就是介紹新技術的時候,比如介紹 Android Jetpack:
提綱寫好了,就不至於文章寫到一半寫不下去了。
記得小學寫作文的時候,老師經常念叨,如果不知道如何寫作文,總分總就是一個很好的方法,比如說,我們去介紹某一項技術的時候,可以這麼寫:
除了總分總,還有一種常用的套路是:
在文章的開始階段先拋出問題,讓讀者去思考,接著,從回答問題的角度,如何去解決問題。類似的文章有:
《Android Bitmap的內存大小是如何計算的?》
https://ivonhoe.github.io/2017/03/22/Bitmap&Memory/
一些同學的文章雖然技術深度達到了,但是排版卻不盡人意,導致讀者去閱讀的時候一點閱讀的欲望也沒有。
如果你的文章有下列情形:
可以參看阮一峰的:
《中文技術文檔的寫作規範》
https://github.com/ruanyf/document-style-guide
當然,寫文章並非寫技術文檔,可以根據自己的需求做一些修改。
文章寫完以後,別著急發表,因為我們還有一些事情要做。
現在忘掉自己是一個作者,把自己當做一個讀者,一步步的閱讀,看自己是否能夠從這些文字中掌握到這些技術,假設不能,你就應該去思考如何完善這篇文章了。
錯字、病句和英文單詞是經常發生的問題,所以當我們寫好文章以後,需要至少再讀一遍去避免這些低級錯誤。
也許你已經對博客平臺上樣式產生了一些審美疲勞,沒關係,掘金和微信公眾號的 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^)┛明天見!