droboticflow/docs/ui/copy-guidelines.md

37 lines
3.3 KiB
Markdown

# 界面文案规范
2026-11-02 用户确认,持续生效。适用于全平台客户可见页面,包括标注、质检、验收、任务池、看板及管理页面;新功能、修复和重构均须遵守。
## 默认呈现
页面只呈现完成当前业务所需的信息:
- 简短的页面、字段、功能名称和操作按钮。
- 客户需要核对的业务资料、统计数值、任务身份、来源、轮次、时间定位及审核意见。
- 当前必要的状态,如加载中、未保存、保存中、只读、处理中;同一事实在同一操作区域只表达一次。
- 当前实际发生的错误、缺项、阻断原因及必要恢复操作。
- 清空、重设等可能造成数据损失的二次确认,简短说明对象和后果。
正常页面不常驻操作教程、功能介绍、重复快捷键说明、技术实现解释、兼容性说明、开发验证信息或“请点击……即可……”类指导。正常状态没有必要信息时不渲染提示栏,也不保留空白占位。
用准确的功能名称解决歧义;确实需要错误指导时,只说明当前问题和必要下一步。报错遵循[用户可见报错文案](error-messages.md),原有重试、结果核对和恢复入口保留。加载、空数据、失败和结果未知必须如实区分。
## 保留边界
- 本规范精简的是系统说明文案。客户填写的备注、标注描述、问题项、审核和验收意见、退回原因及历史业务记录按业务权限与现有契约完整呈现,不因包含“备注”“提示”等词而删除或改写。
- 必要的保存状态、冲突提示、失败恢复、权限限制和破坏性操作确认仍可见、可操作;不以页面简洁为由隐藏异常或放宽业务规则。
- 图标按钮保留简短的可访问名称;表单保留标签。无障碍信息不因减少可见文字而移除。
- 完整教程放在已有的帮助或项目文档中,按需查看;不得把冗余说明批量塞进新折叠栏、悬浮提示或弹窗作为替代。
- 如客户明确要求某项说明常驻,在对应需求中记录适用页面和原因,例外不扩展为其他页面的默认样式。
## 开发与审查验收
界面改动交付前必须完成以下适用项:
1. 检查新增、修改的标题、说明、提示栏、占位文案、悬浮提示和弹窗;每项均应属于上述必要信息,否则删除或缩短。审查意见不能用新增常驻解释来代替清晰的交互。
2. 在本地打开受影响页面,检查正常状态,以及本次涉及的加载、空数据、错误、只读、未保存和确认状态;正常页面没有多余说明或空提示区域,异常仍能被发现并处理。
3. 核对相关业务资料和用户意见未丢失,必要按钮、禁用原因、恢复入口及二次确认仍有效。按改动风险运行相应回归;测试以业务行为和必要信息为依据,不要求恢复已删除的教程文字。
4. 在交付记录中注明检查过的角色、状态及本地截图或验证证据;未能验证的项目明确列出,不以格式检查替代实际页面检查。
仅修改本规范或其他文档、不涉及界面代码时,检查规则一致性、链接和格式即可。上述语义与观感检查属于审查门槛,不用全局关键词黑名单自动删除客户资料或必要报错。