乐趣区

关于架构师:如何写出高质量的技术文章

简介: 为什么要写文章?什么是好的技术文章?如何写好技术文章?如果你是一个不喜爱语文、不喜爱浏览、作文很少及格的理科生,想要写好一篇技术文章,请肯定要往下看。

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

一 为什么要写文章

懂了,不肯定能说进去,说的进去,不肯定能写进去。这就是写文章最大的益处,官网术语叫“费曼教学法”。写文章是一个逼迫本人深刻了解问题、把问题想分明,整顿好思路,并能清晰表达出来的过程。其本质是一种自我学习、自我晋升、构建常识体系的最佳办法。

除此之外,写文章还有一个副产品——帮忙咱们扩充影响力。就拿我来说,我大略是在 4 年前,开始有布局地搭建本人的常识体系,包含浏览、记笔记、写文章、分享。

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

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

二 什么是好的技术文章

对于优质文章的规范,有一个对好文章的判断是:“文章框架残缺、思考深刻清晰、注释至多 80% 以上为原创技术干货。”这引起了不少的争议。

有争议很失常,没有争议才奇怪呢,好的技术文章,就和好的技术绩效一样,主观性太强 …… 很难有一个主观规范。

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

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

  • 一个是要传播有价值的信息。
  • 另一个是要构造和逻辑清晰,具备肯定可读性和可了解性。

在此基础之上,如果能做到有文采、够有趣那就更好了。

三 如何写好技术文章

内容有用

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

这里的“物”可大可小,不肯定非要是一个很大的命题,恰恰相反,一篇文章的篇幅无限,能把一件“小事件”说分明就曾经很不错了。

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

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

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

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

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

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

构造清晰

有了好的内容,还要留神文章的构造。就像一道菜,要考究色香味俱全,即便有了最好的食材,然而做进去的样子一团糟,也会影响食欲,称不上是一道好菜。
对于构造,我举荐你去看一本书——《金字塔原理》,我自己也写过不少对于结构化思维的文章。金字塔原理教诲咱们在写作、表白的时候,要构建清晰的构造。

对于一篇文章来说,金字塔的顶点是核心论点——通常就是文章的题目。围绕着这个核心论点,咱们能够用多个观点去撑持核心论点,如果表白的内容很多,观点还能够进一步往下细分。造成一个“以上统下、逻辑递进”的金字塔构造。

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

对于技术文章来说,咱们能够思考应用 3W2H 模型来帮忙咱们构建构造。比方我要写一篇对于形象能力的文章,就能够通过以下角度去说:

  1. What:什么是形象;
  2. Why:形象为什么重要;
  3. How:如何进行形象;
  4. Where:形象能够用在什么中央;
  5. How much:形象到什么水平;

同样,我当初正在写的这篇文章,我也是通过这种形式来搭建构造的:

刻意练习

开篇说过了,我以前没有写作的习惯,小时候语文作文也常常不及格。前面居然出版了本人的书,阐明写作作为一项技能,是能够习得的,是能够通过练习进步的。

因为写的多了,练习的多了,程度天然就会进步。然而,所谓的《刻意练习》(也是一本书),不是简略地反复,而是要给本人阶段性的设定更高的指标,这样才会继续地提高。

比方,我当初曾经能比拟流畅地写作,我就会去谋求如何把文章写的更加引人入胜。在《格调感觉:21 世纪写作指南》外面提到一篇文章,它的结尾是这样写的:“咱们都会死,咱们是侥幸的 …”,像这种抵触感和悬念,就会很天然地吸引读者持续浏览上来。

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

迭代优化

写文章和写代码有十分多类似的中央。我会常常拿写文章和写代码做类比。比方,文章和代码都须要构造清晰。又如,好的零碎不是设计进去的,是迭代进去的。好的文章也是如此,须要一直的打磨、批改,我的很多文章都是通过屡次批改,从新编排构造,补充删除信息,调整措词,直到我感觉称心为止。

就拿当初这篇文章来说,也是批改了好几版,第一遍的时候内容很散点,构造也不清晰,有点纠结,不晓得要如何写下去,前面想到一个“言传身教”的办法,即这篇文章自身应该就能够作为一个 sample 来介绍如何写文章。带着这个思路,迭代几次之后,就逐步成了一篇像样的文章了。

所以,重要的是要敢于去“动笔”,不要放心一开始的粗心大意,万事开头难,写着 … 写着 … 你就有感觉了。

版权申明: 本文内容由阿里云实名注册用户自发奉献,版权归原作者所有,阿里云开发者社区不领有其著作权,亦不承当相应法律责任。具体规定请查看《阿里云开发者社区用户服务协定》和《阿里云开发者社区知识产权爱护指引》。如果您发现本社区中有涉嫌剽窃的内容,填写侵权投诉表单进行举报,一经查实,本社区将立即删除涉嫌侵权内容。

退出移动版