您的当前位置:首页正文

写技术文章需要遵循的

来源:东饰资讯网

在这个自媒体井喷的时代,每天都会产出数以万计的文章。但大部分文章质量都不高:排版混乱的,连篇错别字的,逻辑混乱的等等等等。

在我看来,一篇优秀的技术文章包括如下特征

  • 优秀的排版:给读者舒适的阅读体验。
  • 优秀的内容:能让读者有所收获。

排版

有研究显示,打字的时候不喜欢在中文和英文之间加空格的人,感情路都走得都很辛苦,有七成的比例会在34岁的时候跟自己不爱的人结婚,而其余三成的人最终只能把遗产留给自己的猫。毕竟爱情跟书写都需要适时的留白。

  • 合适的行间距。个人比较喜欢行高为字体大小的 1.5 倍。
  • 段落之间空一行。段首不要空两格。
  • 中文与英文,数字之间有一个空格。
  • 专有名词使用正确的大小写。如:GitHub,不是 github 或 Github;JavaScript,不是 Javascript。更多见。
  • 简体中文的文章中不要混杂繁体中文,同样的,繁体中文也不要混简体中文。
  • 一篇文章中出现的颜色、字体、字号最好不要超过 3 种。
  • 显示代码用等宽字体。代码需要语法高亮。

内容

  • 语句通顺
  • 言之有物
  • 逻辑清晰
  • 简单明了

总结一下

那么,如何才能写出优秀的技术文章呢?

排版方面,我们只要注意即可。
内容方面,我们需要的做的是:

  • 多读:优秀的技术文章,源码。
  • 提高自己的表达能力。
  • 多写:技术文章,代码。经常优化之前写的技术文章,代码。
  • 多思考。

假以时日,你一定能写出优秀的技术文章~

参考


显示全文