技术写作中的极简主义

注意,本文有剧透,反感者慎入~~

一口气听完了SIGMA(科多思)关于技术写作的分享,真的是干货满满而又意犹未尽。

虽然每节课只有短短几分钟,但都能够通过理论和实例结合,鲜活而又完整地讲述一个主题,强烈推荐各位技术传播同行共飨~

课程主题包含技术写作的概念与特点,技术文档工程师与用户和技术专家的合作,以及常见信息类型、信息架构,同时分析了常见错误与对症改进。

就我个人而言,印象最深的还是极简主义的反复强调和应用。

比如,在第一课《什么是技术写作》的结尾,对比商业宣传写作,以“Click Install”两个词完美展示了极简之美,就问你服不服吧。

极简写作—对不起没截到好图

把一个操作写成这么简单不难,但是很多很多步操作都写成这样不简单。

让我想到了红楼梦中宝玉拜别父亲的场景,白茫茫一片雪,只余一点红。

也让我联想起了此前一个相声的段子,一个人起夜,与被惊醒的家人进行对话。不同地方人的语言特点不同。同一件事,多可以说到三五十字,少可以归纳为四个字“谁,我,啥,尿”。

(对不起我庸俗了)现在流行的“社会我x姐/哥,人狠话不多”原则,也很适合用在技术写作中。一定要直接了当,让用户容易找到、容易阅读。

在给技术专家写邮件时,极简主义要求我们少说废话,少兜圈子,直接上主题。对于技术专家来说,邮件越短,说的越清楚,他们回复字数越少越好。

最好是选择题,其次是填空题,最后是简单题。如果我们每次都让让技术专家像高考作文那样战战兢兢去审题,反复揣摩,然后还要攒出八百字小作文,题材不限。估计我们的邮件就是石沉大海。或者就是脸上笑嘻嘻,心里MMP。

而在真实写作场景中,可以从多个方面尝试简化。

1. 信息结构。尽量减少长句、长段落。提取信息中的关键内容,并列项用尽量列表,最好能够抽提成表格。

如下示例,最开始冗长无比的一段话,相信你看了也是男默女泪,想打人。改为列表就顺眼多了。再进一步改成表格,简直perfect。

图片发自简书App
图片发自简书App
极简示例

(窃以为列表看起来更清爽是肿么肥死~)

如果给我来改,可能会想着把红、绿改成颜色,true和fals改成相应符号。不过这就显得矫枉过正了。而且没考虑到色盲或符号本地化的问题。

2.语言架构

就像第一课中讲的那样。话不要多,石锤就行。

尤其是对于操作类描述,不需要每一步都描述相应的反馈。专家建议的是十步左右给一个反馈描述,避免用户跑偏。

而按照“七步必倒”原则,我们大多数的操作类主题压根都不上需要给出反馈或者实例的标准。

当然,必要的辅助信息还是不可少的。在面对面交流中,还能够给你个眼神,自己体会。用户在读我们的手册时,就算是练过量子波阅读,估计也get不到我们的眼神。

3.语言和信息架构结合

如下面的例子,原本一段话读了像绕口令。修改之后真是重点突出,一眼就可以get到重点。而不需要妄图通过其他方式,如敲黑板,强调重点。

综合应用示例

好了好了,就不剧透更多啦,感兴趣的同仁请移步自动前往观看哦

点击开放资源:技术写作短视频教程或关注微信公众号“科多思技术传播社区”公众号也可。

(悄悄说一句,有众多美女小姐姐和男神

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