本主题介绍编写 Windows Admin Center 用户界面 (UI) 文本的常规方法,以及我们采用的一些特定惯例和方法。
Windows Admin Center 和任何扩展名都应遵循 Microsoft 语音原则,以便提供易用、友好的体验。 此风格指南基于这些语音原则和 Microsoft 编写风格指南,因此请务必查看上述两种资源中有关辅助工具、缩略语和请、抱歉等词汇选择的信息。
按钮
按钮名应尽可能使用一个单词,尤其是在打算本地化该工具的情况下。 可以使用两三个单词,但尽量避免太长。 如果是四个或更多个单词,最好使用链接控件。
按钮标签应该简洁具体而又明晰易懂。 使用与用户操作对应的动词,如“创建”、“删除”、“添加”、“格式化”等,而不是使用通用的“提交”按钮。
如果一个按钮后跟着一个问题,其标签应该清楚地回答该问题(通常为“是”或“否”)。
启动创建流时,请使用相应的按钮标签:
按钮 使用 创建 创建新的资源/对象等。 添加 将现有资源/对象等添加到工具。 安装 安装软件/扩展。
大写
我们遵循 Microsoft 大写风格 - 基本全部使用句子元素的首字母大写。
UI 元素 | 大写 | 注释 |
---|---|---|
提醒标记(如 PREVIEW) | 全部大写 | |
其他 | 首字母大写 | 但是,我们在 WMI 或 PowerShell 中展现对象属性时有一些例外情况是我们无法控制的。 |
冒号
使用冒号来引入列表。 例如:
选择以下选项之一:
- 猫
- 狗
- 沙袋鼠
不要在 UI 文本中使用冒号,当标签与它标记的内容在不同的行上时,或者当标签与它标记的内容之间有明显的区别时。
如果标签与其标记的文本在同一行上,并且你需要防止这两个元素混合在一起,请在 UI 文本中使用冒号。
确认消息
如果继续操作可能会产生意外结果(例如数据丢失),则确认对话框可以派上用场。 确认对话框应包含简明扼要的有用信息,尤其是对于无法撤消的事件。
- 确保确认是必需的。 如果没有提供新信息(例如,“你确定吗?”),则可能不需要确认消息。
- 验证客户是否要继续执行操作。
- 确保主要说明(标题)和说明性文本(正文)不是多余的。
- 在标题中,将可能的结果定义为关于接下来会发生什么的问题或陈述。 例如,“擦除此驱动器上的所有数据”或“你即将擦除所有数据”。
- 在正文中添加详细信息。 如果有变量,例如要更改的项的名称,请包含在此处。
- 包括一个简单的问题(在标题或正文中),在两个操作按钮之间做出明确的选择。
- 对于复杂的选择,请使用“是/否”按钮,这鼓励仔细阅读。 对于更简单的选择,请使用特定于操作的按钮,例如“全部删除”或“取消”。
首次运行体验
可以使用工具帮助第一次访问某一页面的用户入门。 这可以是:
- 空页面中的带有入门方法简短介绍的文本字符串,例如,“选择‘添加’以添加应用。”
- 帮助用户入门的控件链接,例如,“添加应用并开始”。
- 一段向用户展示入门方法的简短动画或视频
以下是我们 Windows 风格指南中的一些提示:
1. 有所帮助
- 避免使用营销风格或语言。
- 当演示或建议某事时,确保最终结果简洁明了;如果客户不知道这么操作的原因,那么只向他们展示操作方法是没有效果的。
- 不显示客户不需要的提示。
2. 展示而非讲述
尽可能简化文本(考虑小型动画或视频)。
3. 避免信息量过大
- 每个组合使用情况会话的弹出窗口和提示最多为 4 个,包括系统通知和 shell 通知。
- 确保弹出窗口的出现时机合适。
- 不要阻止客户执行操作。
- 确保弹出窗口可以轻松消除。
4. 符合情境
- 教学片段在恰当时间显示最为有效。
- 创建教程或幻灯片时需确保信息具体明确。
- 拒绝营销“垃圾”- 专注于具体提示和技巧。
- 如果有必要,为客户提供之后返回教程的方法(安装说明可能仅相关一次,而人们第一次通常不会保留信息)。
- 空页面消息应该能让用户了解消息出现的原因并且/或者让用户感到舒心,因此应确保消息简洁实用。
5. 减少费力安装
客户为了体验全部价值所需执行的其他操作(如登录到在线服务)应尽可能容易。
- 消息应该简短直接。
- 避免客户流失。 如果可能,请提供一种从客户所在地进行连接的方法。
- 如果可以,提供稍后执行的选项,然后提醒客户稍后执行。
- 如果在客户体验中略过了一些选项,应提供快速简单的切回方法。
“帮助”链接
以下是我们 Windows 风格指南中的一些提示:
何时应提供帮助链接?
几乎从不。 仅在以下情况下提供帮助链接:
- 客户在使用 UI 时可能会遇到一个明显而重要的问题,这个问题的答案将帮助他们成功完成 UI 任务。
- UI 中没有足够的空间来提供用户成功完成 UI 任务所需的信息量。
应在哪里显示帮助链接?
- 文本链接应尽可能接近帮助所指向的 UI 元素。
- 如果必须提供适用于整个 UI 屏幕的文本链接,请将其放在屏幕的左下角。
- 如果通过“帮助”按钮 (?) 提供链接,则工具提示应为“帮助”。
应使用什么 URL?
切勿直接链接到网址,而是使用重定向服务。
Microsoft 开发人员应使用 FWLink,除非它是用户可能必须手动键入的帮助链接,在这种情况下,请使用 aka.ms
链接(只要 URL 的目标是自动识别浏览器区域设置的网站,如 learn.microsoft.com
)。
文本指南
- 使用完整句子。
- 不要包含结尾标点(除非是问号)。
- 你不需要使用与任务标题相同的文本;使用在 UI 上下文中有意义的文本,但要确保两者之间存在逻辑联系。 例如:
- 帮助链接:允许例外有什么风险?
- 帮助主题标题:“允许程序通过 Windows 防火墙进行通信”
- 帮助主题的内容要尽可能具体。
- 我们的风格
- Windows 防火墙如何帮助保护我的计算机?
- 为什么突出显示可以改善图片
- 不是我们的风格
- 有关 Windows 防火墙的详细信息
- 了解有关色彩管理的更多信息
- 了解更多
- 我们的风格
- 使用整个句子作为链接文本,而不仅仅是关键词。
- 我们的风格
- 不是我们的风格
- 允许例外有什么风险?
- 在某些情况下,可以使用“了解更多”链接,前提是上下文清楚用户点击该链接后将获得的内容。
错误消息
以下是改编自 Windows 风格指南的一些指导:
一条出色的信息的标准是既能够解释清楚,又不能过于技术化:既要有个性、不刻板,又不能表现出无理或冒犯性。
一般指南
每个错误案例使用一条消息。
标题
- 保持简短,并简明扼要地解释问题是什么,或者最好不要做什么。
一些 UI 表面可能会在标题太长时截断而不是换行,所以请留意这些标题。 - 如果这是一个简单的步骤,请使用标题中的解决方案。
- 确保标题与按钮直接相关,以防读者忽略正文。
- 避免在标题中使用“有问题”,除非别无选择。 请更具体地了解问题。
- 避免在标题中使用变量(如文件、文件夹和应用程序名称)。 把它们放在正文中。
正文
如果标题充分解释了问题或解决方案,则不需要正文。
不要只是修改消息中的几个措词来重复标题。
简洁明了地传达解决方案。
注重先讲事实。
不要将错误归咎于用户。
如果存在与该错误关联的错误代码,并且你认为包含该错误代码可能有助于客户或 Microsoft 支持人员研究该问题,请将其直接包含在正文文本下方,并按如下方式编写:
错误代码:####
如果客户拥有在没有代码的情况下解决错误所需的所有信息,则不需要包括这些信息。
按钮
- 写下按钮文本,使其成为对主指令的特定响应。 如果无法做到这一点,请使用“关闭”作为解除按钮文本(而不是“好的”或“完成”)。
- 如果有多个按钮,请将最左侧的按钮设为鼓励用户执行的操作。 使最右侧的按钮成为更保守的操作,例如“取消”。
“帮助”链接
只考虑你无法使其变得具体和可操作的错误消息的帮助链接。
Null 状态文本
下面是 Windows 样式指南中的一些帮助。
当应用或功能中缺少客户数据或内容时,当搜索后未返回结果时,或者当表单中缺少所需信息(如交易的帐单信息)时,会出现空状态。
指南
- 如果可能,使用空状态情况作为教育人们如何使用该功能的机会(例如,如何添加音乐,在哪里查找图片等)。
- 如果你的 UI 中有一个标题,请解释“修复”空状态所采取的操作(例如,“添加一些音乐”)
- 享受文字的乐趣。 这个空间可能提供了一个玩耍的机会,因为用户基本上看不到。
- 避免用“这里很孤独”。 这句话很糟糕,已经用烂了。
- 避免诸如“尚未连接打印机?”之类的问题 可以使用一次,但这种格式往往会被过度使用,并且问题会给客户带来额外的负担/压力。 也可以感觉到居高临下。
- 有多种多样的空状态文本是一件好事。
示例
- “将某个人添加为收藏,你将在此处看到他们”。
- “有你特别引以为豪的成就或游戏剪辑吗? 将它们添加到展示中”。
- “还没有人参加聚会。 来一个人吧!”
- “有人将你添加为朋友后,你会在这里看到他们”。
- “在你执行解锁成就、录制游戏剪辑和添加好友等操作时,可以在这里看到”。
- “你最喜欢的朋友将显示在这里,所以你可以看到他们什么时候在线,以及他们在做什么”。
标点
状态消息
状态消息由弹出 (toast) 消息和通知组成。
字符串类型 | 备注 |
---|---|
toast | 带有结束标点符号且首字母大写 - 最好带有对象变量,以便用户能在离开对象后了解消息适用于哪个对象。 |
通知标题 | 没有结束标点符号且首字母大写(这是一个标题) - 最好带有对象变量 |
通知详细信息 | 完整句子,最好带有显示对象的 UI 链接 |
下面是通知消息的一些详细建议:
字符串类型 | 备注 |
---|---|
已开始 | 尽可能省略 - 通常可以直接跳到正在进行的消息以减少干扰次数。 |
正在学习 | 开头是表示正在执行的操作的动词,结尾是表示操作正在进行的省略号。 下面是一个示例: 正在创建“客户数据”卷... 有多个变量时,使用以下模式: 正在删除以下虚拟机:{0};主机:{1} |
成功 | 开头是“已成功”,结尾是软件刚刚完成的操作。 下面是一个示例: 已成功创建“客户数据”卷。 |
失败 | 开头是“无法”,结尾是软件无法完成的操作。 下面是一个示例: 无法创建“客户数据”卷。 |
工具提示
良好的工具提示简要描述未标记的控件,或者为标记的控件提供一些附加信息(如果这很有用)。 这些工具提示还可以通过提供有关控件标签、图标、链接等的附加(但不啰嗦)信息来帮助客户浏览 UI。
应谨慎使用工具提示,最好完全不使用。 工具提示可能会干扰客户,所以不要包含简单重复标签或陈述显而易见的内容的工具提示。 工具提示应始终添加有价值的信息。
上下文 | 如何编写工具提示 |
---|---|
当控件或 UI 元素未标记时... | 使用简单的描述性名词短语。 例如: 突出显示笔 |
一个 UI 元素被标记时,但需要澄清其用途... |
|
在某些语言中,当文本标签被截断或可能被截断时... |
|
如果键盘快捷方式可用... |
|