技术写作和绘画

Peter 从事技术写作有几年了,总是会思考的一个问题是,技术文章到底区别于官方文档的价值在哪里?官方文档的特点是精准详细,但是术语多难看懂,而技术文章要做到的就是跟讲故事一样,让听众一遍就懂,轻松快速的学会知识。本文的主体内容就是我自己的技术写作的一些心法,跟绘画有很多相通的地方,因为二者都是表达的艺术。

要有灵魂

我反对技术文章就是干货的堆叠,我认为一篇文章最重要的是要有中心,就像一幅绘画作品要有灵魂。但是不是说有中心了,就有灵魂了。技术文章的起笔前,一定是我自己读了很多资料,顿悟了一个点,这样才有了可分享的价值。如果没有顿悟,我就不写文章,随便记下几行笔记就完了,如果顿悟了多个点,那就写多篇文章,不写到一篇中。那具体怎么执行呢?

首先就是要选定角度。世界上任何事物都是多面的,一个技术其实是可以从很多方面去聊的,如果面面俱到就是文档,不是文章了。哪个角度能让读者去把握这个知识点的最关键思想,就非常体现一个作者的品味和见识,也是技术写作最吸引人的地方。就像画一幅人像,首先需要要让模特摆一个最美的角度。文章一旦选定角度就要全文贯彻下来,不然内容就写散了,读者就容易迷惑。

角度有了,还要选择焦点。一个技术的知识点肯定很多,也要有取舍的去讲。要选出最能支撑起灵魂的几个点来展开文章的内容。同时,我想强调的是,焦点部分当然要仔细描绘,但是其他局部细节越简略越好,原则是离焦点越远的内容越简略。就像你去绘画,重点是要描绘一个人的忧郁的眼神,那么离眼睛越远的部分越简略越好。如果这幅作品中你发现这个人头发也很漂亮,然后就细致的画了头发,那就喧宾夺主,整个画面看起来会很俗气。

总之,文章和绘画一样就是要有灵魂,角度选择越正确,文章价值就越大,而所有焦点的选择都是服务灵魂的,所有细节的展开都要围绕焦点。偏离主题的内容越多,读者就会越走神,越难把握作者的意思。

着力烘托

所以说不必要的细节越少越好,但是对于重点内容就刚好相反,一定要讲透彻。是阴影让物体变得更立体,所以重点的突出,离不开合理的烘托。

如果是写一本书,那么每篇文章的标题都是为了烘托这一章的灵魂和中心。每一章的标题,都要烘托这本书的灵魂。到一篇文章内部,内容的展开当然是要烘托本文的中心。一般一篇文章我会拆分成几个小知识点来讲解,每个知识点尽量是层层递进的关系,每个知识点形成一个二级标题。每个二级标题内部,要提出几个言之有物的论点或者概念,这个就像我们画画的时候要有线条。如果我找不到明确的线条,说明我对这个话题根本没有理解,任何概念如果不能用一句话说的很清楚,就证明我还需要继续查资料,继续理解。

线条有了,下一步就是要渲染。可以用类比来让晦涩的概念变得好懂,例如用一棵树来类比文件系统结构。可以举例子让概念变得生动,比如说某某项目中就用到了这个知识点。也可以指出常见的理解误区,来限定一下概念的范围。另外很重要的一点,就是要对定义概念过程中的引出的其他生僻概念再做出适当的解释,保证读者能跟上的思路。这个地方还是需要特别注意的,讲的太少读者不理解,讲的太多心就会跑题。我自己的做法是,拓展性的知识点一定要略讲,保证正确就可以了,不必精确。

烘托,是官方文档上一般没有的技巧,但是也正是这些,让文章凸显出了高于文档的价值。因为根据信息论原理,信息的冗余越大,那么信息传递的效率就越高,因为传递过程中的抗噪能力强。

感情充沛

最后一点我想强调的就是写作的时候是要有感情的。表达本身是人和人之间的交流,所以感情因素就肯定不能忽视。如果作者不能做到真正在意读者,体会他们的困难和需求,就肯定写不出合格的文章。

简单点说就是要有服务心态,不是写自己想写的,而是要写让别人有收获的。文字的目的不是炫耀自己的能力,而是要让读者听懂。所以,我自己写完文章之后,会仔细的看看全篇的内容是不是能够形成一个一气呵成的故事,整个的结构如果能环环相扣就能很好的锁定读者的注意力。文字流淌的过程中也要用各种技巧达成理解上的通畅,比喻,排比,重复,转折,这些文学上的技巧其实都可以用一些,保证自己的文字是有温度的,增加带入感。所以我写文章的时候,会想象有一个好朋友坐在我身边听我讲这个技术,于是我会随时在意,自己有没有用最自然的语言来表达,有没有地方跳跃过于急促,有没有地方单位内容内的新概念过于密集,让读者即使能听懂,也会觉得非常急促和不舒服。

感情充沛,人文关怀。引用逻辑思维的罗振宇的一句话:死磕自己,愉悦大家。

总结

这篇中谈写作心法。最想表达给大家的中心是:技术文章也是文章,要有清晰的中心,要有明确的间架结构,也要有行文技巧。干货当然要干,但是不讲究表达技巧的文章,读者啃起来吃力,时间也就浪费了。我写写作技巧的文章还有一篇,大家搜《我的即兴写作技巧》就可以在简书上搜到那篇文章,主要讲操作步骤,跟本文互补。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,117评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,963评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,897评论 0 240
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,805评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,208评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,535评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,797评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,493评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,215评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,477评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,988评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,325评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,971评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,807评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,544评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,455评论 2 266

推荐阅读更多精彩内容

  • Peter 从事技术写作有几年了,总是会思考的一个问题是,技术文章到底区别于官方文档的价值在哪里?官方文档的特点是...
    happypeter1983阅读 328评论 0 0
  • 有关于被说语气太过高傲,今天中午,思来想去,最近自己的情绪特别的不稳定,躁动。不知道是为什么,独自在...
    青山外客阅读 310评论 0 0
  • 世间所有的事都是人的事,事关情分。 一个人,一个世界;几个人,世界与世界连接。 在陌生人堆里,看见彼此,认出那个带...
    水木风歌阅读 153评论 0 0
  • 做,哪怕被弹回来也是收获,因为回声让人知道自己的边界。 有边界的,才叫能力。
    羽宙儿阅读 212评论 5 8