程序员的写作课:一、关于技术写作的那些错误思想

破山中贼易,破心中贼难 —— 王阳明

在正式开始我们的课程内容之前,我们先来聊一聊技术写作过程中,你会遇到的那些错误的思想,让你对技术写作有所改观。

1. 我们搞技术的人写不来文章,那个是运营(文案)的活

写作是属于我们向世界表达看法的工具,它属于每一个人。你写一句话也是写作;你写一段话也是写作;当你开始写的时候,你就已经在写作了。

不要畏惧写作,写作是我们必备的技能,在职场中,我们经常要写周报、年报,在家里我们偶尔要给老婆写一下感言,这个东西我们必需,所以我们必练。

对写作重视起来,然后开始写吧!

2. 技术写作文笔不重要,干货才重要

不少程序员在写作时不甚用心,可以理解,毕竟大家工作那么忙,总是 996,哪来的时间写作呢,但是,时间不足不意味着你就可以认为「内容重要,文笔不重要」。

首先,文笔也是内容的一部分,当你说出内容重要文笔不重要时,你就将文笔与内容割裂开来,在一开始就出现了错误。

其次,对于文笔,我们的确不应该以专业作家的要求来要求普通的程序员,但是不意味着你可以完全不在意文笔,甚至以文笔好为耻,认为那不是一个正经的「程序员」。写作与每个人都有关,与职业无关,我们每个人的文笔不可能都做的非常好,但是,我们可以让自己的文笔在自己所能做到的极限中,达到最好。

最后,文笔的好坏往往以修饰词出现的多少,语句之间的起承转合的流程与否来进行评判,这使得文章中出现了大量的与核心思想本身无关的内容,固然让文字显得「水」了一些,但是,却能让你的文章的可读性大大的提高,不再晦涩难懂。

所以,想要写好文章,首先,别拒绝文笔。

3. 技术文章只要干货多,就是好文章

干货是我们经常评判一篇文章好坏的标尺,对于干货较多的文章,我们会点赞,对于干货较少的文章,我们就会唾弃。

但是,在写文章之前,你需要先考虑你的文章的受众,再进行干货的排布。

面向高级工程师和初级工程师的文章对于干货的需求必然是不同的,如果你错配了需求,干货再多,也会被读者吐槽。

一个比较典型的例子是,当你需要写给初学者看的时候,干货异常丰富的官方文档可能并不是一个好的选择,太多的干货带来的巨大信息量会让初学者在一开始整个信道就被占满,无法进行内容的学习,同时,还会在一开始给他巨大的学习压力。个人写的教程、视频教程则相反,抽离出最核心的内容,并对内容进行排布,让初学者可以很轻松的就进行内容的学习。

但是,我们在写文章时,不能为了更好的可读性就一味的降低干货的量,所以,面对初学者的文章时,你除了尽可能的简化你所能提供的信息,还需要平衡干货的量,这一部分,我通常是以参考链接、延伸阅读的形式来完成的,帮助读者更好的去学习所学的内容。

4. 吸引眼球的标题不是好标题

标题只是一个工具,真正令人讨厌的不是标题,而是标题背后的那个人。

我们每个人都讨厌标题党,但是我们不应该讨厌一个好的标题。标题党的主要行为是「发帖的标题严重夸张,帖子内容通常与标题完全无关或联系不大」,让我们有较高的期待和随之而来的较大的失望。但是从功用的角度来说,他们的标题很好的完成了自己的工作,将人们吸引进来。

在信息充裕的时代,我们往往会通过信息流来选择自己想要看的内容,这个时候我们必然不能通过阅读每一篇文章来选择,那样就不是选择,而是遍历了。在这个时候,一个好的标题,能够帮助你更好的吸引读者进来看,让你的内容能够从众多的文章中脱颖而出。

我们应该合理的利用好标题吸引读者进入的功能,来为我们的文章选择更多可能的读者。

5. 写作只是写就可以了

写作不单纯是写,写只是写作中最后一个环节。

写作的完整流程应当是「输入」- 「处理」 - 「输出」,你写不好文章的问题核心不在于「输出」,在于输入,没有海量的输入,你很难获得持续、高强度的输出。没有中间的处理,你所能写出的文章就是一篇流水账。输入是阅读,你需要海量的阅读;处理是思想,你需要先在大脑内进行思维的碰撞,找出自己想法中的合理与不合理。输出是成文,将处理的结果整理成一篇洋洋洒洒的文字。


Practice makes perfect.

讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!