我的云原生 AI 实战营在 2025.03.20 号更新了「Kubernetes 源码剖析课」的 第 09 节课:如何高效的阅读开源项目源码? 本节课一共 8922 字,前后保存了 99+ 版本。
以下是 09 | 如何高效的阅读源码?的大纲截图:
今天就以 第 09 节课:如何高效的阅读源码?为例, 来介绍下我是如何写一篇高质量的技术文章的。
技术文章的写作目标
云原生 AI 实战营中的课程写作过程时,我会力争每一篇文章都是一个高质量的文章,我对这些课程文章质量要求如下:
- 逻辑清晰、易读;
- 文章结构清晰,能够清晰的展现课程展现逻辑;
- 课程内容全:课程内容尽量做到面点俱全。实战营中的不少课会因为内容太多,拆分成上、中、下 3 篇文章;
- 课程内容优质:大家学习时间都很宝贵,课程尽量会讲解正确、重要、有干货的内容。
提示:我写文章很注重文章的逻辑性,逻辑层层递进,思路清晰,这点很重要!
以上几点是我对云原生 AI 实战营中技术文章的写作要求。要想实现以上几点要求,需要花费大量时间调研、学习、梳理、升华、打磨。
平均每一篇技术文章耗时要 3 ~ 4 天。有的甚至需要 1 周,有些文章甚至要花上 2 ~ 3 周。接下来,我就来分享下,我的技术文章写作方法。
技术文章的写作思路
这里,先来介绍下整体的写作思路。
整体写作分为 2 个阶段:
- 第一阶段: 调研、学习阶段。会根据文章主题,搜索所有可能的优质文章。筛选、学习、消化这些优质文章;
- 第二阶段: 梳理、升华、打磨阶段。会将自己的知识体系、经验等融入网上学习、消化后的内容,重新梳理,整理逻辑和内容结构,落地成升华文章。最后,基于这个文章初稿,不断打磨,形成定稿。
步骤 1:全网调研
其实,没有太多花里胡哨的写作技巧。方法很简单、粗暴,但又很有效。就是先全网调研相关文章,例如:
- 百度搜:如何阅读开源项目源码?
- Google 搜:How to Read Source Code。
一般,我喜欢 2 个搜索引擎都搜,可能我有点强迫症。这里以百度搜索为例,介绍我是如何做全网文章调研的。
将搜索的结果,下图中的红色箭头所指的搜索记录,在新的标签页中打开:
搜索结果可能有很多,百度/Google 会以分页的形式展示出来:
我会从第 1 页,一直往下翻,遇到感觉可参考的文章,就直接在新标签页打开,直到展示的搜索结果跟搜索关键词已经没太多关系为止,或者我自己觉得已经够了为止。
最终,你的浏览器界面可能如下(有几十个待筛选的标签,有时候一个浏览器打开太多了,我会在新开一个浏览器实例,继续):
注意: 这种调研方式需要电脑内存很大,因为浏览器标签会占用大量内存。 我自己的电脑内存是 64G(建议至少 32G)。
接下来,就进入第 2 步:筛选优质文章。
步骤 2: 筛选优质文章
上面我通过搜索引擎预筛选了几十个或者上百个可能有参考、学习价值的文章。
接下来,就要从这些待筛选文章中,再进行筛选,将一些重复的、质量低、格式乱、内容短、AI 生成的文章过滤掉(现在有点讨厌这种大量的、千篇疑虑的 AI 官文)。这时候大概会有十几个或者更少的优质文章,可以认真去调研、学习。
步骤 3:学习消化文章
上面我筛选出了十几个优秀的文章,可供学习。这时候,就要对这些文章进行细细阅读,最终你可能会发现,其中有些文章,是另一些文章的超集,这些文章从结构、逻辑、内容质量上都不错。也就是说,还可以再次对这些文章进行筛选,但要注意,不要把其他好的文章给过滤掉。
筛选之后,可能有几篇或者更多的文章,需要去精读。
上面我调研、浏览了那么多文章,细度了十几篇文章,最后精度了几篇文章。这时候,脑海中其实已经有:如何阅读开源项目源码的方法集、主题结构了。接下来,就需要对脑海中杂乱的知识进行梳理,并体系化。
步骤 4: 梳理知识体系
上面,我已经将如何阅读开源项目源码的所有方法都记忆在脑海中。接下来还要梳理这些知识体系。在梳理知识体系时,有以下几个点需要注意:
- 取精去劣: 网上这些文章质量参差不齐,有大量优秀的方法可供参考,但也有写方法是没有意义的,所以需要对这些文章进行取精去劣处理。将好的方法、观点、知识等放在知识大池中;
- 不漏知识点: 我写文章喜欢点面俱全,舍不得遗漏重要的、好的知识点。所以,在梳理过程中,我尽量不去丢弃好的知识点、观点、方法等;
- 梳理出逻辑结构: 在梳理文章的过程中,自己还要思考,如何组织这些内容,用一种逻辑性强、易读、易理解方式有机整合在一起;
- 好文要收藏:现 一些好的文章, 可以顺手收藏到自己的收藏夹中。我的收藏夹中, 应该收藏了上万个优质的技术文章。
我感觉这个梳理阶段,是很虐脑的,要将各种知识点,由杂无章的状态,梳理成有逻辑的体系,要消耗好多脑细胞。
步骤 5:升华知识体系
在梳理完网上的优质内容之后,还需要结合自己的方法论、工作中的经验等自有知识体系,来升华、重组这些知识体系,并最终落地成逻辑性很强、内容很全、格式很好的技术文章。有了前面的调研,梳理,这个过程其实花费时间不多。
步骤 6:不断打磨文章
最后,也是最轻松的,就是不断地打磨文章。打磨内容如下:
- 优化整篇文章的逻辑结构、展现形式;
- 修改错别字、错误表述等;
- 整理格式,一个清晰、易读的格式,其实是能够让理解更加轻松的。格式有时候,也能反应知识体系的逻辑;
- 插入图表:有时候,为了能够更好的表述文章的知识,需要用图片、表格等形式,来辅助展示内容;
- 拆分文章:有时候不知不觉一篇文章会写超过 1w 字,为了减轻阅读文章的负担,还需要将文章拆成 2 篇或更多篇;
- ...
一般来说打磨 2 ~ 3 遍就差不多了。
写作耗时
整个写作过程,根据文章主题的不同耗时大概在 2 ~ 5 天。有的文章甚至需要 1 周时间。例如,我之前写的一篇介绍云原生的文章,就花费了我将近 1 ~ 2 周的时间。写完之后,整个云原生介绍的文章字数达到了 3 万字。
再比如,之前写的 kube-scheduler 源码剖析的文章,花了近 3 周的时间,写完之后整个文章篇幅达到 27000 字(调度器很复杂、需要梳理出清晰的逻辑,而且内容也很多):
技术文章的写作收益与弊端
这里介绍下,这种简单、粗暴写作的收益和弊端。
收益
上面介绍了我的技术文章写作思路,过程很艰辛,但是收获很丰厚。我总结了下可以带来以下收获:
- 课程质量很高: 因为是调研、参考,并且融入了个人方法、经验等,精心打磨(文章整体逻辑、文章结构、语言表述、图表等)而出的文章,所以文章质量,在整个网上都是非常优质的;
- 学习了很多: 写文章的过程也是一个学习的过程,通过全网 360 度无死角的学习、调研,再结合自己的理解、经验,并升华整个知识体系,可以说,在如何阅读源码这块儿,你已经是很专业了;
- 知己知彼: 通过阅读他人文章(思路、文章结构、内容量等),你也大概知道了自己的水平处在什么位置,这不仅可以增加自信,还能够查漏补缺;
- 创造知识价值: 通过你学习调研、梳理之后落地出来的优质课程文章,可以让我的很多学生,免去调研、筛选等阶段,直接学到最全、最优质的内容,创造课程价值。
整个过程的感受:痛并快乐着。写作的过程很痛苦,但是写完之后,内心是很开心的。
弊端
这种文章写法的弊端也很明显,就是:很累、很耗时!不仅要付出大量的体力、脑力,还要从杂乱无章中, 强行梳理出逻辑,并且在梳理逻辑的过程中,还不能漏掉知识点,要将所有的知识点,放在一个合适的位置上。这个过程是对脑细胞的高强度鞭打。所以,整个
"如何阅读开源项目源码"文章写作过程中的调研文档数
这里,我统计了之前在写:第 09 节课:如何高效的阅读源码?一节课的时,我调研、学习的文章数, 至少有 227 篇文章,如下图所示:
耗时多久,我忘了,应该近 1 周吧。
写课这么多年已经养成了一个习惯,即使全量调研、梳理、升华,不闭门造车,写出真正优秀的文章。