Before you record
1
Walk the path yourself
Click through the job in the product and write down each control’s visible label, in order.
Guidance follows what is on the page, so a label from an old help article or a menu that
no longer exists sends it looking for something that isn’t there.
2
Check where Guidance can run
Guidance runs only on pages that load the Dubot browser SDK. If the job ends on a page without
it (a shared preview, a third-party checkout, a new tab), end the guide on the last page that
has the SDK and describe the rest in the closing line.
3
Spot controls Guidance can't point at
Guidance points at elements it can see and the customer can click. Plan a text instruction
instead of a pointer for:
- icon-only buttons and tabs with no accessible name (add an
aria-labelin your product to fix this) - controls that only appear on hover
- drag-and-drop steps
- anything inside an iframe
- elements covered by another layer, such as navigation hidden behind a full-screen editor
Write the request
Record the run from the Resource Center with a planned request. Use this shape:- “Let me click it myself” keeps the customer in control of every change and gives you a run you can save.
- Name the stop precisely. “Stop before Publish” is clearer than “don’t change anything”, which can also block the saves the job needs.
- Say what to do when a setting is already right, so the guide doesn’t ask for a pointless click.
- Give dropdowns one instruction (“Choose a property, then User ID”) rather than two steps.
- Don’t ask the customer to hover over something. Guidance can’t see hovers; ask them to click or describe what they see.
- Finish with “Then tell me in one line…”: that line becomes the closing card.
Record the run
Open the start page, ask the Resource Center your request, and do what a customer would: click the highlighted control itself. Watch for:- a highlight in the wrong place or on something you can’t click
- a tooltip that covers the menu you need to use
- steps Guidance performs that you meant the customer to own
Tidy the saved draft
After Save as guide, rewrite each field before you publish. The draft is generated from the run and needs a person’s edit:
Then test the draft with the questions it should answer and two that it shouldn’t. It should start
for the first set only.