本文首发于「BY林子」,转载请参考版权声明


文章是“自己的”好!

看到这句话,是不是觉得我太骄傲?!

哈,不要误会,不是说只有我自己写的文章才是好的。

这说法来自著名散文大师王鼎钧先生的《作文六要》,其意思是说要写出自己的所见、所闻和所感,而不要模仿他人的写法,只有这样写出来的文章才是带有真情实感,才是好文章。

对此,本人深感认同,这也同样适用于技术写作。王老先生表达的意思有三点:

  1. “写作的最初动机,是诉说自己的心事。” 对于技术写作而言,那么动机就是分享自己掌握的新技术、工具、实践经验。
  2. “文章要写真心话、老实话,而不是说别人话,不是抄书本的话。” 对于技术写作而言就是要将掌握的技术、工具和实践经验用自己的话表达出来,而不能抄袭别人的文章,或者东拼西凑地写一些自己根本不了解的内容。
  3. “文章中的故事可以是假的,但情感至诚无伪。” 对于技术写作而言,可以理解为项目实情可以虚构,但所描述的技术、实践一定是切实可行的,并且是来自自己的真实体验和感受。

大家可能都见到了我前一阵写的《构建测试的体系化思维(基础篇)》和《构建测试的体系化思维(进阶篇)》两篇文章,对我来说,它们都算长文了。昨天跟同事聊到这样的文章是怎么写出来的,正好结合王老先生说的,来跟大家分享一下。

文章是自己的好

大概从2018年开始,我会将演讲过的话题写成文章,后来我发现演讲和写作结合起来是个很不错的做法。于是,我的写作过程可以简单描述成下面这些步骤:

STEP1:构思文章的脉络

以思维导图的形式列出来文章的大纲,包括关键信息的列举等。

STEP2:思考怎么讲出来

我会根据大纲从演讲的角度来思考听众怎么能更好地接受,以简单的PPT方式呈现。

STEP3:根据PPT写文章

因为已经思考过怎么讲出来,这个时候对着PPT把自己想讲出来的话写成文章,去掉过于口语化的表达,就可以比较轻松的将文章写出来了。

这样做的好处有下面几点:

  1. 在思考怎么讲的时候,会更清晰地捋清楚逻辑;在写文章的同时,还可以对演讲PPT进一步调整,让其逻辑更通顺,表达更完整。
  2. 可以同时完成一份演讲的PPT,一举两得。
  3. 做出来的PPT截图就可以当成文章插图。
  4. 最关键的一点是要讲出来,用别人的方式是很难讲的,只有用自己的语言表达自己所理解的内容才能比较顺畅,这样写出来的文章也就是“自己的”啦。

王老先生在《作文留言》里还提到写作的三个阶段,其中第一个阶段是“文从字顺”,要做到用字不违反约定俗称,要能通顺地表达。对于很多人来讲,尤其是技术工作者的技术写作,要能做到这第一阶段并不容易。所以,想想怎么给人讲出来,然后再写,有可能能够带来意想不到的效果。要不要试试看?

今天这篇小文分享的内容有限,更多关于技术写作的内容,欢迎移步关注Thoughtworks洞见最新自出版的《技术写作手册》。


本文首发于「BY林子」,转载请参考版权声明

发表评论

您的电子邮箱地址不会被公开。