SwipeGuide: Writing Effective Instructions

Follow the Minimalist Instruction Principles to create effective Instructions

Follow the Minimalist Instruction principles

1. Step into the shoes of the users
2. Focus on tasks that they perform
3. Choose an action oriented approach
4. Support error recognition & resolution
5. Design for use on-the-job, for reference & training

Learn more about this Model

Apply them in your creation process

1. Writing your Step Content

• Use the simplest form of instruction verb + noun
• Add more information when it is needed to execute the Step action
• Use active voice whenever possible by starting with the verb and using present tense
• Be consistent throughout the entire instruction/guide by using the same word to describe the same thing

 2. Writing additional information under your step

1. Default Step Notes in SwipeGuide

• Warnings

  • Use a Warning for steps where users frequently make mistakes and/or mistakes have a high impact

  • Write your Warnings short and to the point & give an explanation for the importance of the Warning

• Tips
  • Use Tips to provide users with extra information about the step, such as the best /easiest way for users to perform a task
  • Write your Tip in an active voice and be brief
  • Use hyperlinking to give users access to information from another instruction or even external information

• Alternatives
  • Use Alternatives for steps where there are several ways for users to complete a step
  • Write it the same way you would write the step & make it clear that this is "another" way of performing the same task

• Fixes
  • Use Fixes in case of steps where users can be confronted with issues to describe how users can resolve issues within a certain step
  • Start by describing the problem & then write the solution as you would write the step: action oriented and to-the-point

    

2. Custom Step Notes

• Equipment
  • Write which equipment is required to execute each of their procedural tasks in the respective Step Note.

    

• Location
  • Write where the specific machinery or component referred to in the Step Content is located on the line, on the shop floor, or at which machine.
    
• Tools
  • Write which tools are needed to execute each of their procedural tasks in the respective Step Note.