程序员如何写出技术好文?

Posted 阿里巴巴淘系技术团队官网博客

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了程序员如何写出技术好文?相关的知识,希望对你有一定的参考价值。

本文作者是阿里巴巴淘系技术 2020 年度作者,在内网论坛写文,写一篇爆一篇。分享一下他写文章时用到的一些小技巧,希望对大家有帮助。

最重要的是内容


和所有人强调的一样,好文章最重要的是要有好的内容,好的技术文章要让读者有益。如果你想写一篇爆款文章,但是又觉得没有内容可写,那就不要勉强了,放下笔,合上电脑,有这个时间不如去看书打游戏。

如何让自己有源源不断的内容可写?这与平时的积累有关,多阅读,多思考,多写作,真正的技巧无外乎这些。方法论层面的东西不再赘述,我重点讲几个具体的小技巧,直接“授之以鱼”。

优秀技术文章的特点


  阅读量 ≠ 文章质量

有些文章标题比较吸引眼球,有些话题自带流量,有些内容的受众比较广,所以有很高的阅读量,但这并不代表文章本身的质量。

我自己写的几篇讲技术细节的文章,就没有讲技术对比、讨论技术发展文章阅读量高。内容越专越细,能读下来的人就越少,但并不代表文章质量不高,反之亦然。

技术文章盲目追求阅读量和点赞数不是件好事,所以第一个小建议就是不要太关注阅读量和点赞数,写的文章对别人有用,才是最有成就感的。

  文章要长长长长长长长长长长长长长长长(也别太长)

我翻了一些好文章,各种话题都有,风格差异很大,但是有一个共同点:文章写得很长。这并不代表文章写了很多字就是好文章,背后的真实含义是:好文章的内容足够丰富。

内容丰富详实,这是一篇好文章的必要条件。还有一个条件是要包含真正有价值的内容,不能含太多水分。

提供一个小技巧:如果你写了一篇文章但是觉得内容很单薄,可以先当成一篇笔记存起来,等有了更丰富的积累之后再整理成文章。扩展文章内容的方法,并不是添加无意义的空话套话,而是根据文章探讨的问题延展开来。

比如说介绍自己解决的一个老大难 Bug,可能真正修改的代码并没有几行,把过程讲出来也不过寥寥几段。这时候你就可以再分析一下 Bug 存在的原因,为什么一直拖到现在,再思考一下如何避免这类问题,遇到同类 Bug 怎样快速排查。这样自己想问题的角度更全面了,文章内容也更丰富了。

比如你想介绍一项自己在学的新技术,发现自己写的东西其实就是官方文档的简化版,去重之后几乎什么都不剩了。这时候不要再继续抄文档了,把自己的思考总结先记下来,继续学习技术,持续记录新的内容,有更全面的了解之后,再写文章。

  清晰的叙事结构

优秀的技术文章,结构一定是清晰的,有可能目录就代表了某个技术体系,或者代表了解决问题的思路。

优秀的内容 + 清晰的结构 = 好文章

能把技术问题讲清楚,就很考验表达能力,这是大部分程序员比较欠缺的。对于技术类文章,常见套路也不多,我简单介绍两类吧:

  1. 平铺叙事,逐步推进:适用于介绍排查问题的过程、分享设计思路、介绍项目的迭代进展。

  2. 结构化叙事,层层展开:适用于讲规划、做总结、画大图、介绍一整套技术方案。

  线性叙事,逐步推进

对于这类文章,读者是应该按顺序一段一段看的,写的时候脑海中模拟读者的视角来写。这类文章的小技巧就是:模拟读者视角,设定一条主线,有节奏的向前推进。和讲故事差不多,每一步的推进要有逻辑,要保持思路不要断掉。

有时候稍微加点趣味也是不错的,比如:

https://zhuanlan.zhihu.com/p/273557876

我的这篇文章,目标是分析 Widget 和 CSS 的设计差异,我把文章写成一场比赛,先介绍参赛选手,然后分了 5 个 Round 开始 Battle,然后是 Love&Peace,最后一个 Happy Ending。

  结构化叙事,层层展开

除了按顺序看的,还有不按顺序看的文章?有的,尤其在专业的技术文章里很常见,大部分是“总-分”的结构,先讲整体框架,再分章节介绍各个部分。

比较常见的是那种总结型的文章,比较像一本技术手册,可以通读一遍,也可以只看其中一段,之后遇到相关的问题,根据目录跳着阅读。

对于文思泉涌的人,可以一口气把整篇文章写完。但实际情况是,很多时间被碎片化,可能还要引用一些专业内容,可能需要查资料,写文章的过程会被中断。这类文章不是一口气写完的,是先搭架子再填充完整的。

其实写起来也很简单:先想好标题,再划分好目录结构,再一段一段的填充内容,最后再润色一下连接部分。文章可以不按顺序看,也可以不按顺序写。

线性叙事是个链表,结构化叙事是树。

提升写作技巧


我初高中的时候比较喜欢看闲书,偶尔自己写点东西,但是我作文考得并不高,这里大言不惭的聊一下怎么写作文吧哈哈哈哈哈。只讲怎么写技术文章,并不能提升任何文学功底,但说不定能帮你避开一些小坑。

  碎片化记录,结构化整理

大部分人的问题是不知道该写什么,即使已经有足够的积累,有明确的话题要写,也不知道该如何下笔。这就要靠日常的积累了。

在平时工作的时候,可以建个文档库,把日常的一些琐碎的想法记录下来,随时写随时存。我是用手机的便签 App 随手记东西,比较喜欢它的语音转汉字功能,工作相关、生活相关,随时随地想起任何话题都可以记录下来。

在有了明确话题,准备写文章之前,先把各种碎片化的记录收集起来,形成一份“素材”文档,然后梳理文章脉络,把素材应用进去。操作起来很简单,刚开始的时候会遇到前后不通畅的问题,那就不要直接复制素材的内容,重新换个表达方式写出来。多练习练习就好了。

  刻意练习,先写再改


有了素材之后,平时可以专门练习写作能力,先写一小段话,明确的描述一个观点,然后不断修改其实写周报就是一个很好的锻炼机会(现在不要求写了,自行练习),练习把做的事情描述清楚,说话的方式简单点,不要用太多高大上的词汇。最关键的部分在于:写完花五分钟再改一遍!读一下是否通顺,有没有把问题讲清楚。反复修改才是提升写作技巧的关键。

用周报举例有点奇怪,毕竟是邮件类型的东西,和写文章差别很大,还是不要乱改周报了,改自己以前写的文章吧。找一篇自己以前写的,内容很不错但是写得不太行的文章,重写一遍!这个过程既温习了技术,又锻炼了写作技巧。不要觉得无聊浪费时间,亲测很有效的。

  注意排版和语法细节


对于不拘一格的程序员来说,写出来的文章没有排版,就是家常便饭。不需要追求高级的排版技巧,稍微注意一下几个常见的问题就好了。

  • 正确使用标点符号。(没想到我居然在讲这个……)

大部分的文章里就只有逗号和句号,逗号和句号也是看心情随意划分,按到哪个是哪个。还有单双引号、顿号、冒号、分号、叹号、破折号、省略号、书名号、中文括号「」【】等等…… 使用技巧可以去网上搜,这部分我觉得问题很常见,就单独多讲了两句。对了,中文文章要用全角标点符号,尽量不要混用英文标点符号……

  • 添加多种展现形式,可参考 GitHub 的 Markdown 语法。

如果全都是普通段落,看起来太平,可以加上无须列表、有序列表、段落引用、表格等等。行内排版可以加上粗体斜体代码标记等,偶尔还可以用删除线。

  • 其他还有一些小的建议

  1. 区分大标题小标题,分配的均匀一些,最多不要超过三层。

  2. 每个章节的长短也尽量均匀一些,太长的内容就拆个小标题。

  3. 重要数据给出明确的数据源,扩展信息给出资料连接。

  4. 中英文混写的时候,在中间加一个空格。

  5. 注意英文的大小写,尤其是专业名词的缩写。

  6. 英文喜欢长句,复合从句一层套一层;中文追求言简意赅,错落有致,可以多加标点符号,把长句分隔开。

  7. 写完之后通读一遍,尽量少写错别字……

  • 最后一个小技巧


多用图片,即使图片里只有字,图片的信息量也远超文字。

然而我这篇文章并没有用,因为这并不是一篇技术文章,大家在讲技术原理的时候,要多用图片,一图胜千言!

写在最后


最后一个小建议:文章写多了就可以逐渐形成自己的风格,让所有文章都保持某种共性。

比如我每篇文章最后都会发招聘信息!

欢迎优秀的你加入淘系终端体验平台-跨平台技术团队!一起打造靠谱的跨平台方案。技术深度足够深,业务场景足够丰富,欢迎优秀的小伙伴来一起搞事情!

✿  拓展阅读

作者|门柳

编辑|橙子君

出品|阿里巴巴新零售淘系技术

以上是关于程序员如何写出技术好文?的主要内容,如果未能解决你的问题,请参考以下文章

[译] 如何在React中写出更优秀的代码

独家秘籍!如何写出让同事无法维护的代码?-

代码规范如何写出好代码

一文详解|如何写出优雅的代码

做java软件工程师,怎样才能写出好的代码?

程序员如何规划职业路线?