Create and map out all of your content in SwipeGuide Instruction Builder
Available for tablets and desktops, SwipeGuide Instruction Builder allows you to create, edit using drag and drop and publish job aids in seconds.
Our “what-you-see-is-what-you-get” design on the Platform Editor gives you a preview on Guides almost the same way as the end-user would see it in the Platform Viewer.
Understand the types of content in SwipeGuide
Content creation in SwipeGuide is designed to be flexible, allowing you to create, distribute, and optimize step-by-step instructions for various processes and tasks used for training employees, onboarding, and improving operational efficiency in a wide range of industries, including manufacturing, maintenance, and assembly.
The highest level of content in SwipeGuide is called a Guide.
A Guide generally represents a use-case in your organization, and it comprises of all the work performance support content related to the chosen use-case.
Within a Guide, you can create different types of performance support content:
Instructions, Checklists and Sign-offs.
Instructions
- Instructions are detailed, step-by-step guides that explain how to perform a specific job or task.
- They provide information, context, and guidance to individuals, outlining the necessary steps and procedures.
- Instructions are often used for training, onboarding, and as a reference for employees.
Checklists
Capture performance data with Checklists.
🔗 Learn more about Checklist and how to use it in our help article.
Sign-Off
Use Sign-Off to confirm task completion.
🔗 Learn more about Sign-Off and how to use it in our help article.
Create & Structure content
It might be helpful to imagine the Guide as a folder with all the relevant documentation for an Equipment or a Process. The Guide contains every topic, instruction & sign-off, checklist, and steps detailing how to effectively complete a set of different tasks in a factory or with a certain machine.
Create the high level Guide
1. Choose your Guide title
Note: Keep the end-user in mind and the context in which they will use this Guide by focusing on:
-
- Guide Findability: End-users should easily find this guide when checking all guides on your Platform Workspaces.
-
Choose a representative title for the topic of the guide (e.g. the machinery or the procedure name)
-
Use recognisable terms that are well known to your end-users
- Guide Usability: End-users should easily understand from the title of your guide what they can use it for.
-
Make a clear connection between the title and the procedures described inside
-
Think of the key words used by your end-users when they refer to the procedures you are going to create instructions for
-
2. Choose the language in which you're going to write your Guide
a. What is the default language?
-
The default Language of a guide is the language in which you choose to write your Guide content.
Note: If a language is not available in the list, contact your Customer Success Manager. -
A Guide can be written in 1 language at a time, and it can be translated to multiple languages afterwards. Check the article below to see how to use the translation features.
- Click the Guide Language button on your Guide cover
- Tick any of the option available & click "SAVE"
Note: Only 100% translated language can be selected.
You're now viewing the Guide in a translated language!
3. Choose the Guide Creation Team
When you're creating a new Guide, you have to select the Team in order to determine who will be the colleagues working with you on the guide and to what Workspaces will this Guide be published to later on.
4. Add tags to your Guide
The main reason to use Tags is to make it easy for your end-users to find Guides and Instructions on your Workspace.
When a user searches for a tag, the Guide that has that tag will appear first in the search results.
🔗 Learn more about Tags and how to use it in our help article.
Note: All users in the Platform CMS (Editor) can add existing tags on the Guides and on Instructions. Yet, depending on the settings made on your Platform by your Platform Admin, specific Roles can can create new tags. If you're unable to create new tags, contact your Platform Admin.
Click "SAVE DRAFT" to complete your Guide creation!
🔗 Learn more about Guide versioning in our help article.
Create your Guide content
1. Create Instructions & Checklists titles (e.g. Starting off the Machine A or Checking Cleaning standards)
Think of instructions as tasks part of an entire process. When you choose a process, you want to create instructions for, just breakdown the entire process into smaller tasks and map them all out in the logical order needed in order to meet the goal of the procedure. Each task will then take form of an instruction title.
💡Tip: Each instruction title needs to be clear, to the point and action-oriented:
- Use a verb + subject construction
- Add only the relevant information
- Use continuous tense
2. Create all the steps per Instruction needed to execute each task well
- 🔗 Learn everything about writing effective Instructions here
- 🔗 Learn everything about creating and managing effective media here
3. Map out the additional information needed at each step under Step Notes
🔗 Learn more about how to use Step Notes in our help article.
4. Create Sign-Off & apply them on your instructions
🔗 Learn more about Sign-Off and how to use it in our help article.
5. Create Checklists needed to evaluate a certain product, task or situation
🔗 Learn more about Checklist and how to use it in our help article.
6. Create Topics & bundle Instructions & Checklists that are related to each other under their Topic (e.g. Getting started)
💡Tip: Use drag and drop to grab instructions, topics and steps by the handle and move them anywhere else within the same guide.
On a Step:
On an Instruction:
Note: The changes will only be applied once the Updates are Published.