关于程序员:程序员写好技术文章的几点小技巧

38次阅读

共计 3916 个字符,预计需要花费 10 分钟才能阅读完成。

作者 | 门柳
起源 | 阿里巴巴云原生公众号

去年成为了内网技术分享平台的年度作者,受邀写一篇对于“如何写好文章”的文章。我自身并不喜爱写字,去年写的几篇文章,波及的话题自带流量,所以浏览量多了一些,谈不上有多善于。不过还是决定分享一下本人在写文章时用到的一些小技巧,心愿对大家有帮忙。

最重要的是内容


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

如何让本人有源源不断的内容可写?这与平时的积攒无关,多浏览,多思考,多写作,真正的技巧无外乎这些。方法论层面的货色不再赘述,我重点讲几个具体的小技巧,间接“授之以鱼”。

优良文章的特点

1. 浏览量 ≠ 文章品质


有些文章题目比拟吸引眼球,有些话题自带流量,有些内容的受众比拟广,所以有很高的浏览量,但这并不代表文章自身的品质。

前几天无心翻到一篇《超长用户行为建模在躺平家居内容举荐中的利用实际》,我感觉写得不错,然而内容我齐全看不懂,是业余畛域的文章,受众不多,有上千的浏览量就曾经很不错了。然而另一篇《如何画好一张架构图?》就有超过 3W 的浏览量。当然反例也有很多,就不再列举了。我本人写的几篇讲技术细节的文章,就没有讲技术比照、探讨技术倒退的文章浏览量高。内容越专越细,能读下来的人就越少,但并不代表文章品质不高,反之亦然。

技术文章自觉谋求浏览量和点赞数不是件坏事,所以第一个小倡议就是不要太关注浏览量和点赞数,写的文章对他人有用,才是最有成就感的。至于除了浏览量和点赞数以外,还有什么指标能够掂量一篇文章的好坏,欢送大家留言探讨。

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


我翻了几篇阿里技术公众号里浏览量较高的文章,各种话题都有,格调差别很大,然而有一个共同点:文章写得很长。这并不代表文章写了很多字就是好文章,背地的实在含意是:好文章的内容足够丰盛。

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

提供一个小技巧:如果你写了一篇文章然而感觉内容很薄弱,能够先当成一篇笔记存起来,等有了更丰盛的积攒之后再整顿成文章。扩大文章内容的办法,并不是增加无意义的空话套话,而是依据文章探讨的问题延展开来。

比如说介绍本人解决的一个老大难 Bug,可能真正批改的代码并没有几行,把过程讲进去也不过寥寥几段。这时候你就能够再剖析一下 Bug 存在的起因,为什么始终拖到当初,再思考一下如何防止这类问题,遇到同类 Bug 怎么疾速排查。这样本人想问题的角度更全面了,文章内容也更丰盛了。

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

3. 清晰的叙事构造


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

优良的内容 + 清晰的构造 = 好文章

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

  • 线性叙事,逐步推进:实用于介绍排查问题的过程、分享设计思路、介绍我的项目的迭代停顿。
  • 结构化叙事,层层开展:实用于讲布局、做总结、画大图、介绍一整套技术计划。

4. 线性叙事,逐步推进


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

有时候略微加点趣味也是不错的,比方《Flutter Widget 和 CSS 布局原理 PK》这篇文章,指标是剖析 Widget 和 CSS 的设计差别,我把文章写成一场较量,先介绍参赛选手,而后分了 5 个 Round 开始 Battle,而后是 Love&Peace,最初一个 Happy Ending。

另外一篇《记一次残缺 C++ 我的项目编译成 WebAssembly 的实际》介绍了本人尝试新技术的心路历程,先介绍背景,再剖析需要做拆解,而后讲尝试了什么计划,遇到了什么坑,又持续试其余计划,最终是什么后果。读起来比拟晦涩。

5. 结构化叙事,层层开展


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

比拟常见的是那种总结型的文章,比方《平台建设的 7 大问题:蚂蚁 AI 平台实际深度总结》和《救火必备!问题排查与系统优化手册》,就是翻阅性质的书,能够通读一遍,也能够只看其中一段,之后遇到相干的问题,依据目录跳着浏览。

对于文思泉涌的人,能够一口气把整篇文章写完。但理论状况是,很多工夫被碎片化,可能还要援用一些业余内容,可能须要查资料,写文章的过程会被中断。这类文章不是一口气写完的,是先搭架子再填充残缺的。其实写起来也很简略:先想好题目,再划分好目录构造,再一段一段的填充内容,最初再润色一下连贯局部。文章能够不按程序看,也能够不按程序写。

我本人写的《对于浏览器、Weex、Flutter 的比拟和思考》这篇文章就是先划分好了目录,再一点一点填充的,写文章的时间跨度也比拟长,想起来一点写一点。

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

晋升写作技巧


我初高中的时候比拟喜爱看闲书,偶然本人写点货色,然而我作文考得并不高,这里大言不惭地聊一下怎么写作文吧哈哈哈哈哈。只讲怎么写技术文章,并不能晋升任何文学功底,但说不定能帮你避开一些小坑。

1. 碎片化记录,结构化整顿


大部分人的问题是不晓得该写什么,即便曾经有足够的积攒,有明确的话题要写,也不晓得该如何下笔。这就要靠日常的积攒了。

在平时工作的时候,能够建个文档库,把日常的一些琐碎的想法记录下来,随时写随时存。我是用手机的便签 App 顺手记货色,比拟喜爱它的语音转汉字性能,工作相干、生存相干,随时随地想起任何话题都能够记录下来。

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

2. 刻意练习,先写再改


有了素材之后,平时能够专门练习写作能力,先写一小段话,明确的形容一个观点,而后一直批改。其实写周报就是一个很好的锤炼机会(当初不要求写了,自行练习),练习把做的事件形容分明,谈话的形式简略点,不要用太多高大上的词汇。最要害的局部在于:写完花五分钟再改一遍!读一下是否通顺,有没有把问题讲清楚。重复批改才是晋升写作技巧的要害。

用周报举例有点奇怪,毕竟是邮件类型的货色,和写文章差异很大,还是不要乱改周报了,改本人以前写的文章吧。找一篇本人以前写的,内容很不错然而写得不太行的文章,重写一遍!这个过程既复习了技术,又锤炼了写作技巧。不要感觉无聊浪费时间,亲测很无效的。

3. 留神排版和语法细节


对于不拘一格的程序员来说,写进去的文章没有排版,就是粗茶淡饭。不须要谋求高级的排版技巧,略微留神一下几个常见的问题就好了。

1)正确应用标点符号


大部分的文章里就只有逗号和句号,逗号和句号也是看情绪随便划分,键盘上按到哪个是哪个。其实还有单双引号、顿号、冒号、分号、叹号、破折号、省略号、书名号、中文括号「」【】等等…… 应用办法能够去网上搜,这部分我感觉问题很常见,就独自多讲了两句。对了,中文文章要用全角标点符号,尽量不要混用英文标点符号。

2)增加多种展示模式,可参考 GitHub 的 Markdown 语法


如果全都是一般段落,看起来太平,能够加上无序列表、有序列表、段落援用、表格等等。行内排版能够加上粗体、斜体、代码标记等,偶然还能够用删除线。

其余还有一些小的倡议:

  • 辨别大题目小标题,调配的平均一些,最多不要超过三层。
  • 每个章节的长短也尽量平均一些,太长的内容就拆个小标题。
  • 重要数据给出明确的数据源,扩大信息给出材料连贯。
  • 中英文混写的时候,在两头加一个空格。
  • 留神英文的大小写,尤其是专业名词的缩写。
  • 英文喜爱长句,复合从句一层套一层;中文谋求长篇累牍,错落有致,能够多加标点符号,把长句分隔开。
  • 写完之后通读一遍,尽量少写错别字……

最初一个小技巧:多用图片。即便图片里只有文字,信息量也远超文字。

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

写在最初


最初一个小倡议:文章写多了就能够逐步造成本人的格调,让所有文章都放弃某种共性。

比方我每篇文章最初都会发招聘信息!

欢送优良的你退出淘系技术部 - 跨平台技术团队!一起打造靠谱的跨平台计划。这里有手淘外围链路在应用的 DinamicX、淘系的 H5 容器、Weex、淘宝小程序容器。淘系的基础架构、研发撑持是隔壁的兄弟团队,咱们在宽泛的撑持新批发的业务。技术深度足够深,业务场景足够丰盛,欢送优良的小伙伴来一起搞事件,手淘跨平台技术团队欢送你的退出!(请分割 hanks.zh@alibaba-inc.com)

2021 阿里云开发者大会重磅开启!

数字时代,如何更好地利用云的能力?什么是新型、便捷的开发模式?如何让开发者更高效地构建利用?科技赋能社会,技术推动改革,拓展开发者的能量边界,所有,因云而不同。点击立刻报名流动 2021 阿里云开发者大会 将给你答案。

正文完
 0