我是如何写好一篇技术博客的

前言

不少同窗的进阶都是从写文章开始的,没错,说的是我。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不太好记,而后想改为九五,名字被注册了,最后随便输入一个字,变成了九心

文章引用:

《分享下写技术文章的思路》
《知乎:程序员怎样才能写出一篇好的博客或者技术文章?》
《如何写好一篇技术文章?》

相关文章
相关标签/搜索