站群导航· 游戏攻略 / 礼包码 / 配置 / 换算 / 查询 / 手册
导航菜单
首页 全部文章 留言本

给非专业读者写说明文:把术语翻译成动作的4步

一份面向全公司的系统操作说明,写了「请在鉴权模块完成身份校验后进入业务中台」。发出去三天,后台收到21条咨询,全是问「鉴权模块在哪」。写的人觉得说清楚了,读的人一个字没懂。

第1步:找出所有名词术语,列成清单。鉴权、中台、接口、字段、灰度、闭环,一份说明里通常有8到15个。逐个问:一个没接触过这块业务的人,能不能指出它在哪、长什么样。不能,就翻译。

第2步:术语换成动作。不说「完成身份校验」,说「输入工号和密码,点登录」。不说「进入业务中台」,说「在首页点第三个图标」。动作有位置、有顺序,读者能照着做。

第3步:每一步配一个可见的结果。写完「点登录」,补一句「页面跳转到待办列表,左上角显示你的名字」。读者靠这个结果确认自己做对了。常见错误是只写操作不写反馈,用户点完不知道成没成,只能打电话问。

第4步:找3个非专业同事试读。让他们照着说明操作,你在旁边不说话,只记录他们卡住的位置。3个人里有2个卡在同一处,那一处就要重写。这个测试花30分钟,能消掉大部分咨询量。

一个对照。改前:「请在鉴权模块完成身份校验后进入业务中台提交工单。」改后:「1.输入工号和密码,点登录;2.看到待办列表后,点左上角‘新建工单’;3.填写标题和描述,点提交;4.页面显示工单编号,说明提交成功。」后者字数多了,咨询量从21条降到3条。

还有一个误区:以为加个括号解释术语就够了。写「鉴权(即身份验证)」,读者还是不知道去哪操作。解释词义不如给出动作,动作比定义有用。

写给非专业读者,判断标准只有一个:他能不能不看第二遍就做对。写完自己念一遍,每一步问「然后呢、在哪、我怎么知道成了」,三个问题都答得上,说明文才算写完。

站群互链

攻略窝 · 礼包窝 · 配置窝 · 换算窝 · 算法窝 · 查文窝 · 手册窝 · 问答窝 · 全文搜 · 手册库
上一篇 公众号标题取名:12个可套用的句式与3条避坑线 下一篇 沟通话术不是背句子,这3个场景用「事实+影响+请求」就够了