写点什么

如何写好一篇技术文章

作者:Hockor
  • 2022 年 3 月 14 日
  • 本文字数:2722 字

    阅读完需:约 9 分钟

欢迎关注我的公众号 《hockor》,原创不易,欢迎关注转发~


你好,我是 hockor,本文是我观看张鑫旭的直播课 《关于他十二年的写作经验》 所做的学习笔记,其中加入了一些自己的观点,如果你也曾经对写技术文章有过无力、失落的情绪,希望本文能让你重新燃起对技术文章写作的热情。


在每一个技术人的成长之路上,我相信一定或多或少受到过很多技术博客的影响,比如技术论坛方面较为出名的有 CSDN、博客园、掘金等等,又或者是比较有影响力的大佬们,比如张鑫旭、阮一峰等等的自建博客。那么我们为什么要去写技术文章呢?我认为主要价值有以下几点:


  • 提升自己的技术思维能力,加深对技术点的理解

  • 与更多的人进行观点碰撞

  • 传播正能量,进行无私的分享

  • 提升自己的知名度,建设品牌力


那么问题来了,相信很多人曾经或多或少都有过那么一丝冲劲,暗暗说着我也要成为张鑫旭那样的人,我也要成为阮一峰那样的人,但是当自己真的开始盯着电脑准备写内容的时候,发现半天憋不出来一个字,原因也许有很多啊,但是根据我自己的真实感受,大概有以下几种内心想法,你看看跟你的有没有重合的:


  • 我写啥呢?好像这些别人都写过了啊,而且写的比我还好,算了不写了

  • 怎么写啊,我好像只是简单写了个 hello world,我也没用到那么高深的场景啊,算了不写了

  • 太麻烦了,写个文章我还要画图,还要写 demo,太累了,算了不写了

  • 我这文章写的这么干巴巴的,连我自己都看不下去了,算了不写了

  • 哎,上周写的那个文章也没人看啊,我写的意义是啥?算了不写了

  • 评论区有人怼我了,说我这里不对那里不对,太丢人了,算了不写了

  • ......


以上的经历不知道你是否曾经有碰到过呢?对于我自己而言,我几乎都有过,但是当我现在再回头去看,我真的觉得自己有点搞笑,我给自己总结起来就是 3 个字:“戏太多”,在看完张鑫旭的直播课以后,我有了更多的共鸣和想法,接下来我们好好来看看这个问题 - 究竟如何写好技术文章

关于选题

首先是技术文章的选题问题,这也是很多人在成功路上遇到的最大的一个问题,就是不知道自己些什么?


其实技术文章可以写的东西有很多,这里大致分为以下几种:


  1. 新方法/新技术的布道:比如 JS 新特性,或者新的构建工具等等

  2. 技术方案总结类:比如弱网环境下的加载优化机制等等

  3. 优秀框架的体验指南:比如 react SSR 从 0-1 的过程等等

  4. 自己觉得很厉害的小技巧:比如一些独特的优化手段,JS 的黑魔法等等

  5. 原理剖析类:比如 XXX diff 原理等等

  6. 棘手问题的解决方案:比如 CDN 被劫持的解决方案


其中前 3 点是比较适合新手同学入手的,你可以根据自己的实际情况从这些点去做切入。


同时这里还有个小技巧,就会新技术点的获取,你可以去https://caniuse.com/ciu/index 看看,去一个一个的研究这些内容。



对于写作的初心,这里张鑫旭提到了几点忠告:


  • 别总想着一上来就搞个大新闻,别怕让别人知道你是个菜鸟,谁又不是从菜鸟一步一步走过来的呢?

  • 如果你永远在等好的主题,好的灵感,可能你这辈子都敲不出来一篇文章

  • 思考你自己的当下,思考你的一切

  • 实在不知道写啥的时候,写写自己的迷茫,写写自己的困惑,说不定你会遇到一个为你解惑的人

关于内容

对于一篇技术文章,其内容结构主要有以下几点需要注意的

重点突出

我们写一篇技术文章,其实目的应该是很明确的,比如是讲解一个效果还是讲解一个技术结论,所以在写的时候有 2 点要注意:讲结论的先给出结论、讲效果的先放上效果图。


其实原因很简单,你想想你平时看文章,比如一篇文章写的是 webgl 3D 效果,你肯定是奔着效果去的,结果作者从头到尾一张效果图都没有,你看着还有乐趣吗?又或者作者讲解 XX 特性在不同端上的差异问题,结果看到最后都没说明白差异点到底在哪里,试问这样的文章你觉得是一篇合格的技术文章吗?


所以如果你要写一篇技术文章,首先你得搞明白你的目的是什么?是为了给别普及一个概念还是为了展示一个效果,针对自己不同类型的文章再去做重点的突出,你的文章内容就已经成功一大半了。

完整的叙事

关于文章框架,这里有以下一些可供思考


  • 背景

  • 你的思考

  • 你的尝试

  • 你遇到的困难

  • 你的解决方案

  • 最后的结果


你可以在这个标准大纲上做自己的调整,基于这个路径来写一篇技术文章,你的逻辑和结构就会非常的清晰。


最后张鑫旭还提到一个就是针对个人感悟类的文章,他给的建议很直接:你想怎么写就怎么写~

关于表达

文章形式

是不是所有的技术文章都一定是一篇议论文或者是叙事文呢?其实不一定,这里再给出几点不同的建议:

对话类的文章

如果你看过程序员小灰的文章,一定很有体会,这种类似于日常对话的写作方式(如下图),非常有代入感,同时如果你能配上漫画,就更加的厉害了,说不定还可以给自己创造一个 IP。如果你不会画漫画,你可以将内容和微信 / 钉钉聊天框结合起来,网上有非常多的这种工具,也能给人很好的阅读体验。


同人小说类

不知道前段时间大火的《JavaScript 百炼成仙》你是否有听说呢?这种文章你看看是不是一下子让死板的知识点变的生动了起来,而且更容易理解了。


碎碎恋的文章

最后这种,就是类似于张鑫旭的文章风格,你可以亲自去看看读读,这种文章配合一些日常的段子啥的,也能起到非常不错的效果。

换位思考

再写完一篇文章以后,并不代表你的文章就已经可以发布或者推广了,因为我们更多的是站在自己主观的角度来写的,所以为了保证文章的易读性,你还可以从以下几个方面去换位思考一下:


  • 如果我是个小白,这篇文章我能看懂吗?

  • 如果我不认识文章中的缩写词,我能理解这篇文章吗?

  • 我这里要不要加个架构图做说明呢?

  • 我这里要不要加个演示图做展示呢?

  • 我这里要不要加一下代码注释呢,万一对方是个初学者怎么办?

  • ...


以上的换位思考,是张鑫旭觉得写作中最重要的的一个特质,因为通过以上的换位思考,会让我们的表达变的更加的丰富,内容更通俗易懂。


同时还有一个技巧特别重要,就是把自己的文章多读几遍,早上睡醒的时候读一下,晚上睡觉前读一下,说不定读着读着,你的灵感又来了。

保持初心

“展示你最真实的一面”


这是我们写作中最重要的一个准则,在写作中,一定一定要经常告诉自己这段话,你是一个什么样的人,你就写什么样的文章


“我话痨,喜欢扯东扯西”,那就这么干,想到什么就写什么;


“我御宅族”,挺好,多加入自己喜欢的元素,提现宅的气质;


“我喜欢晒自己”,那文章就多配一些自己的图,来展现自己;


“我是个穷酸小透明”,没关系,过得不开心,文章也没必要强颜欢笑,时不时的透出自己的小犹豫也挺好。

关于你自己

  • 不要有功利心,少写 XXX 面试指南,多写真实的 case、感悟

  • 保持自己的风格,维持自己的人设,不要一篇笑嘻嘻,一篇哭唧唧

  • 勇敢写,乐意写,享受写。


以上,与你共勉。



好了,以上就是本文的全部内容了,感谢你看到这里,希望以上内容能对你有所启发和帮助,我是 hockor,欢迎关注我的公众号 《hockor》,我们下次再见~

发布于: 刚刚阅读数: 2
用户头像

Hockor

关注

公众号《hockor》 2019.03.12 加入

7 年前端开发,始于前端但心在远方~

评论

发布
暂无评论
如何写好一篇技术文章_写文章_Hockor_InfoQ写作平台