TrainMeUK LogoTrainMeUK

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:

PanelPurpose
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

The editor auto-saves your work every 30 seconds, so you won't lose changes if you navigate away.

Creating a New Guide

1

Navigate to Guides

  1. Log in as an Admin or Manager
  2. Click Guides in the main navigation sidebar
  3. You'll see the Guides listing page with all existing Guides and folders
2

Start a New Guide

  1. Click the New Guide button
  2. Enter a title for your Guide (required)
  3. Optionally add a description explaining the purpose of the Guide
  4. Select a folder to organise the Guide (or leave in the root)
  5. The Guide is created in Draft status
3

Add Steps

Each step represents one action or instruction in your procedure:

  1. Click Add Step to create a new step
  2. Enter a step title (e.g., "Click the Settings menu")
  3. Add a description with detailed instructions
  4. Upload a screenshot to illustrate the step
  5. Repeat for each step in the procedure

Tip

You can reorder steps using the up/down arrows in the step list panel. Steps are automatically renumbered when moved.
4

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
5

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
6

Publish the Guide

  1. Review all steps to ensure they are complete and accurate
  2. Change the status from Draft to Published
  3. The Guide is now visible to users matching the assignment rules

Tip

You can return a Guide to Draft status at any time to make further edits without users seeing incomplete changes.

Supported File Types

TypeFormatsUse Case
ImagesJPG, PNG, WebPScreenshots 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: