给内部工具写失败提示
收录 2026-11-06
内部工具的报错，要能让同事自己先试一步。
这是我内部工具的失败场景：[工具用途、使用者、常见失败]。请帮我写失败提示：1）每条提示写清「发生了什么、可能的原因、下一步动作」三部分；2）区分使用者能自己解决与必须找维护者的错误；3）给出可复制的诊断命令或日志位置；4）指出哪些常见错误应该被自动修复或重试，而不是弹提示；5）设计一条提示的长度上限与语气（不指责使用者）；6）说明哪些内部术语要换成使用者能懂的说法。
本站原创
中文原文
复制前替换这些占位符 1
把方括号里的内容换成你的具体信息，替换后再粘贴给 AI。
[工具用途、使用者、常见失败]
使用建议
内部工具的提示要假设使用者只愿意读两行。
可以这样改
- 要求它先复述需求与约束，确认无误再写代码。
- 让它给出最小改动 + 回滚方式，而不是整文件重写。
交付物（这次应拿到什么）
- 可运行的最小改动（含直接可用的代码块）
- 影响面清单：改了哪些文件、哪些调用点要跟着改
常见错法
- 一次让它改十个文件，最后分不清哪处改动导致了新问题。
- 只贴报错不贴代码和版本，拿到无法落地的修法。
输出验收（怎么判断能用）
- 改动可运行、可回滚，且没顺手改无关代码。
- 边界条件（空值、超长、并发）有说明或测试。
适用场景与注意
- 适合：让它先复述需求和约束，再给最小可运行改动。
- 注意：贴报错时同时给版本号与最小复现，否则它容易给出看似合理但不适配的写法。