就像用心做好日本料理 | 技术传播

由于我司供应免费晚餐，作为一只平素里除非工作交流，极少开口的闷骚技术狗，借此契机，终于有机会在工作之余，跟同事扯上两句闲篇儿。话题横跨科技、旅行、历史……当然，自然少不了美食。

话说，某日谈及日本料理，越聊越觉得，跟技术文档写作，倒是有几分相似呢！

极简风格。在日剧《深夜食堂》里，每集都会涉及一道日本菜，什么お茶渍け（茶水泡米饭）、猫のご飯（木鱼花盖米饭）、バターライス（黄油拌米饭）……论做法，简直就是随便搞搞糊弄人嘛！掀桌！——然而，这就是典型日本料理的风格啊。并没有复杂的烹调过程，却能带给人极大的味觉满足。

而对于技术文档写作而言，言简意赅是必须的。让我们来看看IBM的权威写作书《Developing Quality Technical Information_bookmark》怎么说：

另外，印象里好像还在其他地方看到过，技术文档写作甚至需要刻意避免使用形容词。毕竟，技术文档的关键在于技术，而非文笔；就好像，日本料理的关键在于食材本身的味道，而非烹调手法。

工匠精神。如果单纯因为“极简”，就认为日本料理“好做”，电影《寿司之神》中的小野二郎大大如果有知，大约会第一个跳出来告诉你：图样图森破。

在这部电影中，有个细节特别令人印象深刻：由于章鱼的肉质比较韧，如果直接用来制作寿司，口感很不好。所以，需要提前对章鱼进行几个小时的人工按摩，软化肉质。不仅如此，制作寿司用到的所有食材，都是这样被精益求精地对待，这也就解释了，为什么简简单单的米饭、生鱼加酱汁组合，可以卖出天价，还供不应求的原因。

而对于技术文档写作而言，强迫是必须的。就此问题，在之前写过的一篇文章中已有体现，就不多说啦，有兴趣的朋友可以戳：一本培养强迫症患者的说明书 | 技术传播

饱含心意。难以想象，一个简单枯燥的料理，到底是怎样的精神力量，可以使一个人倾尽毕生的努力，将其发扬至极致。但是在《便当时间》这本书中，我似乎找到了答案。

《便当时间》是一位摄影师行走访各地日本民众——他们有着不同的年龄、职业和生活背景——拍摄他们每日自带的午餐便当，并采访与之相关的故事。从这些故事中可以看到，无论是妻子为丈夫做便当，母亲为孩子做便当，还是职人为同事做便当……做便当的人把对对方的关爱，满满倾注在便当之中；吃便当的人则心存感激地接受。这些便当中的大部分，其实看起来相当朴素，甚至可说是简陋，却还是可以感受到，一份暖暖的心意，借着便当在彼此之间传递。——我想，做任何事都是相同的道理：只有心里头时时装着对方，苦差事才不会令人烦恼。

而对于技术文档写作而言，为用户考虑是必须的。

他想知道什么？而不是，我想告诉他什么？

我有没有说清楚？而不是，他是不是能听懂？

还有，可能遇到的问题，要提前警示他；可能用到的知识，要提前告诉他。

还有，克制汹涌澎湃的炫耀文采的冲动，换用干巴巴的写作方式，为了让他不再纠结于文学，更直接地获取信息；精心地调整内容结构，为了让他在不经意间更轻松地查找索引。

还有还有……（脑补《橄榄树》）

所以你看，技术文档写作是不是就像做日本料理一样呢？感觉自己就像是写说明书的小野二郎，为了让坚韧如章鱼肉质的技术信息，吃在用户嘴里时焕发出美妙口感，每日心心念着用户体验，反复打磨文字如同给章鱼做按摩软化肉质，把一份单纯的工作，精益求精地做到强迫——我靠，简直要被自己感动了！