SwipeGuide:编写有效说明
Last updated: June 19, 2026
遵循极简指令原则,创建有效的指令
遵循极简指令原则
- 设身处地站在用户的角度
- 专注于他们执行的任务
- 选择以行动为导向的方法
- 支持错误识别与解决
- 设计为适用于工作现场、参考与培训
将其应用于您的创建流程
- 编写步骤内容
- 使用最简单的指令形式:动词 + 名词
- 在执行步骤操作时需要的情况下添加更多信息
- 尽可能使用主动语态,以动词开头并使用现在时
- 通过使用相同的词语描述同一事物,确保整个指令/指南保持一致
2. 在步骤下方编写其他信息
- SwipeGuide 中的默认步骤备注
- 警告
对于用户经常犯错和/或错误影响较大的步骤,请使用警告
- 提示
- 使用提示向用户提供有关步骤的额外信息,例如用户执行任务的最佳/最简便方式
- 使用主动语态编写提示,并保持简洁
- 使用超链接,让用户能够访问其他指令中的信息,甚至是外部信息
- 替代方案
- 对于用户可以通过多种方式完成某个步骤的情况,使用替代方案
- 按照编写步骤的相同方式进行编写,并明确说明这是执行相同任务的“另一种”方式
- 修复方案
- 如果用户在执行步骤时可能遇到问题,请使用修复方案描述用户如何在特定步骤内解决问题
- 首先描述问题,然后按照编写步骤的方式编写解决方案:以行动为导向并直截了当
2. 自定义步骤备注
- 设备
- 写明执行每项程序任务所需的设备,并将其记录在相应的步骤备注中。
- 位置
- 写明步骤内容中提到的具体机器或组件位于生产线、车间地面上的何处,或位于哪台机器上。
- 工具
- 写明执行每项程序任务所需的工具,并将其记录在相应的步骤备注中。