收藏!打造高质量技术文章的 8 个技巧
在信息爆炸的时代,写作不仅是一种表达,更是一种影响力的体现。无论是为了提升个人品牌,还是为了增强团队的技术氛围,或是推动公司的技术影响力,一篇高质量的文章都能起到关键作用。
今天给大家分享打造高质量技术文章的 8 个技巧,由零售技术后端开发工程师孟东同学所总结。帮助大家提升文章的质量,激发大家的写作热情,共同推动技术交流与知识传播的进程。
1、换位思考
应当试着站在读者的角度思考,讲清楚。是什么?为什么?怎么办?
试着想清楚以下 6 个问题,如果没有,不要轻易进入下一步。
1. 你写这篇文章的目的是什么? 2. 你的目标读者是谁? 3. 读者对于该主题的知识储备如何? 4. 读者对于什么内容更感兴趣? 5. 读者关于这个主题,可能的痛点和需求点是什么? 6. 你希望读者读完获得什么收益?
-根据我写的《万字长文,聊聊我在锦礼成长的这一年》的总结,给大家一些想法,再写这一篇文章的时候,我最初的目的是写纯技术题材,总结一下锦礼侧的一些技术方案,因为作为一名研发嘛,但是如果仅是技术类,别说产品同学,就连同是技术同学,在不一样的业务模式下,大家都会不明觉厉,因为隔行如隔山,会有一定的差异性。后来将纯技术内容与更广泛的主题(关于成长和沟通的)相结合扩大受众范围。这种做法类似于在电商领域中增加产品种类、产品功能的方式来扩大需求端,产生更大拉力的概念,因为多元化内容可以使原本只对技术感兴趣的读者群体之外的人们也对文章产生兴趣。
内容专注和受众广泛矛盾吗?并不一定矛盾,不同的内容分类对应不同的受众人群。这个我已经替大家证实了,因为在这篇文章发布后,有产品和业务同学给了我很多反馈。
2、灵感笔记
一些思考过程和想法用文档的形式记录下来。不用太过细致,一开始一定会比较混乱,重在记录清楚所有涉及到的重点内容,并且要抽时间维护和整理。有记录在就可以很快出起来,这就是所谓的"碎片化记录,结构化整理"。
没有灵感怎么办?
1. 平时记录思考过程和想法 2. 认真写设计文档 3. 参考同类型文章 4. 请教技术专家
灵感的获得有偶然性,要养成随时记录灵感的习惯。推荐几个可以用于记笔记的小工具:苹果备忘录、幕布、文件传输助手····
分享一下近期我的文件助手中的部分素材:
-风是透明的河流,雨是冰冷的流星。 摘自李娟《我的阿勒泰》
-用尽量少的产品满足用户最关注的需求,是一种超凡的能力。少就是多,背后是极为精准的行业发展与用户需求洞察、极为清晰的产品/战略思路,以及基于强大产品力的超凡自信。摘自雷军《小米创业思考》
-请不要相信,胜利就像山顶上的蒲公英一样,唾手可得,但是请相信,世上总有一些美好的值得我们全力以赴,哪怕粉身碎骨。摘自足球诗人贺炜
-到目前为止,我们都将重点放在了防止可靠性和安全故障的设计原则和实现方法上。不幸的是,想要达到完美的可靠性和安全性,成本通常很高,因此不切实际。我们必须假设预防机制有失败的可能,因此需要制订计划来检测故障并从故障中恢复。摘自《Google 系统架构解密:构建安全可靠的系统》
3、选题三则
在我看来,值得写的文章主题最好满足以下三点。
1. 这个主题是让你有分享欲的。 2. 文以稀为贵,写之前可以在论坛/社区中搜索一下,较少人写的话题往往更好。 3. 文章的内容对他人有价值,不能只为了自嗨。
比如: -《理解 Kafka 设计理念》 -《哎呀,当时怎么没有想到》 -《从校招新星到前端技术专家的成长之路》 -《“深淘滩,低做堰”,快递快运终端技术 618 保障之路》 -《ChatGPT 是如何产生心智的?》 -《一群 AI 卖保险的程序员》 -《网易云音乐崩了!冲上热搜第一...让我们复盘一下》等等
4、文脉架构
文章有个好的结构/框架,首先可以让读者很快就对整个文章的脉络比较清楚,帮助读者理解文章的逻辑,容易给他们留下深刻印象。其次也方便读者直接跳到自己感兴趣的章节进行阅读。
这就不得不提一下金字塔原理了,金字塔原理是一种重点突出、逻辑清晰、主次分明的逻辑思路、表达方式和规范动作。
四大原则如下:
结论先行:只有一个中心思想,并且放到最前边。比如:在引言和开篇中就亮出观点,吸引读者。
以上统下:一个层次上的思想,都是下一层次思想的总结和概述。比如:每个段落之间做合适的过渡和转折。
归类分组:把具有共同点的素材进行归纳分组。比如:先有提纲:先列目录,再写内容。
逻辑递进:同一组的思想具有某种内在的逻辑关系。比如:在文章末尾总结全文,升华主题,拓展思考。结尾给出展望。
5、图胜千言
相信看过技术文章的同学,都会遇到大段文字读不下去的情况,特别在这个短视频的时代。这里就涉及文章配图的问题。
一图胜千言,大部分人都是先看图,再看字,这是有科学依据的。人脑处理图片信息是并行的,而处理文字信息则是串行的。人脑处理图片的速度是处理文字的 6 万倍。
特别在技术设计上,如果靠文字描述解释清楚,那是极其晦涩难懂的。通过一个架构图,或者流程图能够使复杂问题简单化,抽象问题具体化。类比我们在数学中使用到的数形结合思想。
推荐几个画图的软件 :Excalidraw、joyspace、亿图
6、内有乾坤
说一千道一万,决定一篇文章质量的最重要的因素还是:内有乾坤,言之有物。
避免成为了标题党,导致外强中干。就像我们打开一个商品标题规格描述不一致,打开文章后,给读者不好的体验。
以下是关于怎么让自己的文章干货更多的一些建议:
1. 更高的抽象层次,尽量避免描写过多技术细节,上升为方法论。 2. 专业性,在自己熟悉的专业领域写作,避免传达错误信息。 3. 有深度。体现在领域的全面掌握。 4. 加入基于自身实践的理解,而非翻译。
7、精雕细琢
很多技术很好的同学都会遇到这样的问题,虽然我们的文章主题不错,结构也还可以,内容干货也比较多,但是语言晦涩,排版不好。这样就会导致我们的读者读着读着读不下去。这时候就要求我们在文章发布之前带着工匠精神去精雕细琢,多润色几遍。
那么如何润色?
1. 润色可以从以下三个角度:语言、章节、排版 2. 语言润色的目标是追求精简、准确、生动
写完后,通读自己的文章几遍。需要注意的是准确和生动并不矛盾,而是相辅相成、辩证统一的两个方面,在专业术语上和行业共识的描述上使用客观的、严谨的数据和事实,在表达方式和思路的阐述上追求生动。
记得之前有看一些漫画类的技术文章,比如如何给女朋友解释什么是负载均衡等等这类的文章,通过生活中常见的例子通俗易懂的描述了技术点。
这个也尤其重要,毕竟把复杂的东西讲简单,把简单的东西讲深刻,向来不是一件容易的事情。
8、博观约取
“博观而约取,厚积而薄发”。出自苏轼《稼说送张琥》这里指:广泛地观察(阅读)并从中提炼精华。
如果有可能的话,尽量养成多读书的习惯(不限于技术文章)。好的文章和书籍,可以学习到很多好的行文习惯和写作思路,对写好技术文章很有帮助。
当然技术同学肯定都比较忙,我平时采用的是听书,听 B 站,看技术文章,并且过程中,有意识的积累素材,比如在文章中我会引用罗翔老师的话。另外就是多模仿,站在巨人的肩上去看世界。多写,刻意练习。不要怕写不好,事后复盘,逐渐改进。
很多同学会有这样的想法,一直纠结要不要写一篇呢?写的不好会不会怎么怎么样。不要想这么多,很多事情就像旅行一样,当你背上行囊出门那一刻,最困难的部分其实已经完成了。
版权声明: 本文为 InfoQ 作者【京东零售技术】的原创文章。
原文链接:【http://xie.infoq.cn/article/18d4dffbb5cdcc20169bf7a46】。文章转载请联系作者。
评论