Creating Guides
How to create step-by-step Guides with screenshots using the web editor
The Guide Editor
The Guide editor uses a three-panel layout to help you build Guides efficiently:
| Panel | Purpose |
|---|---|
| Step List (left) | Overview of all steps with reordering controls |
| Step Editor (centre) | Edit the selected step's title, description, and screenshot |
| Properties (right) | Configure Guide settings, folder, and assignment rules |
Tip
Creating a New Guide
Navigate to Guides
- Log in as an Admin or Manager
- Click Guides in the main navigation sidebar
- You'll see the Guides listing page with all existing Guides and folders
Start a New Guide
- Click the New Guide button
- Enter a title for your Guide (required)
- Optionally add a description explaining the purpose of the Guide
- Select a folder to organise the Guide (or leave in the root)
- The Guide is created in Draft status
Add Steps
Each step represents one action or instruction in your procedure:
- Click Add Step to create a new step
- Enter a step title (e.g., "Click the Settings menu")
- Add a description with detailed instructions
- Upload a screenshot to illustrate the step
- Repeat for each step in the procedure
Tip
Edit Screenshots
After uploading a screenshot, you can use the built-in image editor to:
- Highlight - Draw a coloured box around an important area to draw attention to it
- Blur - Blur out sensitive information like personal data, passwords, or confidential content
- Crop - Trim the screenshot to show only the relevant portion of the screen
Configure Properties
In the properties panel, you can set:
- Folder - Move the Guide to a different folder
- Assignment Rules - Control who can see this Guide (by department, job role, location, or group)
- Review Cycle - Set how often the Guide should be reviewed
Publish the Guide
- Review all steps to ensure they are complete and accurate
- Change the status from Draft to Published
- The Guide is now visible to users matching the assignment rules
Tip
Supported File Types
| Type | Formats | Use Case |
|---|---|---|
| Images | JPG, PNG, WebP | Screenshots of screens or documents |
Tips for Effective Guides
Keep Steps Focused
Each step should describe one action. If a step requires multiple clicks, consider splitting it into separate steps for clarity.
Use Clear Titles
Step titles should be action-oriented, such as "Click the Submit button" or "Enter the customer reference number".
Highlight Key Areas
Use the highlight tool to draw attention to the specific button, field, or area the user should interact with. This prevents confusion when looking at busy screens.
Blur Sensitive Data
Always blur personal data, passwords, or confidential information in screenshots before publishing a Guide.
Next Steps
Want to create Guides even faster? Try the Chrome Extension:
- Chrome Extension Setup - Install Guide Recorder from the Chrome Web Store
- Recording with the Chrome Extension - Auto-generate Guides from screen recordings
- Managing Guides - Organise and assign your Guides