Peter 从事技术写作有几年了，总是会思考的一个问题是，技术文章到底区别于官方文档的价值在哪里？官方文档的特点是精准详细，但是术语多难看懂，而技术文章要做到的就是跟讲故事一样，让听众一遍就懂，轻松快速的学会知识。本文的主体内容就是我自己的技术写作的一些心法，跟绘画有很多相通的地方，因为二者都是表达的艺术。
要有灵魂
我反对技术文章就是干货的堆叠，我认为一篇文章最重要的是要有中心，就像一幅绘画作品要有灵魂。但是不是说有中心了，就有灵魂了。技术文章的起笔前，一定是我自己读了很多资料，顿悟了一个点，这样才有了可分享的价值。如果没有顿悟，我就不写文章，随便记下几行笔记就完了，如果顿悟了多个点，那就写多篇文章，不写到一篇中。那具体怎么执行呢？
首先就是要选定角度。世界上任何事物都是多面的，一个技术其实是可以从很多方面去聊的，如果面面俱到就是文档，不是文章了。哪个角度能让读者去把握这个知识点的最关键思想，就非常体现一个作者的品味和见识，也是技术写作最吸引人的地方。就像画一幅人像，首先需要要让模特摆一个最美的角度。文章一旦选定角度就要全文贯彻下来，不然内容就写散了，读者就容易迷惑。
角度有了，还要选择焦点。一个技术的知识点肯定很多，也要有取舍的去讲。要选出最能支撑起灵魂的几个点来展开文章的内容。同时，我想强调的是，焦点部分当然要仔细描绘，但是其他局部细节越简略越好，原则是离焦点越远的内容越简略。就像你去绘画，重点是要描绘一个人的忧郁的眼神，那么离眼睛越远的部分越简略越好。如果这幅作品中你发现这个人头发也很漂亮，然后就细致的画了头发，那就喧宾夺主，整个画面看起来会很俗气。
总之，文章和绘画一样就是要有灵魂，角度选择越正确，文章价值就越大，而所有焦点的选择都是服务灵魂的，所有细节的展开都要围绕焦点。偏离主题的内容越多，读者就会越走神，越难把握作者的意思。
着力烘托
所以说不必要的细节越少越好，但是对于重点内容就刚好相反，一定要讲透彻。是阴影让物体变得更立体，所以重点的突出，离不开合理的烘托。
如果是写一本书，那么每篇文章的标题都是为了烘托这一章的灵魂和中心。每一章的标题，都要烘托这本书的灵魂。到一篇文章内部，内容的展开当然是要烘托本文的中心。一般一篇文章我会拆分成几个小知识点来讲解，每个知识点尽量是层层递进的关系，每个知识点形成一个二级标题。每个二级标题内部，要提出几个言之有物的论点或者概念，这个就像我们画画的时候要有线条。如果我找不到明确的线条，说明我对这个话题根本没有理解，任何概念如果不能用一句话说的很清楚，就证明我还需要继续查资料，继续理解。
线条有了，下一步就是要渲染。可以用类比来让晦涩的概念变得好懂，例如用一棵树来类比文件系统结构。可以举例子让概念变得生动，比如说某某项目中就用到了这个知识点。也可以指出常见的理解误区，来限定一下概念的范围。另外很重要的一点，就是要对定义概念过程中的引出的其他生僻概念再做出适当的解释，保证读者能跟上的思路。这个地方还是需要特别注意的，讲的太少读者不理解，讲的太多心就会跑题。我自己的做法是，拓展性的知识点一定要略讲，保证正确就可以了，不必精确。
烘托，是官方文档上一般没有的技巧，但是也正是这些，让文章凸显出了高于文档的价值。因为根据信息论原理，信息的冗余越大，那么信息传递的效率就越高，因为传递过程中的抗噪能力强。
感情充沛
最后一点我想强调的就是写作的时候是要有感情的。表达本身是人和人之间的交流，所以感情因素就肯定不能忽视。如果作者不能做到真正在意读者，体会他们的困难和需求，就肯定写不出合格的文章。
简单点说就是要有服务心态，不是写自己想写的，而是要写让别人有收获的。文字的目的不是炫耀自己的能力，而是要让读者听懂。所以，我自己写完文章之后，会仔细的看看全篇的内容是不是能够形成一个一气呵成的故事，整个的结构如果能环环相扣就能很好的锁定读者的注意力。文字流淌的过程中也要用各种技巧达成理解上的通畅，比喻，排比，重复，转折，这些文学上的技巧其实都可以用一些，保证自己的文字是有温度的，增加带入感。所以我写文章的时候，会想象有一个好朋友坐在我身边听我讲这个技术，于是我会随时在意，自己有没有用最自然的语言来表达，有没有地方跳跃过于急促，有没有地方单位内容内的新概念过于密集，让读者即使能听懂，也会觉得非常急促和不舒服。
感情充沛，人文关怀。引用逻辑思维的罗振宇的一句话：死磕自己，愉悦大家。
总结
这篇中谈写作心法。最想表达给大家的中心是：技术文章也是文章，要有清晰的中心，要有明确的间架结构，也要有行文技巧。干货当然要干，但是不讲究表达技巧的文章，读者啃起来吃力，时间也就浪费了。我写写作技巧的文章还有一篇，大家搜《我的即兴写作技巧》就可以在简书上搜到那篇文章，主要讲操作步骤，跟本文互补。
网友评论