首页 > 其他分享 >[转载]如何写出高质量的技术文章

[转载]如何写出高质量的技术文章

时间:2023-12-17 09:12:10浏览次数:24  
标签:一篇 写文章 高质量 技术 写出 篇文章 文章 转载 清晰

  • 作者 | 张建飞
  • 来源 | 阿里技术公众号
  • 原文 | 点此访问

对于一个从小不喜欢语文、不喜欢阅读、作文很少及格的理科生来说,做梦也没想到,有一天我会写一篇文章教人如何写文章:)

一 为什么要写文章

懂了,不一定能说出来,说的出来,不一定能写出来。这就是写文章最大的好处,官方术语叫“费曼教学法”。写文章是一个逼迫自己深入理解问题、把问题想清楚,整理好思路,并能清晰表达出来的过程。其本质是一种自我学习、自我提升、构建知识体系的最佳方法。

除此之外,写文章还有一个副产品——帮助我们扩大影响力。就拿我来说,我大概是在4年前,开始有规划地搭建自己的知识体系,包括阅读、记笔记、写文章、分享。

在这期间,我连续3年获得最佳年度作者,上头条的文章也不少。另外,阿里技术公众号,也发表了我10篇左右的文章,其中有2篇入选了创刊最佳文章,很多篇文章都有3万+阅读的不错表现。

基于这些总结沉淀,我在人民邮电出版社出版了一本书《代码精进之路:从码农到工匠》,我本人也凭借本书获得了人邮IT类年度最佳作者。

二 什么是好的技术文章

关于优质文章的标准,有一个对好文章的判断是:“文章框架完整、思考深入清晰、正文至少80%以上为原创技术干货。”这引起了不少的争议。

有争议很正常,没有争议才奇怪呢,好的技术文章,就和好的技术绩效一样,主观性太强......很难有一个客观标准。

如果硬要对文章质量进行量化的话,有些指标可能有帮助。 比如文章的浏览量、点赞数、评论数、收藏数等指标。有用,但也只是参考作用,最后还是需要人的评判。

所以抛开这些因素不看,我认为好的技术文章至少应该满足两个条件:

一个是要传达有价值的信息。
另一个是要结构和逻辑清晰,具备一定可读性和可理解性。
在此基础之上,如果能做到有文采、够风趣那就更好了。

三 如何写好技术文章

内容有用

一篇好文章,一本好书,最重要的是要让读者有获得感,要对读者有用,要言之有物。

这里的“物”可大可小,不一定非要是一个很大的命题,恰恰相反,一篇文章的篇幅有限,能把一件“小事情”说清楚就已经很不错了。

我曾经发表过一篇文章——《阿里缩写和专业术语大全》,做的事情很简单,就是把我在阿里碰到的缩写全都整理成册。就这么一篇“小文章”,却成了我最火的一篇文章,有将近100K的阅读,3K的点赞。

为什么大家会如此关注这篇没有“技术含量”的文章?很简单,很多人都有好奇心,大家都希望了解缩写背后的全称和来历,这正是这篇文章的价值所在。

类似的,像云原生技术介绍、前端技术体系大全、新人入职手册、《马总演讲集》等都属于这种信息整合类的文章。

除此之外,那些有自己技术见解和思考,敢说真话的文章,也会受到大家的欢迎。

比如,我觉得很多技术团队不应该有架构师这个岗位,所以写了《人人都是架构师:架构是一种能力,不是title!》。我觉得很多的软件复杂度来自于工程师的乱作为,比如滥用流程引擎,治理复杂度的根本是抽象思维和结构化思维,于是写了《一文教会你如何写复杂业务代码》。

这些文章之所以受到欢迎,是因为引起了很多同学的共鸣,对他们有帮助。

结构清晰

有了好的内容,还要注意文章的结构。就像一道菜,要讲究色香味俱全,即使有了最好的食材,但是做出来的样子一团糟,也会影响食欲,称不上是一道好菜。
关于结构,我推荐你去看一本书——《金字塔原理》,我本人也写过不少关于结构化思维的文章。金字塔原理教导我们在写作、表达的时候,要构建清晰的结构。

1.png

对于一篇文章来说,金字塔的顶点是中心论点——通常就是文章的标题。围绕着这个中心论点,我们可以用多个观点去支撑中心论点,如果表达的内容很多,观点还可以进一步往下细分。形成一个“以上统下、逻辑递进”的金字塔结构。

通过这种形式写出的文章,就会显得逻辑清晰,结构紧凑。

对于技术文章来说,我们可以考虑使用3W2H模型来帮助我们构建结构。比如我要写一篇关于抽象能力的文章,就可以通过以下角度去说:

What:什么是抽象;
Why:抽象为什么重要;
How:如何进行抽象;
Where:抽象可以用在什么地方;
How much:抽象到什么程度;
同样,我现在正在写的这篇文章,我也是通过这种方式来搭建结构的:

2.png

刻意练习
开篇说过了,我以前没有写作的习惯,小时候语文作文也经常不及格。后面竟然出版了自己的书,说明写作作为一项技能,是可以习得的,是可以通过练习提高的。

因为写的多了,练习的多了,水平自然就会提高。然而,所谓的《刻意练习》(也是一本书),不是简单地重复,而是要给自己阶段性的设定更高的目标,这样才会持续地进步。

比如,我现在已经能比较流畅地写作,我就会去追求如何把文章写的更加引人入胜。在《风格感觉:21世纪写作指南》里面提到一篇文章,它的开头是这样写的:“我们都会死,我们是幸运的...”,像这种冲突感和悬念,就会很自然地吸引读者继续阅读下去。

我这篇文章也借用了同样的手法

标签:一篇,写文章,高质量,技术,写出,篇文章,文章,转载,清晰
From: https://www.cnblogs.com/zenronphy/p/17908760.html

相关文章

  • 如何写出漂亮代码 https://libin9ioak.blog.csdn.net/article/details/127749042
    从代码的编写规范,格式的优化,设计原则和一些常见的代码优化的技巧等方面总结了45个小技巧: 1、规范命名命名是写代码中最频繁的操作,比如类、属性、方法、参数等。好的名字应当能遵循以下几点:见名知意比如需要定义一个变量需要来计数inti=0;1名称i没有任何的实际意义,没有......
  • 【转载】Springboot2.x 事务
    参考https://blog.csdn.net/MinggeQingchun/article/details/119579941https://www.cnblogs.com/myitnews/p/12364455.htmlhttps://blog.csdn.net/dndndnnffj/article/details/109092116本文代码下载环境环境版本操作windows10vscode1.84.2SpringBo......
  • 直播平台源码,教你如何写出同步与异步
    直播平台源码,教你如何写出同步与异步同步示例代码:console.log("开始");functionsyncOperation(){console.log("同步操作");}syncOperation();console.log("结束"); 输出结果:开始同步操作结束 在上述代码中,同步操作syncOperation()按照顺序......
  • 【转载】liuhangshin NOIp2023假赛记
    day-?CSP2023,我用eps秒就拿到了395pts,少的5pts是不想让自己太骄傲。day0去⑧中试机,由于机房的Vscode不好用,我现场写了114个插件安装上去,现在勉强能够做到编译代码的时间比我写10k代码的时间短。旁边cool_milo一直在问我的ip是多少,怎么有人这么菜啊!NOIp这种级别的比赛还需要......
  • 嵌入式linux下web服务器搭建(转载)
    一、移植编译生成boa二进制文件Boa是一种非常小巧的Web服务器,其可执行代码只有大约60KB左右。作为一种单任务Web服务器,Boa只能依次完成用户的请求,而不会fork出新的进程来处理并发连接请求。但Boa支持CGI,能够为CGI程序fork出一个进程来执行。Boa的设计目标是速度和安全。首先下载......
  • Stable Zero123震撼发布:单图生成高质量3D模型
    模型简介12月13日,Stability.ai在开源领域引起了巨大震动,其最新作品StableZero123成为了焦点。这款基于Zero123模型的升级版本,主要通过改进的渲染数据集和分数蒸馏方法,大幅提升了3D模型的生成效果和训练效率。值得一提的是,StableZero123可以与Stability.ai的高精准图片模型SDXL相......
  • Chat2DB接入文心一言AI教程(原创教程,转载请注明)
    引言关于Chat2DB和文心一言是啥我就不赘述了,由于Chat2DB自带的ai有调用次数限制,所以想着接入百度的文心AI,但是由于网上没有找到相关的教程,此方法是本人研究了一段时间才弄出来的,顺便记录一下备忘,也希望对有同样需求有所帮助!一、注册并实名认证百度智能云账号百度智能云地址:点击......
  • 【转载】Springboot2.x单元测试
    参考https://blog.csdn.net/wangxi06/article/details/114630426https://blog.csdn.net/qq_44381387/article/details/120869168(新版spring-boot-starter-test不再集成junit,而是junit-jupiter,无需@RunWith)https://www.jianshu.com/p/34f57f41af70https://www.cnblogs.co......
  • 360N6线刷参考,最新方法(转载)
    转载自:360N6线刷参考,最新方法-思考的菜鸟-博客园(cnblogs.com)360n6线刷参考线刷包校验服务器停服后的线刷方法大部分参考我写的“360n7root参考”导入的文件可能显示不全,放一个word版的教程在这里:https://files.cnblogs.com/files/twpone/360N6%E7%BA%BF%E5%88%B7%E5%......
  • 【转载】SpringBoot2.x使用Assert校验(非单元测试)
    参考https://blog.csdn.net/yangshangwei/article/details/123105926环境环境版本操作windows10JDK11Springboot2.3.12.RELEASE注意引入的包为importorg.springframework.util.Assert;介绍对象和类型断言函数说明notNull()假设对......