Quick help

Quick help is a short guided tour. Instead of describing where something is, it shows you: a card at the edge of the screen explains each step, while a large pointer moves to the right button and clicks it, and Sapilon goes where that button goes.

When you see one

• The first time you open Sapilon, a tour offers to show you the main places: the Agent, the Preview, the Explorer and the Plan. Start plays it; Not now puts it away.
• When a feature ships, you may get a notification about it with Show me. It plays the tour on the page you’re on.

A tour you’ve finished or turned down doesn’t come back by itself, on this device or any other.

Moving through a tour

• Next goes to the next step, Back to the one before, and Skip tour stops where you are. Nothing you were doing is changed: a tour only moves around and opens things, it never saves, sends or deletes anything.
• With a keyboard: → or Enter for next, ← for back, Esc to stop.
• The click sound can be turned off with the speaker button on the card. The choice is remembered on that device.
• With Reduce motion turned on in your system settings, the pointer appears at each button instead of gliding to it.

Playing one again

• In a project: Help → Get help → Quick help lists every tour, with Play.
• On the projects list: Take the tour in your account menu.

On a phone you get the phone version of a tour, which goes the way you’d go on a phone (the menu button first, for example). A few tours are for a computer only and say so.

Tours in your own app

Your app can show its own users around the same way. Ask the agent for it, for example: “Add a first-run tour that shows new people the Orders and Reports pages, on a computer and on a phone.” It writes the tour, points it at the right buttons, and adds a test that fails if a later change removes one of them.

• A first-run tour plays once for people who join after it ships.
• A feature tour can be offered in the notification area to people who were already using the app, or played from a link or a help page.
• While you work on the Build Server preview, open a page with ?tour=none to keep tours from starting by themselves, or ?tour=<name> to play one.