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

前言

不少同窗的進階都是從寫文章開始的,沒錯,說的是我。html

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

今天我來和同窗們分享一下,如何去寫好一篇技術文章。 是時候表演真正的技術了git

目錄

目錄
目錄

1、寫文章以前

1. 明確目標

咱們寫文章一般會有兩種:程序員

  • 分享:提供快捷通道面向有一樣需求的開發者。
  • 複習:僅爲了本身複習,我不建議將這類文章發表到博客平臺。

爲何我不建議將複習的文章發表到博客平臺上?github

由於當咱們閱讀到這類文章的時候,有時不可以明白做者的意圖,只有做者本身能懂,對於此類文章,個人建議是將他們放在筆記平臺上,好比印象筆記面試

2. 明確類型

一般的技術文章題材有:微信

(1)技術介紹型

通常用來介紹最新新出的技術,好比 Android 中的 Android Jetpack 和 Flutter,風格有點相似於技術文檔。在咱們學習了某項技術,並有了使用的經驗以後,就能夠着手來一篇,它一般面向的是此類技術的小白。好比個人即學即用Android Jetpack系列:markdown

《即學即用Android Jetpack - Navigation》ide

(2)技術深刻型

這類文章一般是從原理的角度深刻分析某項技術,面向的是想要進階的一羣人。好比郭神的:oop

《Glide最全解析》

(3)解決問題型

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

2、寫文章之中

即便明確了寫做內容,有的時候電腦打開了,仍是不知道如何寫... 除了菜什麼都沒有

1. 擬定標題

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

(1)標題不要太寬泛

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

若是實在想將標題定的寬泛些,那咱們該怎麼辦呢?

能夠將文章寫成一個系列,這樣既能夠保證每一篇的篇幅,讓讀者讀的舒服,也能夠實現本身的想法。

(2)不要標題黨

看過不少標題黨,好比(無心冒犯):《Java那麼多鎖,能鎖住滅霸嗎?》。

做爲一個寫博客的人,標題黨確實用時一時爽,不過,若是文章的內容不可以讓人信服,被拉黑也是再所不免的。

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

因此,咱們儘可能選擇一個簡短的題目,而且要從題目中能夠看出,咱們要介紹什麼知識。

2. 使用前言和目錄

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

若是能夠的話,也能夠用腦圖製做一些目錄,像本文中的目錄。

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

3. 列個提綱

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

  • Android Jetpack 是什麼?
  • 爲何使用 Android Jetpack
  • Android Jetpack 對應哪些庫,每一個庫具體的功能?

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

4. 寫做手法

記得小學寫做文的時候,老師常常唸叨,若是不知道如何寫做文,總分總就是一個很好的方法,好比說,咱們去介紹某一項技術的時候,能夠這麼寫:

  • 開頭(總):這個技術是一個什麼樣的技術,能夠給咱們帶來什麼?裏面的主要功能是什麼?
  • 介紹(分):這個技術每項功能如何使用。
  • 總結(總):這個技術使用的優缺點,在具體的實踐中如何幫助咱們。

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

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

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

5. 注意排版

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

若是你的文章有下列情形:

  • 老是出現大段大段的代碼或者文字。
  • 使用幾級標題全看心情。
  • 中英文處理起來不太好看。
  • ...

能夠參看阮一峯的:

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

固然,寫文章並不是寫技術文檔,能夠根據本身的需求作一些修改。

3、寫文章以後

文章寫完之後,彆着急發表,由於咱們還有一些事情要作。

1. 從讀者角度閱讀文章

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

2. 檢查文章

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

3. 美化文章

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

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

閒聊一下

若是你有關於寫博客的一些好的小技巧,歡迎下方討論。

最後說一下,我把Id改了,由原來的TeaOf改爲了九心,爲何改呢?以爲 TeaOf這個Id不太好記,而後想改爲九五,名字被註冊了,最後隨便輸入一個字,變成了九心

文章引用:

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

相關文章
相關標籤/搜索