SuperAPI AI 工具集

writing-error-messages

写作与研究

查看项目

更新于 10-16 09:12

技能介绍

用途

writing-error-messages 是一个用于撰写、审查和改写面向用户的错误提示信息的技能。它适用于表单校验消息、空状态与错误状态、认证错误、失败通知等场景,帮助写作者产出清晰、可操作、尊重用户的错误文案。

主要能力

技能围绕四个前置识别要素展开:受众(终端用户、管理员、开发者、支持人员或运维人员)、失败动作(什么操作失败了、什么仍然成功)、原因(已知、未知、用户可纠正、服务端、第三方或安全敏感)、恢复方式(读者现在能做什么、系统接下来会做什么、去哪里求助)。

在此基础上,技能给出消息结构模板:

[发生了什么] [如有用则给出安抚]。 [如已知且安全则说明原因]。 [具体下一步操作]。 [如果问题持续则给出备用路径]。

示例:

Unable to connect your account Your changes were saved, but we couldn't connect the account because of an issue on our end. Try connecting again. If this keeps happening, contact support.

技能还提供核心规则对照表,强调:说明发生了什么(而非“出错了”)、说明哪些未受影响、给出下一步操作、使用平实语言、避免指责用户、语气与风险程度匹配、在安全时具体、在安全要求下保持通用。

消息解剖部分列出可用的组成元素:标题(概括失败动作)、正文(解释后果与原因)、主操作(告诉读者做什么)、备用路径(提供出路)、诊断细节(帮助技术读者或支持人员)。UI 正文建议控制在 1-2 句,较长的诊断细节放入可展开文本、日志或支持上下文中。

使用方式

技能包含两个参考文件:当需要审计大量消息、解决措辞权衡或核对有来源支撑的理由时,打开 references/source-backed-patterns.md;当需要改写多条消息或测试技能是否产出正确形态时,打开 references/rewrite-examples.md。

在表单校验方面,技能建议:字段级错误放在字段旁边,长表单在顶部汇总;消息与字段标签或问题匹配;说明如何修复而非仅指出错误;保留用户输入;不要在用户尚未完成输入前就校验。推荐写法如“Enter an email address”“Enter a date in the past”“Password must be at least 12 characters”“Choose a file smaller than 10 MB”;避免“This field is required”“Invalid input”“You entered an illegal value”“Validation failed”。

在放置与无障碍方面:把错误放在读者视线所在处(字段、控件、提示来源或失败项附近);不要仅依赖颜色,应包含可见文本、图标或标签以及机器可读语义;表单页面按产品的无障碍模式将焦点移到错误汇总或第一个错误;尽可能保留用户的工作;不要把空结果当成错误,若无失败应写空状态(如“No invoices found”加下一步有用操作)。

在安全与隐私门槛方面:具体并不总是更好。当细节可能泄露账号是否存在、权限、私有数据、系统内部、欺诈信号或安全策略时,应使用通用文案。登录和账号恢复使用通用文案,如“Invalid email or password”“If an account exists for that email address, we'll send password reset instructions.”不要泄露“邮箱存在但密码错误”“账号已锁定”“未找到该邮箱的账号”。如需帮助,给出安全路径:支持、恢复说明、请求 ID 或审计安全的解释。

在面向开发者和 CLI 的错误方面,当读者能对技术细节采取行动时,以结构化方式包含:失败的命令、文件、字段或资源;期望值与实际值;最小修复或下一步诊断命令;支持/调试所需的请求 ID、错误码或日志路径。仍应避免堆栈跟踪、原始异常名和内部服务名,除非受众能用上它们。

当被要求写“通用错误”时,技能不建议直接接受,而应先追问:用户想完成什么操作?代码或服务中是什么触发了这个错误?原因是已知、未知、间歇性还是安全敏感?是否有任何内容被保存、发送、扣费、删除或保持不变?用户能否自行修复、重试、等待、走另一条路径或联系支持?发生频率如何,是否阻塞主流程?若原因确实未知,使用通用但可操作的兜底文案,如“Something went wrong / Refresh the page and try again. If this keeps happening, contact support with request ID {request_id}.”

适用场景

适用于产品界面中的错误提示、表单校验、空状态、认证与账号恢复错误、失败通知,以及面向开发者和 CLI 的技术错误信息撰写与审查。

限制

技能资料未提供关于收费、价格、平台支持范围或具体效果保证的信息。其内容为写作指导与模式建议,实际应用需结合具体产品上下文。