前提条件藏在步骤里,是最坑的惊喜
你信心满满地开始,做了好几步,突然发现前置条件不满足
一次让我血压升高的操作体验
我照着一篇部署文档操作,做到第3步,突然看到一句:
我没有管理员权限,前面两步白做了。回去看文档开头,前提条件那一栏只有”已安装Docker”和”至少4GB内存”,没提权限的事。
前提条件的正确落脚点
✅ 正确文档开头。在操作步骤之前,集中列出所有需要满足的条件。读者在开始之前就能判断自己能不能做。
✅ 正确章节开头(章节特有条件)。文档开头放通用条件,每个章节开头放章节特有条件。比如”已安装Docker”放开头,”已完成数据库初始化”放对应章节开头。
❌ 绝对不要步骤中间。“步骤3:需要管理员权限才能执行此操作”——这不是步骤内容,这是前提条件,应该在开始之前就知道。
四种你最容易遗漏的前提条件
我审过一篇文档,7个步骤里有3个需要管理员权限,但前提条件里一个字没提。写的人就是管理员,他从来没想过”不是管理员怎么办”。
“导出数据”文档,前提条件只写了”有导出权限”,但没提”项目中至少有一条数据记录”。没有数据的人点了导出,按钮灰着点不了,也不知道为什么。
用IE的人照着做,界面长得不一样,操作路径对不上。这类问题在内网环境尤其常见——大家都用同一个浏览器,就忘了还有别的浏览器。
用户照着步骤做,做到某一步弹出”请升级版本”的提示,被迫中断。
前提条件检查模板(存好备用)
我后来形成了一个习惯:写完文档后,假设自己是一个刚入职的新人,只有最基础的账号权限,从头到尾走一遍步骤。凡是碰到”我没有XX权限””我没有XX数据”的地方,都是遗漏的前提条件。