当前位置: 首页 > 科技观察

如何写出高质量的技术文章?

时间:2023-03-14 23:40:47 科技观察

955一个不喜欢语文,不喜欢读书,作文很少通过的理科生,做梦也没想到有一天我会写一篇文章教大家写文章:)为什么我需要写文章?是的,你不一定能说出来,能说出来也未必能写出来。这是写文章的最大优势,官方术语是“费曼教学法”。写文章是强迫自己深刻理解问题,想清楚问题,整理思路,表达清楚的过程。其实质是自我学习、自我提升、知识体系构建的最佳方法。此外,写文章还有一个副产品——帮助我们扩大影响力。以我为例,大约4年前,我开始有计划地建立自己的知识体系,包括读书、做笔记、写文章、分享。期间连续3年获得年度最佳作者,多篇文章登上头条。此外,阿里科技公众号也发表了我的10篇左右文章,其中2篇入选首发最佳文章,多篇文章阅读量30000+的好成绩。基于这些总结,我在人民邮电出版社出版了一本书《代码精进之路:从码农到工匠》。我也凭借这本书获得了人民邮电IT类年度最佳作者。2、什么是好技术文章关于高质量文章的标准,好文章有一个判断:“文章框架完整,思路深刻清晰,文字至少80%为技术原创干货。”这引起了很多争议。有争议很正常,没有争议才怪。好的技术文章,就像好的技术表现一样,太主观了……很难有一个客观的标准。如果你坚持量化文章的质量,一些指标可能会有帮助。比如文章的浏览量、点赞数、评论数、收藏数等指标。有用,但仅供参考,最终还是需要人为判断。所以抛开这些因素,我觉得好的技术文章至少应该满足两个条件:一是传递有价值的信息。二是要有清晰的结构和逻辑,具有一定的可读性和可理解性。在此基础上,如果能足够文艺、够搞笑就更好了。三如何写出一篇好的技术文章一篇好文章或者一本好书最重要的是要让读者有获得感,要对读者有用,要有话要说。这里的“事”可大可小,不一定非得是个大命题。相反,一篇文章篇幅有限,能把一件“小事”说清楚就已经很不错了。我曾经发表过一篇文章——?,我做的很简单,就是把我在阿里遇到的缩写都整理成一本书。就这样一篇“小文章”,成为了我最喜欢的文章,阅读量近100K,点赞3K。为什么人们对这篇没有“技术含量”的文章如此关注?很简单,很多人很好奇,大家都想知道缩写背后的全称和出处,这就是这篇文章的价值所在。同样,云原生技术介绍、前端技术体系百科、新人入门手册、《马总演讲集》等文章,都属于此类信息整合类文章。另外,那些有自己的技术见解和思考,敢于说真话的文章,也会受到大家的欢迎。比如我觉得很多技术团队不应该有架构师这个职位,所以写了《人人都是架构师:架构是一种能力,不是title!》。我认为很多软件的复杂性来自于工程师的乱七八糟的行为,比如滥用流程引擎。管理复杂性的根源是抽象思维和结构化思维,所以我写了《一文教会你如何写复杂业务代码》。这些文章之所以受欢迎,是因为它们引起了很多学生的共鸣,对他们有所帮助。结构清晰有了好的内容,还要注意文章的结构。就像一道菜,一定要讲究色、香、味。即使你有最好的食材,但菜的外观杂乱无章,也会影响你的食欲,所以不能称为好菜。关于结构,我推荐你看一本书——《金字塔原理》。我也写过很多关于结构化思维的文章。金字塔原理告诉我们在写作和表达时要建立清晰的结构。对于一篇文章,金字塔的顶端是中心论点——通常是文章的标题。围绕这个中心论点,我们可以用多种观点来支撑这个中心论点。如果表达的内容很多,可以进一步细分观点。形成“上下统一,逻辑递进”的金字塔结构。用这种形式写的文章会显得逻辑紧凑。对于技术文章,我们可以考虑使用3W2H模型来帮助我们搭建结构。比如我要写一篇关于抽象能力的文章,我可以从以下几个角度说:What:什么是抽象;为什么:为什么抽象很重要;How:如何抽象;Where:哪里可以使用抽象;多少:多么抽象。同样,我现在写的这篇文章,也是用这种方法来搭建结构:刻意练习开头说了,我以前没有写作的习惯,小时候语文作文经常挂科。后来,我还出了一本书,说明写作作为一种技能,是可以通过实践来学习和提高的。因为多写多练,水平自然就会提高。不过,所谓《刻意练习》(也是一本书)并不是简单的重复,而是阶段性地为自己设定更高的目标,让自己不断进步。比如,现在我可以写得更流利了,我会追求如何把文章写得更吸引人。《风格感觉:21世纪写作指南》中提到了一篇文章,开头是这样的话:“我们都快要死了,我们很幸运……”,这样的冲突感和悬念感自然会吸引读者继续往下看。我在这篇文章中也借用了同样的技巧:)迭代优化写文章和写代码有很多相似之处。我经常拿写文章和写代码做类比。例如,文章和代码都需要结构清晰。再比如,好的系统不是设计出来的,而是迭代出来的。好的文章也是如此,需要不断的打磨和修改。我的很多文章都修改过很多次,重新编排结构,增删信息,调整措辞,直到我满意为止。以当前文章为例。它已经被修改了几次。第一次内容比较散,结构不清晰,有点乱,不知道怎么写下来。后来想到了一个“以身作则”的方法,就是把这篇文章本身作为范例,介绍如何写一篇文章。有了这个想法,经过几次迭代,才逐渐成为一篇像样的文章。所以,敢“写”很重要,不要担心一开始就粗心大意,万事开头难,写……写……你会感觉到的。