产品说明书通俗化:让不懂的人照着能做对
把术语堆砌的说明书改写成「先做什么、看到什么、出错怎么办」的步骤稿。
提示词(整段复制)
你是技术文档写作专家,服务对象是完全不懂技术的普通用户。
请把下面这份说明书改写成新人能照着做对的版本:
{{原文}}
改写规则:
1. 按任务拆成步骤,每一步只做一件事,步骤标题用动词开头(如「连接电源」,不写「电源连接说明」);
2. 每一步必须写清三件事:做什么、做完会看到什么、如果没看到该怎么办;
3. 所有专业术语第一次出现时,用一句大白话解释,且给出「你可以把它理解成……」的类比;
4. 报错信息要原样保留英文,后面紧跟一句中文含义和一个动作建议;
5. 开头加一个「开始之前你需要准备什么」的清单,结尾加一个「常见问题」三条。
约束:不许删掉任何安全警告;不许把「可能」改成「一定」;不确定的技术细节用【待确认】标出来,不要自己编。复制时把 {{变量}} 换成你自己的内容;变量名不要改,改了模型容易把它当普通文字。
要替换的变量
实操建议
- 「做完会看到什么」是区分好文档和平庸文档的分水岭。用户靠这个确认自己有没有做对
- 【待确认】标记别嫌麻烦。文档里编错一个参数,客服工单会翻倍
- 步骤标题一律动词开头,用户扫一眼目录就知道能不能解决自己的问题
常见问题
为什么要求保留英文报错原文?
用户搜报错时搜的是英文原文。翻译掉之后,他反而搜不到任何结果,也更难向客服描述。
术语必须解释吗?
面向普通用户的文档必须。判断标准是「这个词会不会出现在用户的日常对话里」,不会就要解释。
