如何才能写好技术类文章
文章源于经历,始于思绪,落于文字,不提笔则不成文。虽然想要写好文,就像要做好任何事一样,没有捷径,唯有多写,但了解一些经验也能多少在这个过程中起到些辅助作用。下面我从五个方面说说我的体会。
理由
给自己一个写的理由,这将会是坚持不懈的动力。可以是写作带给自己的好处,例如:有些人为了梳理新学的知识;有些人为了去影响他人;有些人只是喜欢写作,因为写作就想写码。而我更多则是为记录和分享。
定位
在某个领域你能写出什么样的文章,不要超出你的能力范围。根据文章的深浅我们把它分为三类:讲述,探究和发散。我们应该按照自己对某一领域的了解程度定位文章的深浅,用最大的诚意将文章写好。因为深浅不同,面对的读者自然也不同,所以我们没有必要指望一篇讲述类的文章会得到大牛的垂青。相反,我们应该用自己最大的诚意去写作,让大牛读后即使觉得没有收获,也至少能赞叹这是一篇用心的文章。
要素
抓住要素可以迅速帮你提高文章的质量。要素就像人的衣装,型男索女会锦上添花,平凡的人也会因此有所改善。好的文章应该只清晰地表达一个观点,而不是模糊地表达很多观点;好的文章的内容要能提炼为一句话;好的文章要把核心观点或结论放在起始,后文逐步展开论述,对其进行支撑和论证,就像金字塔一样;好的文章也要能经得起电梯测验,把是否继续阅读的权力交给读者。
好文章不要指望一气呵成,不要羞于接受大家的批评。代码需要重构,文章也同样需要。但好文章不要无止境地重构,在你觉得它已经完整的时候,让它与大家见面。接受大家的评论,然后进一步修改。
积累
让文章越写越出彩离不开积累,这些写作之外的积累和写作同样重要。
马伯庸积累的方法是“想象图书”。他会在脑海中虚构一个故事,故事的内容会非常具体,非常有逻辑,他把这个过程戏称为“YY”。虽然他没有把故事写下来,但在他需要的时候,就会从“想象图书”中摘取。我们虽然没有他这样凭空的构思能力,但至少可以多看,多读,多仿写。
实践
我的 Evernote 中有两个和写作相关的笔记本,一个叫“草稿”,另一个叫“素材”。“草稿”随时记录我学习、工作和思考中的想法,而素材则是我的“工具箱”,我把看到的好的内容收录进来。大到文章,小到段落、名词解释。我随时将与“草稿”中想法相关的内容添加进去,当某篇草稿内容足够丰富了,我就整理一下,之后便反复阅读和修改。我不会等到文章完美,而是选择一个它已经足够完整的时候将它发布到博客上。
文章的好坏一方面是内容,一方面是表述,但我认为更重要的是内容。学习、工作和思考这些经历是技术文章写作的发动机,我需要不停的让它保持运转,才能为文章的创作提供足够优质的内容。只要坚持创作,文章也会越来越易读。
推荐阅读
《金字塔原理》
《写作这回事》
《故事-材质、结构、风格和银幕剧作的原理》
《成为作家》
这篇文章的灵感来源于 Berg 同学的一次相同题目的分享。他是百度贴吧资深工程师,除了前端技术方面造诣非凡,还深谙技术文章写作技巧。他长期坚持产出高质量文章,其中不乏被媒体发表的好文。上面的推荐阅读也来自他的推荐。