适用于:Windows Admin Center
本主题介绍编写 Windows Admin Center 用户界面 (UI) 文本的常规方法,以及我们采用的一些特定惯例和方法。
Windows Admin Center 和任何扩展名都应遵循 Microsoft 语音原则,以便提供易用、友好的体验。 此风格指南基于这些语音原则和 Microsoft 编写风格指南,因此请务必查看上述两种资源中有关辅助工具、缩略语和请、抱歉等词汇选择的信息。
按钮
- 按钮名应尽可能使用一个单词,尤其是在打算本地化该工具的情况下。 两个或三个是正常的,但尝试避免更长时间。 如果有四个词或更长时间,最好使用链接控件。
- 按钮标签应该简洁具体而又明晰易懂。 使用与用户操作对应的动词,如“创建”、“删除”、“添加”、“格式化”等,而不是使用通用的“提交”按钮。
- 如果一个按钮后跟着一个问题,其标签应该清楚地回答该问题(通常为“是”或“否”)。
大写
我们遵循 Microsoft 大写风格 - 基本全部使用句子元素的首字母大写。
| UI 元素 | 大写 | 注释 |
|---|---|---|
| 提醒标记(如 PREVIEW) | 全部大写 | |
| 其他 | 首字母大写 | 但是,我们在 WMI 或 PowerShell 中展现对象属性时有一些例外情况是我们无法控制的。 |
冒号
使用冒号引入列表。 例如:
选择以下选项之一:
猫狗 Quokkas
如果标签与它所标记的内容不同,或者标签与其标记的内容有明显的区别,请不要在 UI 文本中使用冒号。
如果标签与文本所标记的文本位于同一行上,则可以在 UI 文本中使用冒号,并需要使这两个元素一起运行。
确认消息
确认对话框在继续时可能会产生意外结果,如数据丢失。 它们应该包含可浏览的有用信息,其中包含清晰的结果,尤其是对于不可逆的事件。
- 请确保确认是必需的。 如果没有新信息要提供 (例如,"是否确实要这样做?") 则可能不需要确认消息。
- 验证客户是否要继续操作。
- 请确保 (标题) 和说明文本的主要说明 (正文) 不是冗余的。
- 在标题中,将可能的结果定义为问题或有关接下来要执行的操作的声明。 例如,"擦除此驱动器上的所有数据?或者说 "您将擦除所有数据"。
- 在正文中添加详细信息。 如果有变量(如要更改的项的名称),请将其包含在此处。
- 在标头或正文中包括一个简单的问题 () 在两个操作按钮之间进行明确的选择。
- 对于复杂的选择,请使用 "是/否" 按钮,这会鼓励仔细阅读。 对于更简单的选择,请使用特定于操作的按钮,如 "全部删除" 或 "取消"。
首次运行体验
可以使用工具帮助第一次访问某一页面的用户入门。 这可以是:
- 空页面中的带有入门方法简短介绍的文本字符串,例如,“选择‘添加’以添加应用。”
- 帮助用户入门的控件链接,例如,“添加应用并开始”。
- 一段向用户展示入门方法的简短动画或视频
以下是我们 Windows 风格指南中的一些提示:
1. 有所帮助
- 避免使用营销风格或语言。
- 当你演示或建议某些内容时,请确保最终结果清晰;如果不知道客户执行操作的原因,只是向客户展示如何执行操作。
- 如果客户不需要,则不要提供提示。
2. 展示而非讲述
尽可能简化文本(考虑小型动画或视频)。
3. 避免信息量过大
- 每个组合使用情况会话的弹出窗口和提示最多为 4 个,包括系统通知和 shell 通知。
- 确保弹出窗口的出现时机合适。
- 不要让客户执行一些操作。
- 确保弹出窗口可以轻松消除。
4. 符合情境
- 教学片段在恰当时间显示最为有效。
- 创建教程或幻灯片时需确保信息具体明确。
- 拒绝营销“垃圾”- 专注于具体提示和技巧。
- 为客户提供一种方法,使客户可以稍后返回到教程,如果相关 (人们通常不会在第一次保留信息,但设置说明可能仅) 时相关。
- 空页面消息应该能让用户了解消息出现的原因并且/或者让用户感到舒心,因此应确保消息简洁实用。
5. 减少费力安装
客户为了体验全部价值所需执行的其他操作(如登录到在线服务)应尽可能容易。
- 消息应该简短直接。
- 避免客户流失。 如果可能,请提供一种从客户所在地进行连接的方法。
- 如果可以,提供稍后执行的选项,然后提醒客户稍后执行。
- 如果在客户体验中略过了一些选项,应提供快速简单的切回方法。
“帮助”链接
以下是我们 Windows 风格指南中的一些提示:
何时应提供帮助链接?
几乎不能。 仅在以下情况时提供帮助链接:
- 在用户界面中,客户可能会遇到一个明显而又重要的问题,因为这样可以帮助他们在 UI 任务中取得成功。
- UI 中没有足够的空间来提供用户在 UI 任务上成功所需的信息量。
应在哪里显示帮助链接?
- 文本链接应显示为靠近帮助定向的 UI 元素。
- 如果必须提供适用于整个 UI 屏幕的文本链接,请将其放在屏幕的左下角。
- 如果通过 "帮助" 按钮 (? ) 提供链接,则工具提示应为 "Help"。
应使用哪种 URL?
切勿直接链接到 web 地址-而是使用重定向服务。
Microsoft 开发人员应该使用 FWLink,但它是一个帮助链接,用户可能必须手动键入该链接,在这种情况 (下,只要 URL 的目标是自动识别浏览器区域设置的网站(如 Docs.microsoft.com)
文本指南
- 使用完整句子。
- 不要包含结尾标点符号,但问号除外。
- 不需要使用与任务标题相同的文本;使用在 UI 上下文中有意义的文本,但要确保二者之间存在逻辑连接。 例如:
- 帮助链接:允许例外的风险是什么?
- 帮助主题标题: "允许程序通过 Windows 防火墙进行通信"
- 尽可能详细地了解帮助主题的内容。
- 我们的样式
- Windows 防火墙如何帮助保护我的计算机?
- 为什么突出显示可以改善图片
- 不是我们的样式
- 有关 Windows 防火墙的详细信息
- 了解有关颜色管理的详细信息
- 了解详细信息
- 我们的样式
- 将整个句子用于链接文本,而不只是关键字。
- 我们的样式
- 不是我们的样式
- 允许例外的风险是什么?
错误消息
下面是一些适用于 Windows 样式指南的指南:
编写好的消息是提供足够的说明(但不是太技术性)之间的平衡;介于随意和 personable,但不是令人讨厌或冒犯。
一般指南
每个错误都使用一条消息。
标题
- 请简短地说明问题是什么,或者是理想的操作。 某些 UI 表面可能有一些标题在过长时截断,而不是换行,因此请注意这些。
- 如果这是一个简单的步骤,请在标题中使用该解决方案。
- 请确保当读取器忽略正文文本时,标题直接与按钮关联。
- 除非您没有其他选择,否则请避免使用标题中的 "出现问题"。 更具体地了解问题。
- 避免在标题) 使用变量 (如文件、文件夹和应用程序名称。 将它们放在正文中。
正文
-
如果标题足以说明问题或解决方案,则无需正文文本。
-
不要以略有不同的措辞重复邮件中的标题。
-
清楚地传达解决方案的内容。
-
首先要重点提供事实。
-
不要因用户出现错误而出现错误。
-
如果存在与错误关联的错误代码,并且你认为包含错误代码可以帮助客户或 Microsoft 支持人员调查问题,请将其直接包含在正文文本下方,并按如下所示编写:
错误代码:####
如果客户具有在没有代码的情况下解决错误所需的所有信息,则无需包含它。
按钮
- 写入按钮文本,以便它是对主指令的特定响应。 如果无法做到这一点,请使用 "Close" 表示消除按钮文本 (而不是 "正常" 或 "完成" ) 。
- 如果有多个按钮,请将最左侧的按钮设为鼓励用户采取的操作。 将最右边的按钮设置为更保守的操作,如 "Cancel"。
“帮助”链接
对于错误消息,仅考虑无法实现具体和可操作的帮助链接。
Null 状态文本
下面是 Windows 样式指南中的一些帮助。
如果应用或功能中缺少客户数据或内容、搜索后没有返回任何结果,或表单中缺少所需的信息(如事务的计费信息),则会出现 Null 状态。
准则
- 如果可能,请使用 null 状态情况来了解有关如何使用此功能的机会 (例如,如何添加音乐、在何处查找图片等等 )
- 如果用户界面中有标题,则解释为 "修复" null 状态所采取的操作 (例如 "添加一些音乐" )
- 让文本有趣。 此空间可以提供感到满意,因为它可能不会被多次查看。
- 请避免 "它在此处为孤立内容"。 这是很悲伤的,已过度滥用。
- 避免出现类似于 "尚未连接到您的打印机?" 的问题 只需使用一次,但这种格式往往会使用户滥用,问题会给客户带来额外的负担/压力。 它也可能表现优劣。
- Null 状态文本中的各种内容是一件好事。
示例
- "将某人添加为收藏夹,你会在此处看到它们。"
- "获得了您特别自豪的成就或游戏剪辑? 将它们添加到您的展示中。 "
- "没有人参与。 启动一次 ... "
- "当某人将你添加为朋友时,你将在此处看到它们。"
- "当你执行诸如解锁成就、录制游戏剪辑并添加朋友等内容时,你会在此处看到这一切内容。"
- "您最喜欢的朋友将显示在此处,以便您可以看到它们处于联机状态以及其最新状态。"
标点
状态消息
状态消息由弹出 (toast) 消息和通知组成。
| 字符串类型 | 说明 |
|---|---|
| toast | 带有结束标点符号且首字母大写 - 最好带有对象变量,以便用户能在离开对象后了解消息适用于哪个对象。 |
| 通知标题 (标题) | 不带结束标点的句子 case (它是标题) 理想情况下,使用对象变量 |
| 通知详细信息 | 完整句子,最好带有显示对象的 UI 链接 |
下面是通知消息的一些详细建议:
| 字符串类型 | 说明 |
|---|---|
| Started | 尽可能省略 - 通常可以直接跳到正在进行的消息以减少干扰次数。 |
| 正在学习 | 开头是表示正在执行的操作的动词,结尾是表示操作正在进行的省略号。 下面是一个示例: 正在创建卷 "客户数据" .。。 如果有多个变量,请使用此模式: 正在删除以下虚拟机: {0} ;主持人{1} |
| Success | 开头是“已成功”,结尾是软件刚刚完成的操作。 下面是一个示例: 已成功创建卷 "客户数据"。 |
| 失败 | 开头是“无法”,结尾是软件无法完成的操作。 下面是一个示例: 无法创建卷 "客户数据"。 |
工具提示
好的工具提示简要介绍了未标记的控件,或为标记的控件提供了一些其他信息,这样做会很有用。 他们还可以通过提供额外的(而不是冗余)来帮助客户导航 UI,有关控件标签、图标、链接等的信息。
工具提示应慎用或根本不使用。 它们可能会对客户造成中断,因此,请不要包括只重复标签或陈述明显的工具提示。 它应始终添加有用的信息。
| 上下文 | 如何编写工具提示 |
|---|---|
| 当控件或 UI 元素未标记时 .。。 | 使用简单的描述性名词短语。 例如: 突出显示笔 |
| 如果 UI 元素标记为,但其用途需要澄清 .。。 | <ul><li>简要描述可对此 UI 元素执行的操作。 </li><li>使用命令性谓词窗体。 例如,"查找此文件中的文本" ("在此文件中查找文本" ) 。</li><li>除非有多个完整的句子,否则不要包含结尾标点符号。</li> </ul> |
| 文本标签在某些语言中被截断或可能截断时 .。。 | <ul><li>在工具提示中提供未截断标签。</li><li>可选:在另一行上,提供澄清说明,但仅在需要时提供。</li><li>如果页面或流中的其他位置提供了未截断信息,则不要提供工具提示。</li></ul> |
| 如果可以使用键盘快捷方式 .。。 | <ul><li>可选:在标签或描述性短语后面提供括号中的键盘快捷方式,例如 "打印 (Ctrl + P) " 或 "在此文件中查找文本 (Ctrl + F) "</li><li>可以向阐明的工具提示添加有用的键盘快捷方式,但要避免仅添加工具提示以显示键盘快捷方式。 </li></ul> |
历史资料。此文对应 2021-03-23 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 jasongerend)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
