手册编写必备要素:写得清楚,别人才用得顺

上周帮同事改一份《Excel数据透视表操作手册》,发现里面写着“点击菜单栏选择相应功能”,可他用的是Mac版,根本没“菜单栏”这个说法——结果新人照着做了一下午,卡在第一步。手册不是写给自己看的日记,是给别人用的工具,差一个细节,就可能让人干瞪眼。

读者是谁,决定了你写什么

别一上来就列步骤。先想清楚:这本手册给谁看?刚入职的行政助理?还是要临时顶班的IT支持?前者可能连“工作簿”和“工作表”都分不清,后者可能直接跳到VBA宏调试。在首页加一行小字:“适用人群:零基础Office用户”,比堆10页术语解释管用得多。

步骤必须可执行、可验证

“打开文件”太模糊。“双击桌面上名为‘Q3销售汇总.xlsx’的文件”才叫明确。更进一步,加一句“若弹出安全警告,点‘启用编辑’”——很多新手就卡在这儿不敢动。每一步都要像教爸妈用微信:鼠标移到哪儿、点几下、等什么提示出现、看到什么画面才算成功。

截图不是装饰,是说明书的眼睛

纯文字描述“点击‘数据’选项卡→‘筛选’→勾选‘自动筛选’”,不如一张带红圈标注的截图来得直接。注意:截图别用高分辨率大图塞满页面,裁掉无关区域,把关键按钮用箭头或圆圈标出来。Mac和Windows界面差异大,如果手册通用,就并排放两张图,标清“Windows版”“macOS版”。

留个“翻车”记录,反而省事

在常见问题章节里,别只写“如何正确操作”,加一条:“如果点‘保存’后没反应——检查是否启用了OneDrive同步,暂存文件可能被锁定”。这是上次小张遇到的真实情况。把别人踩过的坑记下来,比写十遍正确流程都有用。

格式不花哨,但得有呼吸感

别整篇密密麻麻黑字。段落间空行,小标题加粗,关键操作词用等宽字体标出(比如Ctrl+Shift+L)。长步骤拆成编号列表:

  1. 按住Alt键不放;
  2. 连续按DST三下;
  3. 松开所有按键,出现‘开发工具’选项卡。

最后,打印出来自己从头跟一遍。边念边做,卡住了?那就是该改的地方。