如何写出高质量的技术类文章?
序言、为什么写这篇文章
在程序员的世界中,有一条广为人知的“鄙视链”:“Talk is cheap, show me the code”。这句话常用来强调代码的实际价值,而轻视那些夸夸其谈的人。我们常常把这句话奉为圭臬,然而,生成式 AI 让这句话发生了反转,现在是“Code is cheap, show me the prompt”。让 AI 生成代码、让 AI 生成文字、让 AI 生成 XX,“talk”成了影响 AI 生产力的核心因素。
在实际工作中,不论是技术规划、技术交流、技术方案等,都需要通过文字来表达,我把这些文字统称为技术类文章。文章写得好可以极大提升自己的技术影响力,但写技术文章无疑是比写 prompt 更复杂、更困难的任务。身边很多程序员同事会因为觉得日常工作过于简单而无事可写,或因为自己“小时候语文不好”而无从下笔。如果再要求要写出深度,就更是“难于上青天”了。
写出高质量的技术类文章通常意味着清晰的选题、充分的调研、深入的思考,以及清晰有逻辑的表达。笔者在近两年累计写了百余篇技术类文章,以下是我对写作“套路”的经验总结,欢迎批评指正。
一、以“问题”驱动选题
写技术类文章不是“为赋新词强说愁”,它的首要目标是解决现实问题。现实问题可以是要对某个方案达成共识,可以是一次向上汇报,也可以是围绕自己的经验教训做分享。例如,在国内企业大规模出海的过程中,肯定会面临多国家部署、多时区、多币种等问题,对于这类问题是否有最佳实践,是否能沉淀成架构模式,或是指导手册,或是工具能力?
还有一种选题思路是“举一反三”,遇到一个小问题,可以思考在更大范围内该问题是否也存在,或者其他同类型的问题是否存在。例如,某个技术类工单是因为网络抖动导致调用下游失败,可以思考针对下游异常的通用重试策略是怎样的?如果遇到 NullPointerException 导致的故障,可以思考通用的异常处理模式是怎样的,如何分级处理异常?
当然,如果一时想不起来也没关系,可以保持对问题的持续“探测”。工作就是在不断解决问题,如果在解决问题时更再多想一层、更进一步,那就会持续超出别人的预期。如果同时还能有技术类文章的沉淀产出,那就是一石三鸟了。
机会总以问题的形式出现。
二、用“卡片笔记法”积累素材
没有人从零开始写作,高质量的输出需要更多高质量的输入。在写作之前至少要看看市面上是否已经有了相关主题的内容,别人的角度是怎样的,避免自己以为写的是洞见,但其实早已经是常识了。既然花时间写,那就说点别人不知道的,写点真正新鲜的内容。
很多同学反馈说,读过很多书但是记不住啊。对此,我深有同感,我现在重读一些书,看到自己之前在空白处写的读书笔记会有种错觉:“这是我写的吗?”,完全没印象了。《卡片笔记写作法》一书把这种笔记称为“思想的坟场”。这里的残酷真相是:
很多人在阅读时习惯划线、标注,甚至摘抄原文。然而,这些做法看似是在记录信息,实际上很少能帮助我们真正理解和消化内容。如果不经过主动的思考和总结,这些所谓的“笔记”其实并没有多大作用。
真正有用的笔记方法是德国社会学教授卢曼创造的卡片笔记法。卢曼使用这种方法在 30 年内出版了 58 本著作和数百篇文章,成为 20 世纪最伟大的社会学家之一。我也是卡片笔记法的拥趸,使用 flomo(浮墨笔记)两年多,已积累了 2600+笔记卡片,近 400 个标签,并还在持续记录中。
flomo 也是受卢曼卡片笔记法启发做的笔记软件,他们的创始人去年出了一本《笔记的方法》,把记笔记的关键方法进一步提炼为三个,
1、用自己的话做笔记
真正有效的笔记应该是用自己的话复述。不是说要摘录原文的话,再写自己的感想,而是要用自己的话,用自己的经验,把作者的观点推导出来,变成就像自己说的一样。这两种方式是完全不同的,一种是评论,另一种是阐述。
这一点跟“费曼学习法”的道理是一样的,你只有能把别人教会,你才算真的懂了。很多时候你以为你看懂了,合上书之后,并不能把作者的观点复述出来,这还不是真正的理解
2、笔记的标签管理法
《笔记的方法》讲,笔记的价值在于增援未来的自己。我们需要高效地对已有笔记进行管理,才能在未来用的时候找得到、用得上。而“标签”就是对笔记做管理的最佳实践。
例如,在传统的文件夹模式下,「电动按摩椅」要么被放在「家用电器」中,要么被放在「家具」中,相互排斥。而标签的好处在于,你可以在任意一个卡片上添加多个标签,方便你将来的回忆和查找。在 flomo 中还可以通过多级标签的方式对笔记做更结构化的管理。例如,我最近在读《华为数字化转型之道》,就用标签把这本书和我们的一款产品联系了起来

3、持续不断回顾
做了笔记并不是终点,持续回顾不仅能抵抗遗忘曲线,还能让老笔记与新想法产生碰撞,说不准会有新的启发。flomo 支持每天随机回顾 4~24 条笔记,在回顾卡片笔记时,我一般会对笔记做重新整理:
删:删除不知所云的笔记,删除只有 url 的笔记、删除重复的内容、删除有事实错误的卡片。大胆删吧,很多内容以前没看,以后也不会看
加:增加标签,关联已有卡片。比如,2023 年记录的一个卡片,突然发现跟 2024 年的项目相关,那就在原来的基础上增加项目标签。这里的本质是新增连接,新连接产生的新想法,就是知识的复利。
三、用“黄金思考圈”深入思考
很多技术同学很擅长解决实际问题,可能最终结果也不错,但在项目复盘的时候,问及“为什么这么做不那么做”、“为什么做这个不做那个”、“为什么是你做不是 ta 做”的时候就懵了。要避免项目复盘的时候被别人问懵,需要自己在立项方案中事先回答这些“灵魂拷问”。
作家 Simon Sinek 在《Start With Why》一书中提出一种思考模型:“黄金思考圈”,它强调伟大的领导者和组织不是从“做什么”开始思考和沟通,而是从“为什么”开始,然后是“怎么做”,最后才是“做什么”。

(网图,侵删)
由于技术类文章是为了解决实际问题,因此最好也遵循这样的模式,写出自己的解决方案的推演逻辑。这样不仅可以让文章的结论更有说服力,也可以避免读者再通过问题来获取你的思考过程,让文章更清晰。
现在我越来越赞同卢曼的观点:“不写,就不可能系统性地思考”。写作不仅是思考的外化,更可能是思考的本身。
四、站在“读者视角”做结构化表达
写到这里,终于可以说说如何落笔了。如果前面准备得比较充分,写下来就是水到渠成的事。我们唯一需要注意的就是要站在“读者视角”表达。
当你看到这个观点的时候,先不要盲目赞同,用黄金思考圈审视一下,至少应该能问出 3 个问题,
Why,为什么要站在读者的视角写作?
How,如何站在读者视角写作?
What,站在读者视角写作具体包括哪些内容?
这么简单且正确的一句话,如果你不能清晰地回答这 3 个问题,那说明你并没有真的理解,而只是“知道了”。下面是我的回答
为什么要站在读者视角写作?
读者不是必须要读你的文章,你的文章必须要对读者有用,才能吸引他们读下去
读者读文章需要消耗精力,你需要尽量不“额外”消耗对方精力,才能让 ta 读完(还可以追问:为什么读者读文章需要消耗精力?我们大脑是如何理解一件事的?)
如何站在读者视角写作?使用“金字塔”的结构呈现,先提出结论,然后再提供支持这个结论的论据,包括数据、事实、分析等。(市面上讲职场写作的培训课,底层都是《金字塔原理》)
站在读者视角写作具体包括哪些内容?
有吸引力的开头:用故事化的方式写序言,写出背景、冲突、疑问、回答。
金字塔内部的纵向关系:父主题用于勾起读者的疑问,子主题是父主题的回答
金字塔内部的横向关系:归纳与演绎是仅有的两种思想组织形式
你有没有发现本文也是按照金字塔的方式构建的?
序言中的“然而”、“但是”都是表达“冲突”,核心是要回答读者头脑中已有的问题,或者可能会提出的问题,确保能够吸引读者的注意
本文的每一个父标题、子标题都遵循了金字塔的结构,用户可能对父标题产生疑问,为什么这么说?应该怎么做?子标题负责回答、解释、阐述
同级的标题与标题之间是在同一个层级,并且符合归纳或演绎逻辑。例如,“以问题驱动选题”、“用卡片笔记积累素材”、“用黄金思考圈深入思考”、“站在读者视角做结构化表达”是归纳了“写出高质量技术文章”的四个步骤;演绎的形式一般会用“故”、“所以”、“因此”的关键词来呈现,大家后续在读文章的时候,也可以做一些留意。
结语、我们的写作能力从何而来?
至此,本文的正文就写完了,希望能对你有一些启发。最后我想跟你探讨一下:我们的写作能力是从哪儿来的?
写作能力当然不是天生的,它只是一种技能。回顾我们的教育过程,高考作文要求不低于 800 字,有范文、要用“好词好句”;大学生、研究生要求写论文,但并没有老师系统性地讲过如何写论文,如何用概念、逻辑、数据、实例对观点进行证明;工作之后,更没有动力学习如何写作。也就是说,哪怕你已经工作了很多年,如果没有刻意练习,你的写作能力可能还停留在高中水平,甚至更低。
对于技术类文章,或者论文等非虚构类写作,生成式 AI 很可能也指望不上。我们不需要 AI 生成正确的废话,更需要提供洞见、解决问题。短期而言,AI 无法替代具有洞见的人类工程师,更无法替代掉能解决实际问题的工程师。AI 可以作为写作的辅助工具,但它不是写作的全部,更不是写作本身。
好在写作并不难,只需要持续地学习和练习。《卡片笔记写作法》说,“如果你想写好一篇文章,你只需要对一个好的草稿去做打磨;如果你想写出一个好的草稿,你只需要把一些笔记变成连贯的文字;如果你想把文字变得连贯,只需要整理那些卡片盒中的相关笔记;如果你想有很多相关联的笔记,只需要在阅读时有一支笔。”
翻开书,拿起笔,从阅读开始,从记录卡片笔记开始。祝每位技术同学都能写出既有深度又有洞见的文章,发挥出更大的影响力。
---
欢迎关注我的微信公众号,一起探索在 AI 时代的进化之路

版权声明: 本文为 InfoQ 作者【RockBot】的原创文章。
原文链接:【http://xie.infoq.cn/article/45bfcd5dba31f6ed822f679e9】。文章转载请联系作者。
评论