Concepts
Steps
A step is an anchor, a title, one sentence, a clip and a completion rule.
Each step teaches one action. Keep it to a single thing the user does.
| Field | Notes |
|---|---|
id | Lowercase, unique in the guide. Used in analytics and with playstep.complete(). |
anchor | The anchor to spotlight. Optional: without one the card shows on its own, at the bottom or in the middle of the screen. |
title | Up to about 40 characters. Verb first: Tap New, Pick a client. |
body | One or two short sentences, up to 280 characters. Say what to do and why. |
clip | Optional. A short clip of the step; see clips. |
complete_on | How the step completes; see completion rules. |
placement | auto (default), top, bottom, left or right of the anchor. |
Text in several languages
title and body take one string per locale. The SDK picks the user's locale, then the guide's default locale, then any available text:
JSON
{ "title": { "en": "Pick a client", "pt-BR": "Escolha um cliente" } }
Missing anchors
If a step's anchor is not on the screen after 3 seconds, the card shows on its own, without a spotlight, so the user can still follow the clip and text. The SDK reports anchor_missing once, and the dashboard flags the anchor as stale. If the anchor appears later, the spotlight moves to it.