技术写作实例解析 | 简洁即是美

如同极简主义的生活不代表苦行一样,简洁的写作并不是用拙劣的文字苦哈哈地表达不完整的意思,而是一种更高的追求,一种经过凝练后的文字呈现。

The ability to simplify means to eliminate the unnecessary so that the necessary may speak. - Hans Hofmann

为什么要简洁?

在技术传播中,文字的简洁至少有以下两方面的考量:

1)提高技术文档的易读性。

从用户(即技术文档的受众)的角度来看,易读性非常重要。

通常,技术文档的读者都是有实际需求才去读的。例如,用户不清楚如何配置或如何使用某个产品,试图从产品使用指南中找到答案。

而人们对于陌生的事物或者不熟悉的事物常常会感到一脸迷茫、手足无措,不是因为某件事有多难,大多数时候只是因为你从未做过、不知道如何做而已。

那么,为了让用户快速地找到自己想要的答案,技术文档的易读性就分外重要。用户不会想读晦涩难懂的文字,也没有心思去品评你的用词是否足够华丽足够有文采。用户很忙的,用户的时间很宝贵。

用户需要的是足够清晰易懂、足够简洁明了的内容。

2)节省文档占用的空间。

从技术文档输出者的角度来看,有必要保持文档简洁。

如今,文档的存在形式多种多样,既可以是纸质的印刷内容,也可以是 PDF/chm 等多种格式的电子书。虽然看起来不如第一点那么重要,但从宏观来看,保持文档的简洁可以节约文档输出时耗费的时间成本和金钱成本。

如何做到简洁?

尽管说起来容易做起来难,有些原则还是要知道的。

且先呈上 Joseph M. Williams 的 Style: Lessons in Clarity and Grace 一书中关于行文简洁的六项原则,供大家细细琢磨,付诸实践,在技术写作中参考。

Six Principles of Concision:

  1. Delete words that mean little or nothing.

  2. Delete words that repeat the meaning of other words.

  3. Delete words implied by other words.

  4. Replace a phrase with a word.

  5. Change negatives to affirmatives.

  6. Delete useless adjectives and adverbs.

感兴趣的小伙伴可以去看下此书 Lesson 9: Concision 章节的详细内容,书中有对每一条原则的解释和举例,这里不再详述。

技术写作实例解析说“简洁”

实例背景

本文实例摘取自开源分布式 NewSQL 数据库产品 TiDB 的技术文档

实例 1

Original Version:

When you execute the task of analyzing regular columns, you can use the tidb_distsql_scan_concurrency parameter to control the number of Region to be read at one time.

Updated Version:

When you analyze regular columns, you can use the tidb_distsql_scan_concurrency parameter to control the number of Region to be read at one time.

这个例子要说明的是:若能用一个词把意思表达清楚,就不要用多个词。这里对应上文六项原则中的第四个原则:Replace a phrase with a word.

上述例句中,"analyze" 一词足以表达 "execute the task of analyzing" 要传达的意思,而且更为简洁易懂。替换之后,仿佛对句子进行了瘦身,甩掉了一身赘肉,清爽至极。

实例 2

Original Version:

These system tables contain grant information about user accounts and the privileges held by them: ...

Updated Version:

These system tables contain grant information about user accounts and their privileges: ...

上述例句中,"their privileges" 足以替代 "the privileges held by them"。行文的简洁需要时刻自我提醒,毕竟 "easy to state but hard to follow"。

实例 3

Original Version:

In the process of backing up and restoring data, use the following tools: ...

Updated Version:

Use the following tools for data backup and restoration: ...

上述例句中,把 "use" 一词提前,对句子进行删减整合,使句子更加简洁。试着读一下原句与修改后的句子,要理解所表达的意思,修改后的版本明显花费的时间更少。

实例 4

Original Version:

stats_buckets: the buckets of statistics information

Updated Version:

stats_buckets: the buckets of statistics

这个例子对应的是简洁的六项原则中的第三个:Delete words implied by other words. "statistics" 一词指“统计数据”,本身已有信息之意,故无需再加 "information" 一词来重复。

小结

随着年龄的增长,个人越来越喜欢极简主义的生活,而文字的凝练非一朝一夕可以达成。技术文档像是没有感情的一种存在,却也个性鲜明,简洁就是它的美。

你可能想读
书单 | 有哪些技术传播从业者必知必看的书籍?
若脱离理解,直译得再正确又有何意?
优质译文不应止于正确,还要 Well-Organized
写在入职技术型创业公司 PingCAP 一个月之后

-END-

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

推荐阅读更多精彩内容