目录

如何写好一篇技术博文

开始

  1. 明确目标

    需要明确该文章的受众群体,也就是目标人群。博文是用于记录或者传播信息的,那么信息的价值和被需求性则可以作为编写文章的目的。或者也可以作为单纯的笔记,能够梳理自身所了解的知识点,对于自身的知识作为一个巩固。

    尽量编写分享相关的内容,对于博文的阅读量来说更佳有价值。如果只是作为笔记,那么其中的一些内容可能会只有作者自己能够理解。

  2. 明确类型

    技术博文的常用题材如下:

    1. 技术介绍

      主要是针对新出的一些技术,例如react 18vue3的一些新特性,博文类似于技术文档。在我们学习了该项技术后,并且有一定的运用经验的情况下,就可以准备编写工作。它面向的则是此类技术的入门者。

    2. 技术深入

      从原理角度深入剖析某项技术,它面向的是进阶者

    3. 解决问题

      通常一些异常或者错误的解决方法方案,或者是某技术领域的需求的解决方案。它面向的是遇到同样情况的开发者。

    4. 翻译转载

      该类型则如标题一样,遇见一些好的博文可以将其翻译成其他语言,用以帮助外语能力不佳的同学。或是将外网一些优秀的博文存档在自己的博客中,便于以后自己再次查看。 😂

过程

  1. 拟定标题

    1. 标题不要太宽泛

      比如你想写一个Rxjs系列的文章,于是你是定了一个『一文搞懂 Rxjs』,结果你就只写了一个Rxjs中的方法如何使用

      如果实在想把标题定的宽泛些,那么我们应该将其写成一个系列,在保证篇幅的情况下,拆分内容,让读者的阅读感更佳。

    2. 不要标题党

      从短期来看,好的标题确实可以吸引到更多的阅读量。但是从长远的角度考虑,如果你的博文质量不足,那么以后将会流失很多回头客。 毕竟一个技术博客,需要更多同技术者的关注,才可以让自己的博客变得更有价值。

  2. 结构

    良好的文章结构有益于读者能够快速的判断文章是否适合自己,能否告知读者本文的大致方向。能够提供什么,能够解决什么,能够帮助什么。

    可以充分利用前言进行大致描述本文的主题。

    可以利用目录来帮助读者快速浏览文章的纲要。

  3. 提纲

    举个栗子:

    • fabricjs 是什么?
    • 为什么使用 fabricjs ?

    有了提纲能否帮助写作的是否不偏题,能否围绕主题进行展开。

  4. 写作手法

    常用的写作手法有两种:

    • 总分总 开头,介绍,结尾
    • 提出问题 以抛出问题的方式,然后进行回答问题,如何解决问题。
  5. 排版

    良好的排版有助于增加读者的阅读体验。

    参考 阮一峰 的 『中文技术文档的写作规范』 即可,根据实际情况提进行调整。

后续

  1. 阅读文章

    从读者的角度去阅读写好的文章,看自己能否从这些图文中了解或者掌握文章的所提供的技术。如果自己看了都觉得困惑,那么需要考虑去完善这篇文章了

  2. 检查文章

    检查文章是否出现错字,病句,错误的英文单词。

  3. 美化文章

    根据预览效果去优化排版,甚至可以通过一些css样式进行美化。