注意,本文有剧透,反感者慎入~~
一口气听完了SIGMA(科多思)关于技术写作的分享,真的是干货满满而又意犹未尽。
虽然每节课只有短短几分钟,但都能够通过理论和实例结合,鲜活而又完整地讲述一个主题,强烈推荐各位技术传播同行共飨~
课程主题包含技术写作的概念与特点,技术文档工程师与用户和技术专家的合作,以及常见信息类型、信息架构,同时分析了常见错误与对症改进。
就我个人而言,印象最深的还是极简主义的反复强调和应用。
比如,在第一课《什么是技术写作》的结尾,对比商业宣传写作,以“Click Install”两个词完美展示了极简之美,就问你服不服吧。
把一个操作写成这么简单不难,但是很多很多步操作都写成这样不简单。
让我想到了红楼梦中宝玉拜别父亲的场景,白茫茫一片雪,只余一点红。
也让我联想起了此前一个相声的段子,一个人起夜,与被惊醒的家人进行对话。不同地方人的语言特点不同。同一件事,多可以说到三五十字,少可以归纳为四个字“谁,我,啥,尿”。
(对不起我庸俗了)现在流行的“社会我x姐/哥,人狠话不多”原则,也很适合用在技术写作中。一定要直接了当,让用户容易找到、容易阅读。
在给技术专家写邮件时,极简主义要求我们少说废话,少兜圈子,直接上主题。对于技术专家来说,邮件越短,说的越清楚,他们回复字数越少越好。
最好是选择题,其次是填空题,最后是简单题。如果我们每次都让让技术专家像高考作文那样战战兢兢去审题,反复揣摩,然后还要攒出八百字小作文,题材不限。估计我们的邮件就是石沉大海。或者就是脸上笑嘻嘻,心里MMP。
而在真实写作场景中,可以从多个方面尝试简化。
1. 信息结构。尽量减少长句、长段落。提取信息中的关键内容,并列项用尽量列表,最好能够抽提成表格。
如下示例,最开始冗长无比的一段话,相信你看了也是男默女泪,想打人。改为列表就顺眼多了。再进一步改成表格,简直perfect。
(窃以为列表看起来更清爽是肿么肥死~)
如果给我来改,可能会想着把红、绿改成颜色,true和fals改成相应符号。不过这就显得矫枉过正了。而且没考虑到色盲或符号本地化的问题。
2.语言架构
就像第一课中讲的那样。话不要多,石锤就行。
尤其是对于操作类描述,不需要每一步都描述相应的反馈。专家建议的是十步左右给一个反馈描述,避免用户跑偏。
而按照“七步必倒”原则,我们大多数的操作类主题压根都不上需要给出反馈或者实例的标准。
当然,必要的辅助信息还是不可少的。在面对面交流中,还能够给你个眼神,自己体会。用户在读我们的手册时,就算是练过量子波阅读,估计也get不到我们的眼神。
3.语言和信息架构结合
如下面的例子,原本一段话读了像绕口令。修改之后真是重点突出,一眼就可以get到重点。而不需要妄图通过其他方式,如敲黑板,强调重点。
好了好了,就不剧透更多啦,感兴趣的同仁请移步自动前往观看哦
点击开放资源:技术写作短视频教程或关注微信公众号“科多思技术传播社区”公众号也可。
(悄悄说一句,有众多美女小姐姐和男神