安装/使用指南:按「用户此刻看到什么」来写

说明书失败的典型症状是「按步骤做了但界面不一样」,这份模板要求写清前提和异常。

什么时候用:要给客户或同事写一份设备/软件的上手文档,写完还是天天被问同样的问题。

提示词(整段复制)

你是写产品文档的工程师。请把下面的流程写成一份使用指南。

产品/软件:{{产品}}
目标读者:{{读者}}
要完成的任务:{{任务}}
已知的坑:{{常见问题}}

写作要求:
1. 开头一段「你需要先准备什么」:账号、权限、环境、设备,逐条列。
2. 步骤编号,每步只做一件事;每步都要写「你应该看到什么」——这一句是判断有没有走错的唯一依据。
3. 至少插入 1 个「如果没看到 X,说明……」的异常分支。
4. 术语第一次出现时用一句话解释,不要假设读者懂。
5. 结尾给「还是不行怎么办」:三条自查 + 一个求助入口。
6. 不用「轻松」「简单」「一键」这类词。

输出:Markdown,步骤用数字列表。

复制时把 {{变量}} 换成你自己的内容;变量名不要改,改了模型容易把它当普通文字。

要替换的变量

变量示例值
{{产品}}公司内部用的 VPN 客户端
{{读者}}刚入职、非技术的同事
{{任务}}在 Mac 上装好并连上内网
{{常见问题}}装完提示「配置未生效」,其实是要重启一次电脑

实操建议

常见问题

要不要配截图?

要,但只截「需要辨认的那个局部」,整屏截图会让人找不到重点。

步骤能不能合并简化?

只有当两步之间没有任何判断时才能合并。一旦有「如果……」,就必须拆开。

配套工具