乐于分享
好东西不私藏

技术文档写作坑点-知识诅咒

技术文档写作坑点-知识诅咒
文档写作的坑 · 第1篇

知识诅咒:你觉得"这还用说?"读者觉得"这说的是啥?"

每一条都是我踩过的,或者帮别人审校时见过的

一次让我意识到问题的审阅

数据同步的功能文档我维护了三年,闭着眼都能说出每个配置项的含义。有次让我写个操作指南,我觉得简单,半小时就写完了。

写完交给一个新来的同事看,他看了十分钟问我:

"数据源和目标端有什么区别?同步策略选全量还是增量,怎么判断?令牌过期了去哪刷新?"

我愣了一下——这些对我来说太"显然"了,我完全没想到要写。

这就是知识诅咒:你一旦掌握了某项知识,就很难想象不知道它是什么感觉。

知识诅咒的三个面目

01
跳过背景
02
默认术语已理解
03
省略中间步骤
表现一:跳过背景
直接写"配置数据源连接参数"
但新同事根本不知道数据源是什么、跟目标端是什么关系。我默认他跟我一样理解整个数据流,但他不理解。
表现二:默认术语已理解
写"选择增量同步策略"
对新人来说,增量同步意味着什么?跟全量有什么区别?什么时候用哪个?不说清楚,"增量同步"四个字就是天书。
表现三:省略中间步骤
写"在认证页面获取令牌",一步带过
实际操作是:打开设置页 > 找到API管理模块 > 点击令牌管理 > 点击创建令牌 > 复制令牌值。我跳过了三个中间步骤,因为我觉得"这还用说?"。

三个破解方法

试读法 找不熟悉产品的人读你的文档,你坐在旁边观察他在哪里停顿。不是事后问"哪里不懂",是实时看他读。有个同事帮我审一篇指南卡了6次,我把6个卡点都补上了,那篇文档的跳出率从72%降到了28%。
间隔审读法 写完放两天再看。周四写完初稿,周一早上审读。周一的状态最接近"半陌生"的读者——还没完全忘,但已经不是全知视角了。
术语首次解释法 每个术语第一次出现时,紧跟一句话解释。比如:"配置增量同步(只同步上次同步后变更的数据)策略。"括号里那半句话,决定了读者是继续读还是关掉页面
方法对比一览
试读法效果最好 · 操作成本高
间隔审读法效果好 · 只需等两天
术语首次解释法成本极低 · 适合所有文档

立刻可以做的事

☐  拿一篇你最近写的文档,找一个不熟悉该产品的同事读,观察他在哪里停顿☐  把你文档里第一次出现的专业术语列出来,每个加一句简短解释☐  下次写文档,写完放两天再审读,重点看有没有跳过的背景和省略的步骤☐  在审校清单里加一项:"有没有对读者'显然'但实际需要解释的内容?"
一句话记住这篇
你不知道自己被诅咒了让陌生人的眼睛看你的文字
📖 下一篇预告
冗余的温柔刀——删掉20%,意思一点没变
本文由 AI 协助整理润色
更多技术文档写作干货
文档不头疼
👆 欢迎关注公众号
#文档不头疼#Carly聊技术写作#技术传播#文档写作#技术文档#知识诅咒#写作踩坑