Guides
Guide overview
Use Guides to present accessible steps, collect answers, and record completion.
Guides are interactive, step-by-step experiences. Use them to present instructions, collect answers, and record what happened during a completed run.
Understand the Guide structure
Every Guide uses the same four levels:
- A Guide is the complete experience stored in a Library folder.
- A Sequence is an ordered flow within the Guide. One sequence is the starting point.
- A Page is one screen within a sequence.
- A Block presents content or interaction on a page. Text and Media blocks share information; Field blocks collect answers.
Authors can create more than one sequence and use navigation rules to send a player along different paths. A simple Guide can move through one sequence in page order.
Create and test a Guide
- Open Library and enter the folder where the Guide should be stored.
- Open Create, choose New Guide, and enter a name. Add an optional description, or turn on Use template to start from a saved template.
- Select Create guide. CareMap opens the focused Guide editor.
- Use the Guide, Sequence, and Page menus to add and organize the structure, then add blocks to each page.
- Review Warnings and use Preview current page or Preview current sequence to test without creating a Reports inbox record.
- Choose Play guide when you are ready to complete a normal run.
CareMap does not give Guides a separate draft or published state. Empty pages can remain while you build, but warnings may identify incomplete or unavailable paths before play or scheduling.
Editing, saving, and access
You need edit access to the Guide's folder, a writable workspace, and the ability to create and edit content to author a Guide. People with view-only access can use the actions available to them, such as View details or Play, but Edit is hidden or blocked.
The editor saves changes as you work. A Saving or Save failed status appears when attention is needed. CareMap also tries to save current inline text before play or scheduling. If saving fails, keep the editor open and use Retry save. Review a conflict before choosing Reload latest, because reloading can discard the affected local draft.
During a normal play session, CareMap records progress and saved answers. When the player reaches natural completion, CareMap captures a session Report after pending changes sync. Preview sessions remain separate and do not create a Reports inbox record.
Fix common problems
- New Guide or Edit is unavailable: Check that the selected workspace is writable and that you have edit access to the current folder.
- Play or Schedule asks for review: Open Warnings, correct blocking paths or unavailable content, and try the action again.
- A Guide is missing: Confirm the selected Library source and folder. A shared Guide appears only while you still have access to its folder.
- Changes will not save: Keep the editor open, check the connection, and retry. If CareMap reports a conflict, review the choices before reloading.