备忘单编辑准则
备忘单和组合备忘单使用户能够通过完成一系列步骤来实现目标。下列准则讨论何时使用备忘单以及如何更好地编写备忘单。
何时创建备忘单
备忘单非常适合于那些需要执行多个步骤以实现切实目标的任务,例如构建简单的应用程序。此目标的定义必须明确,以使用户在完成备忘单中的所有步骤后能够看到成功的结果。教程通常是不错的备忘单候选,在教程中,目标是了解如何执行特定的任务。备忘单通常包含多达 10 个步骤,并且可以在半小时或更短时间内完成。对于较大型的任务来说,请考虑使用组合备忘单。
何时创建组合备忘单
对于由于太大而无法在单个备忘单中进行描述或者有多个目标的任务来说,可以使用组合备忘单来提供指导。可以使用组合备忘单来描述每个任务都依赖于先行任务的一系列任务。
何时不使用备忘单
备忘单最适合于可以通过一系列简单步骤解决问题的情况。由于帮助系统允许创建包含丰富图形并允许通过搜索功能和超链接来对信息进行随机访问的 HTML 页面,因此,备忘单无法替代帮助系统。备忘单不适合于要求用户输入大量文本的任务。
创建备忘单时应该遵循的准则
- 选择简短而有意义的标题。
- 在备忘单中,尽可能利用帮助系统的链接来提供背景信息或更详细的信息。
- 如果步骤数超过 10 个,则考虑改写为组合备忘单。
- 尽可能利用命令来执行简单而令人厌烦的任务,例如打开透视图、打开资源和执行向导。确保还提供有关如何在不使用命令的情况下实现同一效果的描述。
- 确保用户决定手工执行这些步骤时可以跳过这些命令。
- 对于那些需要打开对话框的步骤,指定 dialog="true"。这将导致在大部分对话框右边的“托盘”中打开备忘单。
- 以适当的方式组织步骤,使用户可以经常看到指示成功的可视信号。对于需要对 Java 源代码进行许多不同的更改并接着启动应用程序的备忘单来说,可以将它们改写成在每次更改源代码后启动应用程序。
- 确保用户理解他们执行每个步骤的原因。
- 挑选需要最少量描述的最简单方法,而不要描述多种执行某个步骤的方法。
- 使用中断(<br/>)标记来提高可读性。
- 可以使用子项来将步骤分解成更小的步骤。
- 并不是所有备忘单都需要子项。
- 在子项标签文本开头使用诸如“输入”、“展开”或“选择”之类的操作词。
- 对于子项标签,请使用引号来清晰地标识界面文本,以使用户能够将指示信息文本与他们需要查找和交互的界面文本区分开。
- 每个子项都应该负责完成一个原子任务(例如输入一个值)。
- 始终在备忘单的最后一个步骤中添加 <onCompletion> 元素。
- 使用不同的备忘单视图大小来测试备忘单。
- 在打开错误日志视图的情况下测试备忘单,以便查看是否已将任何警告写入该日志。
创建组合备忘单时应该遵循的准则
- 组合备忘单应该包含通过公共主题相关的任务。
- 组合备忘单中的每个任务都应该有明确的目标。
- 使用 <onCompletion> 元素来识别成功的结果。
- 任务名应该短而精炼。
- 可以使用基于先行任务的一系列任务来解决复杂的问题。
- 如果某个任务是可选的,则使用 skip="true"。
- 为了确保一致,请确保简单备忘单简介和名称与组合备忘单中指定的简介和名称匹配。
- 对于任务描述,请使用粗体格式清晰地标识界面文本。
- 仅当强制安排任务的启动顺序十分重要时,才应该使用序列。
相关链接
使用备忘单
使用组合备忘单
简单备忘单
组合备忘单