用户点 Start 后会出现一系列步骤,它们必须执行这些操作来完成快速开始。
在编写任务步骤时遵循这些常规指南:
- 对于按钮和标签使用 "Click"。在选择框、单选按钮和下拉菜单中使用"选择"。
使用 "Click" 而不是 "Click on"
正确的示例:
Click OK.
不正确的示例:
Click on the OK button.
告诉用户如何在管理员和开发者视角间如何切换。即使您认为某个用户可能已经处于正确的视角,最好仍为用户提供相应的操作说明,使其确定位于正确的位置。
示例:
Enter the Developer perspective: In the main navigation, click the dropdown menu and select Developer. Enter the Administrator perspective: In the main navigation, click the dropdown menu and select Admin.
使用 "Location, action" 结构。告诉用户要做什么前先告诉用户到什么地方。
正确的示例:
In the node.js deployment, hover over the icon.
不正确的示例:
Hover over the icon in the node.js deployment.
- 保持您的产品术语大写一致。
- 如果您必须指定一个菜单类型或使用列表作为下拉菜单,使用 "dropdown"(一个单词,没有短横线)。
明确区分用户动作和产品功能的附加信息。
User action:
Change the time range of the dashboard by clicking the dropdown menu and selecting time range.
Additional information:
To look at data in a specific time frame, you can change the time range of the dashboard.
避免方向性的语言,如 "In the top-right corner, click the icon"。因为当 UI 布局改变时,方向语言就有可能变为不正确。另外,桌面用户对于具有不同屏幕大小的用户来说,方向可能是不正确的。反之,使用它的名称来标识项。
正确的示例:
In the navigation menu, click Settings.
不正确的示例:
In the left-hand menu, click Settings.
不要只使用颜色来标识项,如 "Click the gray circle"。颜色标识符对受限制的用户,尤其是无法识别颜色的用户可能不可用。相反,使用它的名称或复制来标识项目,如 button copy。
正确的示例:
The success message indicates a connection.
不正确的示例:
The message with a green icon indicates a connection.
一致性地使用第二人称(you):
正确的示例:
Set up your environment.
不正确的示例:
Let's set up our environment.