关于写作:如何搭建文章结构常见技术文章的逻辑框架

43次阅读

共计 5754 个字符,预计需要花费 15 分钟才能阅读完成。

开场白

输入倒逼输出

作为一个技术人,咱们往往都沉浸于技术的陆地中学习。在学习技术的过程中,咱们一直的在输出常识,同时咱们也须要关注输入。输入是也一种学习的过程,无论是写博客、写文章、写书,还是做分享、做演讲,都是一种输入的过程。有时输入是你保持学习的能源,有时是你坚固和总结学习的过程,有时是你向他人传递常识的形式。” 费曼学习法 ” 其实就是输入的一种模式,它的核心思想是:如果你想要学习一件事,那么你就须要把这件事教给他人。

说到输入,其中一个十分重要的技能就是写作,写作是一种思考的过程,也是一种沟通的形式。在写作的过程中,咱们须要思考的问题有很多,比方如何取题目、封面配图、如何搭建文章构造等等。

我也是一个技术博主,在写博客的 6 年工夫外面,我也一直地在积攒和思考,如何去更好的写作。明天,就围绕着如何搭建文章构造,如何进行取题目、封面配图等等,我将一个开发的视角分享一些我本人的教训和思考,心愿可能帮忙到你。

当然,上面的分享针对与文章、博客类型,对于书籍或是论文的写作有着更加业余的要求,这里就不做过多的探讨。因为自己对于后端的常识更加相熟一些,所以文章中具体的案例会偏差底层一些,但不必过多放心,你只需了解形象的概念,具体的案例我置信你也就能了解了。

为什么要写好?

我置信,你既然看到了这里,肯定曾经解决了第一个问题,为什么要写。我感觉无论写作的内容是什么,只有你踏出第一步,那么我就感觉你比许多人要胜利了,因为你曾经开始了,而不是始终在想要开始。那么我次要来探讨为什么要写好。

尽管说技术文章,不像写散文、记叙文,须要富丽的词藻或者是一些倒序插叙的写作手法,所以咱们经常看到的就是非平淡无奇。但并非说它的行文就能够没有章法。

有人可能会说:技术文章的重点不应该是内容吗?

没错,当然!技术文章的内容往往是吸引人的要害,作为一篇技术文章,他人想要读的前提就是他对你说的这个常识不理解,或者是对于你说的这个问题没有答案。所以我一开始就感觉,只有我的文章中有你想要的答案,就能够了。

然而当我拜读了许多的文章之后才发现,原来不是这样的。厉害技术文章不仅仅是内容,逻辑框架十分的重要。逻辑框架清晰的文章能让读者迅速理清思路取得常识,同时还有以下几个益处:

益处 1:不便回顾

技术写作的其中一个目标,应该是本人对于一个技术或者常识的当下了解,它很多时候承载了你的笔记这样一个性能。所以,当几个月或者是几年后,当你想要查问过后的解决问题的思路时,一个好的逻辑框架能十分疾速的帮回忆起你过后的想法并找到答案。

益处 2:建设正向循环

写作写好的另一个微小益处,就是可能取得读者的认可,当你的文章容易被他人浏览的时候,他人才会给你更多的意见和倡议,这样的倡议往往能促使你更好的写作,从而造成一个正向循环。写作 -> 倡议 -> 写的更好。

益处 3:疾速创作

有时候,当你想要写作时,往往只是一个念头或者想法,想要成文,还须要破费很多的工夫。你须要围绕你想要写的主题,来构思整个文章的前因后果。而一个好的逻辑框架可能帮忙你疾速的把想法转化为文字,从而疾速的创作。有了一个好的骨架之后,你只须要一直填充,一篇逻辑清晰的文章就能迅速成型。

我常常会应用的一种创作思路就是,积攒 + 总结。比方,当我对于一个新的意识有本人的认识时,我马上将它在笔记上记录下来,而后再一周内一直地积攒相关联的常识、背景、材料等等,最初再周末的时候将它们整合到一起,从而造成一篇文章。因为很多时候以后你对某个常识的了解是全面的,不残缺的,在寻找相干材料的过程中能让你对它有更加粗浅的了解。

而在最初整合和总结的过程中,就须要用到咱们上面要讲的逻辑框架了。

问题提醒

提出问题不仅仅是为了吸引读者

第一个框架,也是我最罕用的一个行文思路,就是提出问题。许多的技术文章并非写的不好,而是没有一个好的逻辑框架,导致读者在浏览的过程中很难了解作者的思路,从而导致文章的浏览完成率很低。

而针对与技术文章,特地是一些艰难的技术剖析文章,往往就会有一个问题,就是我看着看着,就没有方法了解这个常识了,或者说我看完就看完了,但如同又没学到什么货色。

那么,或者应用问题提示法就能帮忙你解决这个问题。

框架

  1. 提出问题
  2. 解决 / 答复 问题过程
  3. 总结和晋升

你必定会说,这么简略?这不就和我当初写的事变剖析报告差不多吗?先列举问题,而后剖析问题产生的起因,如何解决避免下次呈现。

没错,很多时候简略的货色往往容易被人疏忽应用。最要害的是它能用在何处?

举例:源码剖析

如果,你对技术比拟喜爱,对于一些开源的技术实现,学习源码往往能让你疾速了解这个我的项目,并且能学到很多编码设计上的技巧。所以源码剖析类的文章也挺常见,然而许多文章有一个统一的问题,他们的文章大多数就是将代码的跳转路线通知你了:

入口在哪?从那个办法进来,到那个办法去,这个办法是做什么的 …. 等等,当你看完之后,你就会发现,你剩下的简直没有,回过头你发现你等于没看。或者是当整个我的项目非常复杂的时候,往往办法和类的扩大很多,导致你看到最初,你都不晓得在哪里了。还不如本人运行代码,跟着断点调试来的不便。

那么,文章的问题出在哪里呢?咱们要如何应用这个框架改良呢?没错,正当的设计问题,也是在考验你对于整个技术实现的了解。比方你能够这样设计问题:

在浏览源码之前,你能够思考一下,如果是你,你将会如何实现它?

再比方:

为什么这个技术能解决的如此迅速?起因是什么?

而后,当你在叙述整个源码实现的过程的时候,你就能够时时刻刻围绕这个重点去论述:

比方:这里数据结构的设计对于整个实现是有很大帮忙的,如果我设计,可能无奈想到用这个构造,当前能够用到

比方:你能够写,不要遗记咱们的问题,关键在于如何迅速解决,没错,这里就是问题的要害,因为这里用了 …. 技术 … 能帮忙它更快的解决 …

最初,不要遗记,在总结的时候再次答复这个问题,让读者肯定产生:哦,原来是这样的感觉。

劣势

那么应用这个框架所构建的文章就很显著,让你本来平淡无奇的文章有了一个主心骨,本来无依无靠的零散的知识点,都是为了这个主心骨服务的。

这样,读者在浏览的过程中就会时时刻刻围绕着这个问题去思考。即便当咱们有很多很简单的我的项目时,咱们的问题也有有多个,只有围绕着问题去写,读者就能迅速将思维更上,从而不乱。

并且,就像后面说的,当你很长一段时间回过头来温习的时候,你不须要看整个文章,你只须要口述答复你最后面提出的问题,你就能迅速回顾起来整个知识点。

扩大

当然这样的框架并非只能用在源码剖析的文章中,还有相似的还有剖析框架、剖析两头实现等等,都能够尝试用这样的框架去构建,会让文章更加清晰。

单刀直入

即便间接上论断,读者也不会逃跑

在学校的时候,老师总是会通知咱们,写作的时候要有一个单刀直入的思路,也就是说,你的文章要有一个明确的主题,而不是一上来就开始写,而后到最初才说,这篇文章是对于什么的。

而在当下,厉害技术太多了,很多人都喊着学不动了,躺平了。并且在短视频,这样短频快的节奏之下,曾经很少有人能急躁认真的看完你的文章了。

那么,反馈到技术文章,大多数人谋求的是什么?答案,他们只须要一个论断,其余的全副略过,晓得论断好像就晓得了全副,如果在文章中,无奈迅速找到论断,那么他们会迅速切换下一个搜寻后果。

这也是为什么很多时候在搜寻英文报错的时候,很多人看着英文文章无奈找到答案,无奈解决问题,其实答案就在其中。那么此时,咱们就须要用到这个框架。

框架

  1. 间接上论断
  2. 实践论证
  3. 总结起因

间接上论断,会不会导致读者就看个论断而后就走了呢?让咱们缓缓往下说

举例:技术选型

很多时候,在实现一个性能或者一个需要的时候,有很多的计划供咱们抉择。常见的就是两个开源我的项目的是实现,或者两种技术计划的比照。当咱们在做抉择的时候,往往就会去具体调研两种不同技术的劣势和劣势。又或者是只有一种技术,用与不必也是一种抉择。用是因为什么,不必是有什么起因。

那么对于这样的文章,咱们就能够尝试使用这样的框架去写。

首先,咱们能够上来就间接阐明,我认为:应该抉择应用这个技术,并且我曾经将之实际了。

而后,你就开始从各个维度进行论证,为什么:

  1. 比方从应用角度
  2. 从代码的实现角度
  3. 从保护老本登程

在论证中,最能给到用户必定的就是数据,如果你能拿出你的理论测试数据来谈话,会更加有说服力。

最终,你是在什么样的场景下,做出了什么样的抉择。并且能够总结很多实际过程中,呈现的问题。

劣势

这样的写作框架与说明文的写作有着相似的情理,劣势在于:

  1. 疾速让读者晓得你的观点
  2. 清晰的论证让你有足够的靠山
  3. 最终让读者清晰的明确你抉择的场景,是否他有参考的意义

起因

很多人就会说,他人必定会看了结尾就走了。但其实理论并非如此:很多人其实在看文章的时候一开始都是大抵扫一眼,去搜寻他们想要的信息,而当他们无奈找到信息的时候就会走。

而看了这个结尾的用户往往反馈就两个:

  • 批准你的观点
  • 不批准你的观点

对于批准你观点的人,无非就两种,一种是曾经对这个常识十分相熟了,这样的人其实并不是你的受众,你这样做十分能够节约他人的工夫。还有一种就是他批准你的观点,然而,只是他的一个集体想法,并没有人反对,那么他会持续看上来,找到你这样说的理由。

同样的不批准你的人也是相似的情理。抓住了用户的第一眼,很多时候就能绑住用户。

扩大

当然 技术剖析、项目分析、劣势剖析,等等文章都能够应用这样的形式去写作。

铺垫根底

让你的文章满足更多受众

对于特地难得知识点或者问题,咱们往往须要一些前置的常识来做铺垫,铺垫的好与坏间接就决定了文章的浏览体验。

我也常常在看一些底层技术的文章,对于同一个内容,有的文章浏览很顺,从头到尾,读完就学会了;而有点文章就很难,看完之后你还须要去找别的文章,最终拼凑出你想要的后果。

于是乎,有时,对于特地艰难的技术阐明类型的文章,我就会尝试采纳这样的写作框架来帮忙我。

框架

  1. 前置逻辑 / 常识储备
  2. 推导中间状态
  3. 最终得出结论
  4. 援用各类观点

举例:难点技术

这里的案例我切实是找不到适合所有读者的说辞,只能以具体的一个案例进行阐明,我会尽可能用大家都懂的语言来解释。

“IO 多路复用”是一个非常复杂的技术难点,如果间接上来就通知读者,它是怎么做的,如何实现的,而后贴一贴代码,这样很难让人明确。或者说不太敌对

那么,如何去做铺垫呢?你能够从以下几个方面着手:

  • 用户空间和内核空间
  • 过程切换与阻塞
  • 文件描述符是什么
  • 规范 I/O 怎么的
    而后,你就能够牵强附会的推导出 IO 多路复用的实现原理,以及和规范 IO 相比它的劣势在哪?为什么要用它。

当然,在得出结论之后,我的倡议,这样类型的文章,你想要晋升,肯定要给一些文章站稳脚跟的链接,并且对于一些知识点,你能够援用你之前写过的博客链接,这样不仅能缩短用户的寻找工夫,还能帮忙你其余博客的引流,也算是一个小技巧吧。

起因

对于艰难的常识,很多人其实难以了解的起因往往是因为前因后果没有搞清楚,前置的基础知识没有把握,你间接通知它最终的论断,往往会很难让人明确。

劣势

这个框架对于读者来说十分的敌对,相当于老手和只知其一; 不知其二都能真正在你的文章中“牵强附会”。
而这个框架我特地喜爱的还有一个起因是:在写作的过程中,它帮忙我去回忆起之前很多的知识点,帮忙我在不经意间构建了整个常识网络,让我明确这个知识点在我的整个网络中处于哪一个节点,与之相邻的问题是什么。

扩大

这样的框架不仅实用于较难常识或技术的阐明,我还发现在一些框架和开源我的项目的阐明中有所体现,他们会间接援用一开始他人根底的实现逻辑,而后阐明其中的问题,推导到他们降级的起因,从而阐明他们新技术或者新设计的劣势,整体下来零打碎敲。

容易被疏忽的注意事项

在搭建文章构造,还有一些别的注意事项,我想做一些揭示

不同平台内容量各不同

首先在搭建文章构造之前,你应该确定这个文章想要公布在什么中央。在不同中央公布的时候,内容量是不一样的。我常常能在一些公众号的推文题目看到“万文长字,剖析 xxx 技术”又或者是“看这一篇就够了 xxxx”而后点进去哗啦哗啦十分的长,在手机上观看极为不敌对。

所以,针对与不同的平台,你在设计的时候须要思考内容的不同,当内容过长时进行拆分。比方,针对一个特地零碎的设计剖析,你能够拆分成专栏的模式进行谋篇布局,将本来的内容拆分成为几个小局部,而后在前后减少连接的内容,从而造成一个体系。

我在写博客的过程中,也常常会剖析一些成体系的内容,将他们拆分后归类到一起,对于读者来说更加敌对,每次看的不多,了解没有累赘,而又在一起,互相只有有分割。

代码如何展现更优雅

不要截图!不要截图!不要截图!

重要的事件说三遍。我一开始写博客并且到前面有很长一段时间都是在截图,特地是对于一些源码剖析。过后的想法是,截图一张图片能放下大段大段的代码,不必占用很多篇幅。直到有读者向我反馈问题:图片看起来有时候不清晰,太小或太大,最大的问题是无奈复制粘贴,没有方法进行搜寻。所以,从那之后我就根本辞别截图了。

开源有外链

如果是对于开源的代码剖析,记得加上外链,能不便用户迅速定位到代码段,找到原始办法进行追踪。

可运行的教程要残缺

如果你给出的是一个教程或者一个能够运行的残缺示例,请肯定要保障完整性。我无数次会发现从网上拷贝过去的代码无奈应用,而一些博客没有留言性能,最初一点点写才发现,哦,原来对方遗记上传了其中某个办法的实现,而这个办法十分要害 ….

开源代码剖析可缩量

针对于开源的代码,没必要整段整段的拷贝,一方面的确篇幅太长了,占用了文章大量的资源。并且读者不好浏览,其实咱们在剖析代码的时候往往抓住的是主线,所以其中没有围绕主线的局部你能够手动删除并做正文,缩量之后会让整个构造更加清晰。

总结

当然,说了这么多,对于写作的框架还有很多,这里只是列举出我当初罕用的一些,心愿对你有所帮忙。当然,写作框架诚然十分重要,然而它须要你缓缓去总结和摸索。所以对于不同的人来说,我给出以下的倡议:

  1. 刚开始写作的同学:无论是什么,只有你去写就好,尽量谋求易懂。
  2. 写作了一段时间的同学:请尝试使用一些技巧和框架去让你的行文更加晦涩,让你的文章能被更多人点赞。
  3. 写作了很久的的同学:缓缓积攒本人的写作思路,建设起成熟的体系,造成本人的格调,能疾速建设你形象,从而播种越来越多的粉丝。
正文完
 0