遵循 UI 警报指南

警报或消息对于告知用户在用户界面中取得的进展或遇到的问题非常重要。

使用以下警报类型

  • 成功

  • Info

  • 警告

  • 危险 (错误)

通用警报指南

编写警报时,请遵循以下规则

  • 保持礼貌,不要责怪用户

  • 使用现在时描述当前存在的条件,或使用过去时描述过去发生的特定事件

  • 保持句子简短但有帮助

  • 遵守 写作风格 部分的指南

新的危险 (错误) 条件的警报结构

危险警报或错误消息应帮助用户快速解决问题,以便他们能够继续取得进展。 如果可以通过改进代码来避免发布警报,请不要包含错误。

  1. 清晰简洁地说明问题。

  2. 如果合适,请解释用户遇到错误的的原因。

  3. 如果可能,请告诉用户如何解决问题。 如果需要更多信息,请考虑是否应增强文档。

注意

API 返回可能不够具体,无法遵守这些结构指南。 在说明问题和解决方案时,尽可能明确。

警报示例

成功
  • 已成功创建密钥对 %(name)s。

  • 镜像已成功更新。

Info
  • 正在更新卷快照“%s”

  • 正在创建卷“%s”

警告
  • 策略检查失败。

  • 没有足够的权限查看用户信息。

危险
  • 无法创建卷。

  • 无法检索镜像。