For the complete documentation index, see llms.txt. This page is also available as Markdown.

Creating guides

What a guide is, what guides are good for, what teams build them for, how to record one in the Editor, and how to publish and maintain it.

A guide is a sequence of steps that walks someone through a process inside the application they are already working in. Each step highlights one element on the screen, shows a short instruction, and waits for the person to act before moving on. You build a guide by recording the process once, in the application itself, using the Editor.

A step points at one element, such as a button or a field, and shows its instruction in a small panel beside it, the stepbox. A dimmed backdrop covers the rest of the page so stray clicks do not interrupt the process.

Each step finds its element through a selector recorded together with the step, which is how one recording keeps working across sessions and users. The guide teaches the process by having the person do it.

What guides are good for

A help article asks someone to leave the task, search, and translate what they read back into the screen in front of them. A guide runs on that screen. It also holds up better than one-time training, which fades within weeks and is rarely at hand on the day the work has to be done. Where a process has to happen in a set order, a guide holds that order, and can require a field to hold a specific value before it moves on.

That suits four patterns in particular: onboarding into a new system, processes that come around too rarely for anyone to remember the steps, work where a wrong entry is expensive to correct, and feature launches where people need the path on the screen the feature lives on.

A guide running inside an application, with the stepbox beside the highlighted element
A guide running inside the application.

Creating a guide

Recording is the main way to build a guide. The Editor records clicks in the live application and turns each one into a step.

1

Open the Editor and create a guide

In the Editor, click Create to start a new guide.

2

Record your steps

Click through your process. The Editor records a guide step for every action.

3

Generate text

Each step carries a short message that tells the person what to do. To generate instruction text automatically, open the AI tab in the step editing panel and click Generate text. In the window that opens, enter a short description of the guide and, optionally, upload a PDF as source material. Click Generate and the content agent writes the instruction text. The generated text takes the target element into account, and you can edit it afterward.

The Generate text window in the AI tab of the step editing panel
Generating step text from the AI tab.
4

Configure the steps

Each step has settings that control how it behaves. You can refine the selector, change the alignment of the stepbox, and set the advance condition, required value, and skip condition. A step can also hold one image, one video, an external link, or an information box.

Setting
What it controls

Advance condition

The action that moves the guide forward: clicking the target element, pressing a key, or clicking the Next button.

Required value

For a step on a form field, the value the field has to hold before the guide advances.

Skip condition

The page state that makes the guide pass over the step, such as the next step's element already being present.

A step can also advance on its own after a short delay, which suits steps that only confirm something.

5

Preview the guide

Preview runs the guide against the current draft, including steps that have not been saved, and can start from any step. Run it before publishing to confirm the guide works as expected.

Managing and publishing

Publishing makes a guide available to end users. A published guide reaches the people who match its audience and appears on the pages its display rules allow. It is also gated one level up: a published guide inside a chapter that is not published stays invisible. Publish it in every language its audience reads, because a guide with no content in the language a browser asks for does not appear at all. See Languages.

Unpublishing hides a guide from end users. It stays in the Editor, keeps its steps, and keeps the analytics it has already collected, so you can take a guide down during an application change and bring it back afterward.

Duplicating creates a copy with the same steps, targeting, and translations. The copy starts with a fresh analytics baseline, so the original and the copy are tracked separately.

Guides need revisiting after they go live. Content analytics show where people stop partway. Drop-off concentrated on one step usually means that step is broken or unclear. Drop-off spread across many steps usually means the guide is too long.

Troubleshooting

Symptom
Likely cause
What to check

The guide does not appear for end users

Something above it is hiding it

The guide is published, the person matches its audience, the current page matches its display rules, and the chapter holding it is published

The guide is published but still missing in the application

Cached content

Reload the application fully to force a fresh fetch, and confirm the guide is published in the language the browser is asking for

The guide skips ahead to the wrong step

A skip condition is true when it should not be

Whether the next step's element is already present on the page, and whether the current step's element can be found at all

The guide stops after a page change

The step that caused the reload is not marked as such

The reload setting on the step that submits or navigates, and whether the new page is inside the guide's display rules

Relevant articles

Manage selectorsCreate and manage contentCreating validatorsCreating Contextual ActionsGuides: build, maintain, and make them effective

FAQ

What is a guide in Userlane?

A guide is a sequence of steps that walks a user through a process inside an application. Each step highlights one element, shows an instruction, and waits for the user to act before the guide advances.

What is the difference between a step and a slide?

A step points at an element on the page and waits for the user to interact with it. A slide has no target element and shows its message in the middle of the screen, which suits introductions, closing messages, and explanations.

Is a published guide visible to everyone?

No. A published guide reaches only the people who match its audience, on the pages its display rules allow. A guide inside a chapter that is not published stays invisible regardless of its own status.

What happens if the page reloads while a guide is running?

A step that submits a form or navigates has to be marked as causing a reload. When it is, the guide waits for the new page and continues at the next step. When it is not, the guide stops at that point.

Does unpublishing a guide delete its analytics?

No. Unpublishing hides the guide from end users and keeps both the guide and its historical analytics. You can publish the guide again later.

Last updated

Was this helpful?