> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/product/features/help/quick-tour.md).

# Quick tour

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/product/features/quick-tour.md).
{% endhint %}

**Snaptips** are the app's built-in guided tours. The **quick tour** points at the main menu items or tabs, one card at a time, and says what each one is for. On the web it runs over the side menu and shows up to ten steps, chosen by the user's role and whether a **multi-site** is selected. The apps have one six-card tour for everyone, and new accounts get a short welcome tour. The tours run on the device and make no calls to the server. They exist so that new and returning users find their way around. Feature announcements are a separate feature, [Marketing popups](https://docs.snapfix.com/product/features/notifications/marketing-popups.md).

## Rules

### Starting a tour

* Every signed-in user can open the Snaptips ([Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md)).
* **Web:** the side menu's "HelpHub" > "Take A Quick Tour" opens the "NEW!" dialog ("NEW! - Multi-site", with its own text, while a multi-site is selected). "Explore now!" starts the tour; "Show me later" and the close button close the dialog, and nothing is stored. A click outside the dialog or the Escape key does not close it ([Web dialog](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#web-dialog)).
* **Web sign-up:** a new web account also gets the dialog, 1.5 seconds after it is made, as the app opens `/fix` ([Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md)).
* **iOS:** Help Hub > "Snaptips" shows one card, "Getting Started Quick Tour". The card switches to the Fix tab's group list and shows a "QUICK TOUR" start card with "Start" and a close button ([Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#ios-start-card)).
* **Android:** Help Hub > "Snaptips" shows one card, "GETTING STARTED QUICK TOUR". The card opens the group list with the "QUICK TOUR" dialog, with "Start" and a close button. Closing it records the tips as shown. The dialog's "Show me later" link is hidden, and the 24-hour time its handler would store is never read \[[ASK-193](https://github.com/snapfix/docs/blob/main/ASK.md#ask-193-should-androids-snaptips-dialog-offer-show-me-later)] ([Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#android-quick-tour-dialog)).

### The web tour

* The tour has up to ten steps, numbered 2 to 11 in the code. Each card sits at the side-menu item it describes ([Web tour steps](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#web-tour-steps)).
* Steps 2 to 4 ("FIX!", "PLAN!", "ASSETS!"), 7 ("DASHBOARD & REPORTS!") and 11 ("TAKE A QUICK TOUR!") show to everyone. The others depend on the user ([Web tour steps](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#web-tour-steps)):
  * step 5, "COMPLY!": role "Admin";
  * step 6, "CHAT!": no multi-site selected, and chat on for the site;
  * step 8, "SITE CONSOLE!": no multi-site selected, and role "Admin" or a group admin;
  * step 9, "MULTI-SITE CONSOLE!": a multi-site selected;
  * step 10, "SITE REPORTS!" or "MULTI-SITE REPORTS!": a multi-site selected, or role "Admin".
* Several steps change their text while a multi-site is selected ([Web tour steps](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#web-tour-steps)).
* "NEXT" moves to the next step the user gets; "DONE" on the last card, or the close button, ends the tour. There is no back button. The next start begins at the first step again ([Actions](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#actions)).
* On a site with chat off, the step 8 card is blank: only the progress bar and the close button show, so an Admin can only close the tour.

### The app tours

* "Start" begins a six-card tour, the same on iOS and Android and for every user: the profile button ("HELP & PROFILE"), the four tabs ("SNAP!", "FIX!", "CHAT!", "PLAN!") and the plus button ("CREATE"). Every card but the first has a back button; "Done" on the last card ends the tour ([App tour cards](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#app-tour-cards)).
* **Welcome tour:** after a new account is made, the group list opens a welcome popup (iOS) or sheet (Android). iOS shows it after every registration in the app. Android shows it while its "invited user" flag is set, and the Android sign-up screen sets that flag for every new account. "Take a Quick Tour" starts a two-card tour, "SNAP" and "FIX"; "Start Snapfixing" closes it with no tour \[[ASK-194](https://github.com/snapfix/docs/blob/main/ASK.md#ask-194-who-should-get-the-quick-tour-after-signing-up-and-should-the-tours-match)] ([Welcome tour](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#welcome-tour-ios-and-android)).
* After the two welcome cards, a "Done!" popup or sheet offers "Learn More", which opens the [Help Hub](https://docs.snapfix.com/product/features/help/help-hub.md) (on Android its second copy \[[ASK-190](https://github.com/snapfix/docs/blob/main/ASK.md#ask-190-which-android-help-hub-should-stay-my-profiles-tab-or-the-separate-screen)]), and "Start Snapfixing", which closes it.
* Both apps log the welcome cards' "Next" taps under the wrong event names. Only analytics are affected.
* Android also has an account-switcher tip, a bottom-bar tip and a method that would open the "QUICK TOUR" dialog by itself; nothing calls them, so they never show ([Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#tips-that-never-show-android)).

### Data

* The tours use no server data and change none. The steps and texts are in the apps and the web ([Help API](https://docs.snapfix.com/engineering-reference/api/help.md)).

## Flow

```mermaid
flowchart TD
  webmenu["Web: side menu HelpHub, Take A Quick Tour"] --> dialog["NEW! dialog"]
  signup["Web: new sign-up"] --> dialog
  dialog -- "Explore now!" --> webtour["Up to ten steps, by role and site type"]
  dialog -- "Show me later or close" --> closed["Dialog closes"]
  hub["iOS or Android: Help Hub, Snaptips card"] --> start["QUICK TOUR start card or dialog"]
  start -- "Start" --> cards["Six cards: profile, four tabs, create"]
  newacc["iOS or Android: new account"] --> welcome["Welcome popup or sheet"]
  welcome -- "Take a Quick Tour" --> two["SNAP and FIX cards"]
  two --> done["Done! popup or sheet"]
  done -- "Learn More" --> helphub["Help Hub"]
```

## Platforms

| Capability      | Web                                            | iOS                                         | Android                                                                                                                           |
| --------------- | ---------------------------------------------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| Where it starts | Side menu "HelpHub" > "Take A Quick Tour"      | Help Hub > "Snaptips" > card                | Help Hub > "Snaptips" > card                                                                                                      |
| First screen    | "NEW!" dialog                                  | "QUICK TOUR" start card over the group list | "QUICK TOUR" dialog over the group list                                                                                           |
| Steps           | Up to ten, by role, chat setting and site type | Six                                         | Six                                                                                                                               |
| Back button     | No                                             | Yes, except on the first card               | Yes, except on the first card                                                                                                     |
| "Show me later" | Closes the dialog                              | None                                        | Hidden \[[ASK-193](https://github.com/snapfix/docs/blob/main/ASK.md#ask-193-should-androids-snaptips-dialog-offer-show-me-later)] |
| Opens by itself | The dialog, after a web sign-up                | The welcome popup, after a registration     | The welcome sheet, after a sign-up                                                                                                |
| Server calls    | None                                           | None                                        | None                                                                                                                              |

## Screens

* [Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md): the web dialog and tour, the app cards and the welcome tours.
* [Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md): where the app tours start, and where "Learn More" leads.

## API and data

None. The tours make no calls and store nothing on the server ([Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#states)).

## Depends on

* [Help Hub](https://docs.snapfix.com/product/features/help/help-hub.md): the Snaptips row in the apps, and the web's "HelpHub" side-menu item.
* [Sign-in](https://docs.snapfix.com/product/features/account/sign-in.md): the web sign-up and the app registrations that start the dialog or the welcome tour.
* [Site users](https://docs.snapfix.com/product/features/console/site-users.md) and [Group members](https://docs.snapfix.com/product/features/groups/group-members.md): the "Admin" role and group-admin status decide which web steps show.
* [Chat](https://docs.snapfix.com/product/features/chat/chat.md): the site's chat switch decides web step 6, and step 8's card.
* [Switching sites](https://docs.snapfix.com/product/features/groups/site-switching.md) and [Multi-Site Console](https://docs.snapfix.com/product/features/console/multi-site-console.md): a selected multi-site changes the web steps.
* The features the steps point at: [Task lists](https://docs.snapfix.com/product/features/tasks/task-lists.md), [Planned tasks](https://docs.snapfix.com/product/features/planner/planned-tasks.md), [Asset registers](https://docs.snapfix.com/product/features/assets/asset-registers.md), [Comply](https://docs.snapfix.com/product/features/compliance/comply.md), [Dashboard](https://docs.snapfix.com/product/features/reports/dashboard.md), [Site details](https://docs.snapfix.com/product/features/console/site-details.md) and [Site reports](https://docs.snapfix.com/product/features/reports/site-reports.md).
* [Marketing popups](https://docs.snapfix.com/product/features/notifications/marketing-popups.md): feature announcements, a separate feature.

## Edge cases

* **Chat off on the web:** step 6 is left out and step 8's card is blank.
* **Multi-site selected on the web:** steps 6 and 8 are left out, steps 9 and 10 show, and the dialog and several steps use their multi-site text.
* **Member who is not an admin:** steps 5, 8 and the single-site step 10 do not show on the web. The app tours are the same for everyone.
* **Offline:** the tours work without a connection.
* **Android's second Help Hub screen:** its Snaptips card text is written in English in the code.
* **Time zones, integrations and deleted items:** none.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/product/features/help/quick-tour.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
