导语 | 在学习和工作过程中,作为工程师的大家都会试着写一些技术文章,或用于沉淀总结,或用于分享经验,或用于传播知识。但是大部分同学在写技术文章的过程中都会遇到这样或那样的问题,导致很多同学都觉得写技术文章是一件很难的事。本文主要目的是帮助更多同学全面掌握写好技术文章的技巧,也祝大家都能下笔成章。
首先,我要问大家三个问题,你有在技术论坛上看技术文章的习惯吗?你有尝试过写技术文章吗?你觉得写一篇技术文章难吗?
如果大家的回答是肯定的,那么大家一定会对本文感兴趣。
对于非技术同学,本文在写作中有一些通用的原则也是可以适用于大家的,相信大家也会有所收获。
需要强调的是,本文所写并非什么金科玉律,只是从一些前人的总结和自己的实践得到的实用经验,帮助大家解决在写文章的过程中遇到的痛点,希望大家看完即可实操起来。
技术文章的定义
既然讨论技术文章,那么首先要定义什么是技术文章。这里的技术文章指分享技术的社区类文章。就比如我们在InfoQ或者微信公众号上常见的那些技术文章。它的内容主要反映技术领域独特的知识,主要体现浓缩后的成果与研究。
注意,它既不是技术文档、也不是学术论文、文学作品、工作报告、学习笔记。它有着自己独特的特点。接下来我们就来剖析一下。
社区类技术文章的类型
在我看来,社区类技术文章主要有四种类型。
大众科普:这类文章旨在面向大多数同学普及某些技术概念或者原理,故其受众面要尽可能广。
深度技术:这类文章重点是深入剖析某项技术背后的实现机制,故技术上深度要足够深。
方案创新:这类文章通常是提出一些创新的技术实现方案,其重点在剖析自己的创新点和难点。
项目总结:这类文章主要讲述某项方案的实现思路和解决方案,重在讲清楚方案的来龙去脉。
图中也给出了各类技术文章的典型例子。大家平时喜欢写哪类的技术文章呢?
社区类技术文章的特点
不管属于以上哪种类型的技术文章,在我看来都具备四种共有特点。这是由技术文章的本质属性决定的。
受众多样:首先,技术文章的受众是多样的,入门者、有经验者、专家都可能成为我们的读者,甚至一些非技术人员也可能成为我们的潜在读者。
格式灵活:在技术文章的定义中可以看出,技术文章不同于其他类型的文章。它并没有固定格式,格式通常是十分灵活的,这也为作者提供了很大的发挥空间。
通俗大众:同样从技术文章的定义出发可知,技术文章不同于高深的技术论文,它的内容要尽可能通俗大众化,只有这样才能吸引更多的读者来读我们的文章。
传播属性:因为技术文章通过都发表在线上媒介,所以自带传播属性。一些“爆款好文”,通常可以起到意想不到的传播效果。
什么是好的技术文章
探讨完技术文章的类型与特点,接下来我们来分析一下什么才是好的技术文章。
首先,“好”的标准本身就很主观。一千个读者就有一千个哈姆雷特。彼之蜜糖,汝之砒霜,很难去立一个绝对化的标准。然而,我个人觉得,好的技术文章仍然具有一些公认的优点,这些优点是值得我们追求的。
首先,基本前提是文章不能有错误信息,这个是底线。除此之外,还有以下几个特点。
干货满满:首先,文章内容要丰富,干货多,这是最重要的一点。
深入浅出:其次,文章通俗易懂、生动有趣,深入浅出,非常易于大家理解。
专业前沿:又或者,文章瞄准技术前沿话题,在专业领域价值很大。
受众面广:最后,文章受众面广,具有一定的普适性。
写技术文章的几大困扰
相信大家也都读过好的技术文章,但是当大家想动笔去写的时候,却通常会面对这样的情况。
困扰1:有写作意愿但是不知道写什么主题,干脆躺平。
困扰2:能确定写作主题但不知如何下笔,直接放弃。
困扰3:文章没有谋篇布局,写起来如流水账一般,逐渐写不下去。
困扰4:好不容易写完了文章,但内容平平无奇,没引起什么反响。
因为这4大困扰,所以导致很多同学“望而生畏”,不愿意去动笔写文章。那么这里我就尝试去分析一下,导致写技术文章难的几大原因。
导致写技术文章难的几大原因
专业性强:技术文章主要反映其领域独特的知识,天然决定其写作门槛较高,且受众面受限。
主题枯燥:技术文章不同于其他题材的文章,通常都给人以比较枯燥的印象。由于其趣味性不足,如题材不新颖则往往难以引起读者兴趣。
原理抽象:相对于其他文学作品(小说散文等),技术文章由于涉及比较抽象的原理,这些原理又无视觉与想象交互,非常难以表达。
题材匮乏:技术文章非常依赖于作者写作素材的积累,若无足够的知识储备则“巧妇难为无米之炊”。
以上便是我对于社区类技术文章的整体特点的分析,在了解了这些特点后,我们可以更加有针对性地制定写作策略,以便更好地抓住读者的兴趣,提升文章的影响力和传播度。
写技术文章的价值和作用
既然写技术文章那么“难”,我们为什么还要写技术文章呢?在我看来,写技术文章对于技术人员有如下价值和作用。
分享和传播知识:技术文章是一种有效的知识传播途径,通过撰写和分享技术文章,我们可以将自己所学到的知识和经验分享给更多的人,帮助他们解决实际问题,提高整体行业的技术水平。同时,这种分享精神也有助于推动技术的不断发展和创新。如果大家都愿意积极分享知识,整个团队和公司就会形成一种技术沉淀积累的氛围,这是一种无形的资产。等到我们自己需要获取知识时,也就可以向知识库寻求帮助。其次,写文章体现技术表达力。技术表达力是提升组织效能,降低沟通成本的软技能。比如:你设计了一个很牛的技术方案,如果无法很好的传递给其它人;又或是你负责一个模块,无法将需要别人需要的内容文档化,这就是技术表达力不足,直接造成了整个组织的沟通成本变高。
学习和掌握知识:写作技术文章的过程本身就是一次深入学习和理解知识的过程。在撰写文章时,我们需要对相关技术进行深入研究,以确保所传达的信息准确无误。这种深入研究有助于巩固我们的技术基础,提高我们对技术的掌握程度。费曼学习法早已证明,学习知识的最好途径就是把它教授给其他人,尤其是不具有相关背景的人。
沉淀总结项目经验:在实际项目中,我们会遇到各种技术问题和挑战。通过撰写技术文章,我们可以将这些经验和教训进行沉淀和总结,形成有价值的经验教材。通过以写代想,以想促讲,以讲验真的方式,我们可以利用上时间的复利,实现更快的成长。其次,写技术文章还能为晋级答辩助力。技术文章的发表相当于众审,可以请全公司的高工、专家在晋级答辩之前提前帮你审视方案的缺漏。而且写技术文章和制作答辩PPT有某种殊途同归的属性,比如都是对项目全盘梳理,挖掘难点挑战,总结解决方案。呈现方式也是有相通之处,例如金字塔原理,黄金圈法则都适用。这相当于提前准备晋级答辩了。
提示个人和团队技术影响力:高质量的技术文章可以展示作者或团队的专业素养和技术实力,提高个人和团队在行业内的知名度和影响力。通过撰写技术文章,我们可以建立自己的技术品牌,为职业生涯发展和团队合作创造更多的机会。同时我们所在的团队也能获利,比如在人员招聘等场景扩大知名度,最终反哺业务的发展。
关于影响力
关于影响力这一点,需要特别说一说。
得到的联合创始人、CEO脱不花曾经在我们公司的一门关于职场软实力的内部课程中讲过,职场人要学会给自己的硬实力“上杠杆”,可以让自己的影响力突破自己所在圈层的两种最好的方法就是写作和演讲。而她本人也是受益于此。
写技术文章毫无疑问也是一个让自己的影响力突破圈层的好方法。
接下来我们进入本文的重头戏,重点介绍一下关于如何写好一篇技术文章的若干实用技巧。
千里之行,始于足下
首先要做到的是调整自己的心态,千万不要因为怕写不好就不敢写,努力大胆尝试起来。
据我观察,其实那些写文章很好的大牛,大部分也不是一开始就能写好的,所谓“好记性不如烂笔头”。写文章也是需要刻意练习的。
所以看我这篇文章,如果只能记住一句话的话,我希望是“我从今天开始就要开始写文章”。
技术文章创作流程
技术文章创作的流程,为了便于记忆,我试着把它们归类为八个方法。并且按照时间先后顺序划为了事前、事中、事后三个步骤。这里的“事”是相对于开始动笔写文章这个动作而言的。接下来我们便一一进行探讨。
同理心
讲这一节之前,我们先来玩个视觉小游戏,请在下面的左图中找到隐藏的五角星。
是不是还挺难找的?但是一旦你看过右边的答案后,再回看左图,是不是很容易就找到五角星,甚至第一眼就看到它了?
这个就叫做“有些事,一旦知道了,就再也回不去了”。
用科学的方法解释,这种现象就叫做所谓的“知识的诅咒”。指的是一旦我们自己知道某样东西,就会发现我们很难想象不知道它的时候会是什么样子。我们的知识“诅咒”了我们。这个原因导致我们同别人分享知识变得很困难,因为我们不易重造听众的心境。
“知识的诅咒”在我们的写作中可以说是无处不在。比如上图左边的文章截图是我前几年写的一篇文章。很明显这是一篇只适合组内同学看的文章,因为其中有太多的背景知识没有进行说明。所以我们应当在文章中尽量摒弃限定上下文的信息,呈现通用的技术方案和思考,最大程度扩大受众面。
俞军说过:用户不是自然人,是需求的集合。同样的道理,读者也不是自然人,同样是需求的集合。你要做的是要将你要写的内容和读者想要看到的内容建立一个桥梁和连接。
费曼学习法指出:如果你真的想确保你的理解没什么问题,就把它教给另一个人(理想状态下,这个人应该对这个话题知之甚少,或者就找个 8 岁的孩子)。检测知识最终的途径是你能有能力把它传播给另一个没有相关知识背景的人。
《金字塔原理》中的TOPS原则的第一条就是Target to our audiences。也就是要从受众的需求点、关注点出发,只有站在对方的角度来阐述问题才能达到有效沟通的目的。
因此在写文章的过程中,我们应当习惯运用“零基思维”,零基思考的核心是让思维回归原点,从头开始思考的方法。我们需要放下以前的思维存量,摒弃所有不起作用的惯性思维。试着站在读者的角度思考,讲清楚“是什么,为什么,怎么办”。最后成文之后还需要找没有相关背景的同学来检验。
接下来是一个实际案例。
这是一个同学写的关于铁道轨道的一篇技术文章(非计算机技术)。大家读完可能会感觉,这段话好像说了些东西,又好像什么也没说,它到底想讲什么?原因很简单,首先,对于文中涉及到的重要概念(文中采用红色背景标出)并没有相关介绍;其次,对于重要的结论(文中采用下划线标出),文中也没有给出相应的因果关系解释。这样,作者同读者之间出现“鸡同鸭讲”的情况也就不足为怪了。
因此,作为一个成熟的写作者,我们最好是在写作之前,列出一个需要确认的问题清单。如下所示,如果没有想清楚这6个问题,就不要轻易进入下一步。
撰素材
第二个步骤是攒素材。很多同学在写文章时,常常会感觉材料捉襟见肘,“茶壶里煮饺子——肚里有货倒不出”。
究其原因,往往是由于做的项目、学习的知识周期太长,到了最终落笔的时候思考脉络早已遗忘。
因此,平时就要养成习惯把一些思考过程用文档的形式记录下来。不用太过细致,一开始也可能会比较混乱,重在记录清楚所有涉及到的重点内容,并且要不断维护和整理更新。对于一个项目来说,如果不记录的话,随着时间的累计,你一定会忘记当时思考的很多细节,也会忘记一些决策的过程。但如果有记录在仍然可以很快就可以自己串起来,这不仅对项目后沉淀技术文章有很大帮助,对晋级答辩的材料准备也是一样有很大裨益的。这就是所谓“碎片化记录,结构化整理”。
有人说世界上的人分为两种,一种是“思辨者“,而另一种是”吃瓜群众”。对于平时遇到的技术问题多问一个为什么是一个很好的习惯。这种技术方案有没有经过深入调研?我们的方案是否是业界的最佳实践?它的本质可以抽象为一个什么技术问题?是否可以应用于其他场景?
最后,平时写的技术设计文档,最后也可能成为很好的技术文章材料来源。所以平时应该要以终为始,写好设计文档。
这里推荐几个可以用于记笔记的小工具:苹果备忘录、Notion、印象笔记、语雀。
定好题
第三个步骤是定好题。写作中的一个很典型的问题是有了素材,却无法确定文章主题。古人云“意在笔先”、“语之所贵者,意也”,这里所说的“意”就是文章的立意,也就是文章的主题。
文章主题的获取需要灵感,那么有哪些灵感来源呢?我这边尝试把常用灵感来源分为以下6类。
工作总结。在互联网行业的项目开发过程中,我们会遇到各种技术挑战和问题。这些经验可以成为我们创作技术文章的宝贵素材。通过总结自己的项目经验,你可以分享你在技术实现上的心得与经验,以及在团队协作中的教训。这种类型的文章通常具有很强的现实意义,能够帮助其他技术人员解决实际问题。工作总结型的文章主题示例有《如何实现一个分布式定时器》、《斩草除根——图计算助力微信反欺诈》等。这种类型文章的重点是要及时把工作中的素材记录下来。
学习材料。学习新的技术和工具是互联网行业技术人员成长的基石。在学习过程中,我们会接触到许多技术文档和教程。这些资料可以为我们的技术文章提供丰富的灵感来源。你可以从这些资料中挑选感兴趣的技术话题进行拓展,或者将所学知识与实际项目相结合,为读者提供有价值的实践经验。学习材料型的文章主题示例有《简单理解Kafka的消息可靠性策略》、《为什么选择b+树作为存储引擎索引结构》等。这种类型文章的重点是要找准合适的切入角度。
热点话题。关注行业热点和技术趋势是获取灵感的一个重要途径。这些热点话题通常具有很强的时效性和关注度,因此在创作这类文章时,你可以抓住读者的兴趣点。你可以从技术社区、博客、技术论坛等渠道了解行业热点和技术趋势,然后结合自己的观点和分析,为读者呈现一个全新的视角。热点话题类型的文章主题示例有《ChatGPT的前世今生——原理解析和拓展思考》、《元宇宙、区块链、NFT是什么?腾讯为什么不能错过?》等。这种类型的文章的重点是需要培养关心时事的习惯。
深挖本质。有时候,我们需要深入思考一个技术问题,从其原理和底层实现上去探讨它。这种类型的文章通常具有很强的技术深度和理论性。你可以从数据结构、编程语言、算法等角度去挖掘一个技术问题的本质,从而为读者提供一个全新的技术视角。深挖本质型的文章主题示例有《浏览器原理之从输入一个网址开始》、《为什么选择b+树作为存储引擎索引结构》等。这种类型的文章的重点是需要有意识地锻炼我们的逻辑思维。
观察生活。实际生活场景是我们创作技术文章的重要灵感来源。通过观察现实生活中的技术应用,我们可以发现许多有趣的技术问题和解决方案。你可以从自己参与的项目或者了解到的其他成功案例出发,分享一些具有创新性和实用性的技术实践。这类文章通常具有很强的实用性,能够引起技术人员的关注。例如《怀疑手机窃听我们讲话,并推送定向广告?》、《王珞丹和白百合傻傻分不清楚?“相似脸”识别帮你治好“脸盲症”!》等都是这类型的文章。这种类型的文章要求我们细致观察生活。
巧用对比。对比是一种常用的表现手法,在技术文章中也同样适用。通过对比不同的技术方案、工具或者框架,我们可以更清晰地展示它们的优缺点和适用场景。在创作技术文章时,你可以尝试使用对比的手法,将不同的技术方案进行对比分析,从而为读者提供一个清晰的技术选型参考。例如《我眼中的腾讯和阿里文化&技术体系对比》、《简单对比腾讯SNG与阿里的运维架构体系》等都是这类型的文章。这种类型的文章要求我们具有辩证思维。
获得了灵感,并不代表这个主题一定适合写作。我们还需要考虑一个问题:什么话题值得写呢?
在我看来值得写的文章主题最好满足以下三点。第一,这个主题是让你有分享欲的,如果自己都没有强烈地想写,还不如不写;第二,文以稀为贵,写之前可以在论坛/社区中搜索一下,较少人写的话题往往更好。第三,文章的内容对他人有价值,不能只为了自嗨。
对于选取好的文章主题,笔者有三个建议。
第一,文章要追求“以正合,以奇胜”。“以正合,以奇胜”,出自《孙子兵法·兵势篇》。是中国古代的一种用兵思想。以奇胜的奇,不念qí,念jī,是个数学词汇,奇数、偶数的奇,古人又称为“余奇”,多余的部分。就像之前谷爱凌和苏翊鸣在冬奥会中夺冠一样,他们在决赛中都用了自己的高难度动作,最终赢得了比赛,这是“以奇胜”。但要展示高难度动作之前,你首先要可以进入决赛,而这就需要扎实的基本功,稳定地发挥为前提,这就是“以正合”的部分,没有这些基本的、常规的能力,根本没办法进入决赛,去展示你的独门绝技,所以也就没有“以奇胜”的可能性。这就是“以正合,以奇胜”的辩证关系,两者都是缺一不可的。
引申到写文章领域,所谓“以正合”,就是用读者熟悉的解读方式、熟悉的意向去讲你的主题,而“以奇胜”就是强调作者自己的思考,利用你的独特观察创造性地区解释读者没有注意到的东西。
第二,主题一定要上升,尽量和一个更大的主题联系起来。比如关于我做的一个定时器的项目,可能按照很多同学的习惯,会使用《浅析微信境外定时器的实现方案》之类的主题,但是我在这里刻意把主题上升了,加入了定时器中一些通用的技术内容,就变为了《如何实现一个分布式定时器》这个主题。
第三,主题应该表明写作动机和构思立意,是核心要点的概括总结。也就是,主题要能概括文章的主要内容,是文章的主线。
一个典型的情况是,很多同学都会抱怨所做的是很平常的项目,没啥“亮点”,更没有任何值得写文章的地方,即使写了也会类似流水账一般。
大部分项目/领域都会有值得分享的地方,只是我们作为熟悉这个项目/领域的人,看法并不与大众一样,会刻意忽略一些项目的亮点和难点,把所有思考过程都视为理所当然。
那么,有没有可以训练我们获取文章主题灵感的方法呢?答案是肯定的。
训练发散思维:打开微博APP找出自己觉得有意思的话题,多想出几个角度再去对照评论区里不同的人写的观点。举个例子,前段时间看到网络上关于香港通过优才高才计划“抢人”的新闻,下面就有评论是关于新加坡的。那么这里就可以引申一个思考角度,研究疫情下新加坡和香港经济所受影响的对比。
训练逻辑思维:在生活中发现的一些有趣现象,层层剥茧,由表及里,不断追问。举个例子,比如某个开车经过的某个路段是事故多发路段,就可以深入剖析是因为什么导致的。是因为此路段货车较多,还是交通规划不合理,还是路灯不够亮,还是长下坡路段?如果是长下坡路段,是否有缓冲带?等等。训练同理心:不要预设读者具有背景知识。请不具有背景知识的人看你的文章。
除了定主题之外,文章的标题也很重要。“酒香也怕巷子深”,起一个好的文章标题往往能起到先声夺人的效果。以下列出一些常用的吸睛标题小技巧,大家可以酌情采纳。
搭骨架
第四个步骤是搭骨架,搭骨架即确定文章的结构/框架。为什么要搭骨架?
脑神经科学证实,越有规律,越贴近旧有认知的,越利于大脑记忆。
上图这个例子可以很好地说明,文章的结构如果有一定的规律,更能给读者留下深刻印象。
文章有个好的结构/框架,首先可以让读者很快就对整个文章的脉络比较清楚,帮助读者理解文章的逻辑,容易给他们留下深刻印象。其次也方便读者直接跳到自己感兴趣的章节进行阅读。
问题是,应该怎么确定文章的结构呢?接下来推荐几大利器。
首先是金字塔原理。
金字塔原理是一种重点突出、逻辑清晰、主次分明的逻辑思路、表达方式和规范动作。不仅可以用在写文章上,在很多领域都可以用得上,比如制作PPT或者思考。
金字塔原理的四大原则是结论先行、以上统下、归类分组、逻辑递进。把你的思想观点组织成金字塔结构。
落实到写文章当中就是应该这么做:
观点先行。在导语和开篇中就亮出观点,吸引读者。
先有提纲。先列目录,再写内容。
承上启下。每个段落之间做合适的过渡和转折。
结尾升华。在文章末尾总结全文,升华主题,拓展思考。
第二个利器是结构化思维。很多同学都遇到过写着写着写不下去或者跑题的情况,这正是由于结构化思维训练不足。任何一篇文章都是结构化思维的产物。很多人觉得写东西太难,其实症结不在于对文字的把握,而恰恰是对缺乏对思维结构的把握。所有文章,必然要有“中心思想”,这就是结构化思维中的“确立目标”;为了表述这个“中心思想”,必然要分段陈述,各个段落有各自的“段落大意”,来支持“中心思想”,这个就是结构化思维中的“资源分析”;提纲出来以后,分段展开陈述形成文字,就是结构化思维中的“制订计划”。
结构化思维的要点是:
自上而下。按照观点->事实->数据的顺序展开。
层次清晰。一个章节内说清楚相关议题,分清楚议题的层次。
结构简单。表达结构不宜太过复杂,“重要的事情说三点”。
重点突出。不要传递过多信息,要把最想传递的信息突出出来。
具体操作上,结构化思维要求我们在思考分析解决问题时,以一定的范式、流程顺序进行,首先以假设为先导,对问题进行正确的界定,假设并罗列问题构成的要素,其次对要素进行合理分类,排除非关键分类,对重点分类进行分析,寻找对策,制订行动计划。结构化思维所涉及的具体技巧,无外乎穿线、归纳、深挖、聚焦四种方法。
怎么分类归纳呢?可以使用大名鼎鼎的“MECE法则”,中文的意思是“相互独立,完全穷尽”。
在写文章方面,当我们手里有很多信息不知道如何归纳整理时,可以使用MECE原则对其进行归类整理,同时还可以扩展思路,发散思维。MECE法则有五种分类法。
二分法。这个分类方式在日常生活中比较常见,其实就是把信息分成A和非A两个部分。
过程法。也就是按照事情发展的时间、流程、程序,对信息进行逐一的分类。
要素法。其实都是把一个整体分成不同的构成部分。可以是从上到下,从外到内,从整体到局部。这种分类方法是用于说明事物的各个方面特征的。
公式法。可以按照公式设计的要素去分类,只要公式成立,那这样的分类就符合MECE原则。
矩阵法。就是把事物按二维矩阵进行分类或划分。
最后,除了“做加法”,我们还要掌握“做减法”的艺术。即简单性原则。
奥卡姆剃刀法则可以简单概括为“如无必要,勿增实体”,它的核心思想是如果一个实体被删除掉也不影响问题解答,那么这个实体就不应该引入。
奥卡姆剃刀法则的三个原则:
结构简单原则。按照金字塔原理确定的结构,应该是以中心思想为核心展开的,整个结构给人的感觉是“内聚”和简洁的。
文字简省原则。尽量使用较短的语言和篇幅来描述一个问题。
通俗原则。尽量少写生僻的文字和晦涩的内容,使用平易近人的语言,追求文章的通俗性。
根据奥卡姆剃刀法则,文章的结构最好不要超过3层,同一层次列举项目最好不超过7项(科学实验证明,人在短时间内能够记住的记忆容量为7+-2),最好为奇数(因为奇数给人一种紧凑感)。
最后再给大家提供几个万能文章结构模板,以便大家在完全对于文章结构没有头绪的时候可以直接套用。
工作/项目总结型文章模板
这里主要依据是黄金圈法则(why-how-what)
Why:目的、意义、目标
How:方法、措施、路径
What:执行、步骤、成果
新技术科普型文章模板
深挖本质型文章模板
技术本质文章通常比较枯燥,需要注意结论先行,一开始就吸引读者的注意力。
画好图
相信看过技术文章的同学都会遇到大段文字读不下去的情况。这里就涉及画好文章配图的问题。
所谓“一图胜千言”,大部分人都是先看图再看字,这是有科学依据的。科学证明,人脑处理文字信息与图片信息的区别:人脑处理图片信息是同步进行的,而处理文字信息则是一步一步循序渐进的。人脑处理图片的速度是处理文字的60000倍。
配图并不一定是配角,例如有研究表明,人在看报纸时,99%的文字信息会自动被过滤掉,脑子里只残留了可怜的1%。
例如图中关于文件加密存储的示意图,如果要通过文字来表达的话,则需要花费许多笔墨,而使用配图就很一目了然。
这里推荐我常用的几个画文章配图的工具:PowerPoint、Excalidraw、ProcessOn、draw.io、Sketch。
这是两个技术文章配图的示例。
有干货
说一千道一万,决定一篇文章质量的最重要的因素还是:有干货,言之有物。以下是关于怎么让自己的文章干货更多的若干建议。
更高的抽象层次,尽量避免描写过多技术细节,上升为方法论
专业性,在自己熟悉的专业领域写作,避免传达错误信息
有深度,体现在领域的全面掌握
加入基于自身实践的理解,而非翻译
勤润色
很多技术很好的同学都会遇到这样的问题,虽然我们的文章主题不错,结构也还可以,内容干货也比较多,但是语言晦涩,排版不好。这样就会导致我们的读者读着读着读不下去。这时候就要求我们在文章发布之前多润色几遍。
润色可以从三个角度来进行:语言、章节、排版。
语言润色的目标是追求精简、准确、生动。
语言精简的具体做法可以概括为少即是多、内容分段、推敲文字。
少即是多,说的是要用尽可能短的篇幅来表达一句话。其实也和前面的奥卡姆剃刀法则相呼应,只不过之前说的结构,这里说的是语言。
内容分段则是指我们的文章需要将内容拆分为不同的段落,这样可以让文章更加清晰易懂,方便读者阅读和理解。
推敲文字可以从删华而不实文字、删主观感情色彩文字、删重复啰嗦句子三个方向去进行。
语言准确的具体做法包括尽量使用专业术语、多使用定量描述、使用职业化语言代替生活化语言等。
语言生动的具体做法包括巧用比喻和多举例子等。需要注意的是准确和生动并不矛盾,而是相辅相成、辩证统一的两个方面;在专业术语上和行业共识的描述上追求准确,在表达方式和思路的阐述上追求生动。以下是两个实际例子。
章节润色的目标是追求章节连贯、过渡自然。
排版润色则有较多实用技巧,例如:
不同级别标题,但不超过3层
每个章节长度适中
句子不宜太长,多使用标点
写完后通读,避免错别字
最后,我们还可以利用AI来帮助我们润色文章。可以做的事情包括扩写内容、优化逻辑、简化语句、补充例子、提升表达、漏洞检查等。当然切记不要造成信息泄露,同时AI润色的结果需要人工最终确认后才可以发表。
总而言之,就是要多“迭代”几个版本,反复打磨自己的文章。
这里送给大家一句话:把复杂的东西讲简单,把简单的东西讲深刻,都是比较难的事情。
练内功
最后,练内功是指如果有可能的话,尽量养成多读书的习惯(不仅限于技术文章)。好的文章和书籍,可以学习到很多好的行文习惯和写作思路,对写好技术文章很有帮助。
我的内功修炼心得可以概括为:
多读多看,有意识地积累素材,好的素材用笔记等工具记录下来
多模仿,高手都是从模仿开始的
多写,刻意练习
不要怕写得不好,事后复盘,逐渐改进
有几个固化的思维误区,特此指出,希望对大家有帮助。
所有的技术知识都适合通过写文章来表达
知识的沉淀和分享并不一样要通过写技术文章来传达,有的更适合通过技术文档记录,而有的更适合通过PPT来表达。
文章热度等于文章质量
阅读量和收藏量这两者最多只是正相关。比如有的文章标题吸睛,或者话题自带流量,又或是受众面广,阅读量自然比较高。而另外一些因为太过专业导致受众面小的文章可能阅读量不佳,但其实是“沧海遗珠”也很有可能。因此一般的社区都会有小编人工推荐的功能,可以避免这类文章被埋没。
写技术文章和写论文一样
很多同学学生时代都写过学术论文。但忽略了其实技术文章的写作和论文有所不同。首先论文行文非常正式,技术文章相对更为通俗大众,因此可以使用较为接地气的语言,还可以加入具有表现力的图片(甚至表情包)。论文需要追求学术上的绝对严谨性,而技术文章重在分享,不一定要做到面面俱到,滴水不漏(当然也要做到基本的技术严谨性,不能有错误信息)。
总结
“兵无常势,水无常形,能因敌变化而取胜者,谓之神” ——《孙子兵法》
请大家记住,以上方法都并非什么教条。好的写作者能够因实际情况,确定不同的主题和架构,最终取得很好的效果。与大家共勉。
扫码添加 “鹅厂架构师小客服” ,加入【鹅厂架构师圈】,与技术爱好者、技术关注者分享交流,共同进步成长,欢迎大家!↓↓↓
关于我们
技术分享:关注微信公众号 【鹅厂架构师】