技术文本的写作问题

最近刚参与一位大佬的重要文本撰写,也就3000字,磨了有几个月。
在这里插入图片描述

收获很多。关于技术写作,要写透,要写简单;要舍得放弃。

写透看起来简单,其实是最难的。一般人看到有字数限制就拼命压缩文本,把(自己觉得)重要的东西全部堆上来,最终是全文多半是半截子话(没说透)、难以理解的话(为了压缩字数采取了更难理解的表达方式)。

写透的根底是逻辑。一个件事情,为什么重要、为什么是这样(理论、机理、规律)、为什么会形成这样(历史,事实)、关键是什么、我们做了什么、我们做的事情为什么重要、有什么收益。其实逻辑很简单,就是把每个地方说透,说到每个点都是不言自明,相邻两个点之间连接顺畅。

在这里插入图片描述

说到首先把逻辑掰开了讲清楚,通常感觉上跟字数限制和简单相矛盾,总觉得讲太透、说得很全的逻辑就不简单了。这种感觉是错的。人能理解的叫做简单;人不能理解的叫做复杂。切忌为了追求简洁省略逻辑,最少也要先把逻辑拉顺了再评估。不以词害意就是这个意思。
在这里插入图片描述

我多次看见大佬把一段250字、令人费解的技术内容,先捋顺了逻辑用500字写清楚,然后把500字简略成300字。赏心悦目。

简单就是拿到逻辑之后用简单句式、大白话,虽然并不是全盘否定术语,但是能少用术语就少用术语,把术语局限在最重要的东西上,这就引出最后一点,放弃。

最后是舍得放弃,这跟前面两点相关。一般写得不清楚就是因为不舍得放弃,太多东西纠缠在一起,逻辑就不可能清楚。实际上,不舍得放弃就不能凸显最重要的东西。

逻辑、简练、重点。这是技术写作的三块基石。

posted @ 2023-07-10 08:47  大福是小强  阅读(3)  评论(0编辑  收藏  举报  来源