droboticflow/docs/ui/error-messages.md
2026-09-30 05:48:55 -07:00

27 lines
2.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 用户可见报错文案
2026-09-30 用户确认:报错只用普通人能理解的话说明大概出了什么问题,不附技术解释或处理教程。重试、更新意见、查看提交结果等操作按钮仍保留。
## 规则
- 优先指出对象及问题,例如“账号或密码不正确”“视频时间范围加载失败”。
- 不在提示里展示接口名、字段路径、错误堆栈或英文异常。
- 区分确认失败与结果未知:连接中断或超时不能写成“保存失败”,使用“暂时无法确认操作结果”。
- 不推断责任:没有证据时不说是客户网络、账号被修改或数据丢失。
- 数据是否保留、是否已有部分成功属于必要事实,可以保留;不能凭空承诺。
- 表单缺项说明缺少什么,不笼统替换为“操作失败”。
## 实现边界
`src/lib/user-error-message.js` 只负责显示文本。公共 `getActionErrorMessage` 和页面报错展示调用此函数,覆盖认证、项目、账号、供应商、任务、切片、标注、质检、验收、工作流、文件存储、数据库、统计和预览等界面。审核保存、正式提交的提示同时更新。
保留 `APIError` 的原始 message、code、status、details、issues 和 requestId;认证判断、冲突检测、重试与结果核对继续使用原始对象。后端日志、算子日志、下载的诊断报告和客户填写的审核意见不做文案替换。未知技术报错使用对应操作的简短失败提示或“系统暂时无法完成操作”,不猜测具体原因。
新增报错须通过公共显示入口;新增稳定错误码应补充准确的中文分类。不能为修改提示而调整权限、保存、提交或恢复规则。
## 核验
类型检查、前端构建、通用错误映射及结果未知测试;前端全量测试与相同 HEAD 的独立基线逐项比较。页面测试使用本地拦截接口和虚构账号,不写客户数据。
本次核验结果:本地类型检查与构建通过;前端基线的14个失败用例及其断言原因与本次相同。使用本机 Edge 与虚构账号验证登录错误实际显示为“账号或密码不正确”,并验证审核冲突、视频错误和网络中断文案;所有业务接口由测试拦截。未连接公司集群或执行生产发布。