Map Tool "Guided Mode"

[Lane]

Details

this feature comes out of concern that some users may not be fully understanding how to use the tool. the concern comes primarily from:

• maps being shown / shared with no data selection
• having some users express they did not know to click a specific location for more info

to address this, we are proposing a "guided mode" that hints the user how to complete certain tasks.

Current Status

still in the process of determining how this functions, what the content will be for each step, and how it will look, but so far:

• there seems to be consensus that we should hint for users to take actions (e.g. select an eviction data type, select a location) instead of having the walk through perform those actions for them
• instead of having one large tour of the entire feature set, we should show hints in context as the user progresses through the tool

Next Steps

• determine how is "guided mode" activated (opt-in via welcome popup, turn on automatically, other)? team decision required (@amygroshek @Lane @james-minton @sashasashasasha)
• create a story board outlining all of the steps of guided mode from start to finish (@james-minton do you want to take lead on this? or i can do an initial draft if you like)
• spec full functionality (including any tracking we might do to determine effectiveness)
• wireframe / rough mockup (as described in spec)
• spec and wireframe team review
• prototype implementation
• team / client review
• add translations, make any final revisions
• PR for review
• add to release and launch 🎉

[Lane]

Posting spec here for continuity, currently out for team review.

Guided Mode

• View Prototype

Goals and Success Measures

The goal of this feature is to guide users through parts of the interface where users are having difficulty. The areas that have been identified include:

• Data selection: users have shared links with empty maps or with no eviction data selected
• Location selection: users have communicated that they didn't know to click on the map
• Viewing more details for locations: no specific feedback, but there is suspicion that users may be missing this.

This feature should be considered successful if:

• it leads to an increased % of users making data selections via the dropdowns
• it leads to an increased % of users activating locations via map
• it leads to an increased % of users viewing "more data" below the fold
• the increased % correlates with the number of users that have viewed the relevant walkthrough step

Specification

• guided mode consists of two mini walkthroughs to guide the user through the following tasks:
  • Walkthrough 1: Map data selection
    • Step 1: Eviction data selection
    • Step 2: Census data selection
    • Step 3: Map geography Selection
  • Walkthrough 2: Location selection and details
    • Step 1: Location selection via map
    • Step 2: Exploring detailed data for a location
• guided mode begins immediately with Walkthrough 1 if the following conditions are true:
  • the user has not previously stopped guided mode
  • the user has not previously completed all steps in guided mode
• guided mode can be manually activated by pressing the "?" mark button on the top right
• Each walkthrough has a series of steps. A step consists of the following:
  • a title
  • a text description of the desired action
  • a dismiss ("X") button:
    • hides the step on press, but does not immediately progress to the next step
    • mark this walkthrough as complete if the step is the last step in the walkthrough
  • a previous ("<") button, if this is not the first step in the series:
    • on press it moves back to the previous step in the series
  • a "continue" button if this is not the last step in the series:
    • on press it dismisses the current step in the series and proceeds to the next.
  • a "done" button if this is the last step of the series
    • on press, dismisses the final step and mark the walkthrough as complete
  • a "stop guiding me" button
    • on press it dismisses the step and does not activate any future "guided mode" steps
  • a text progress indicator that shows the current step number and the total number of steps.
• In addition to the above characteristics, each step can be activated or dismissed with the following conditions:
  • Walkthrough 1:
    • Step 1: Eviction Data Selection
      • dismiss this step if one of the following occurs:
        • the user opens the "Eviction Data" select menu
          • progress to Step 2 on selection or menu close
        • the user opens the "Census Data" select menu
          • progress to Step 2 if menu is closed with no selection
          • progress to Step 3 if census data selection is made
        • the user opens the "Map Level" select menu
          • progress to Step 3 if menu is closed with no selection
          • mark "Walkthrough 1" as complete if map level selection is made
    • Step 2: Census Data Selections
      • dismiss this step if one of the following occurs:
        • the user opens the "Census Data" select menu
          • progress to Step 3 when menu closes
        • the user opens the "Map Level" select menu
          • progress to Step 3 if menu is closed with no selection
          • mark "Walkthrough 1" as complete if map level selection is made
    • Step 3: Map Geography Selection
      • dismiss this step if the user opens the "Map Level" select menu
        • mark "Walkthrough 1" as complete
  • Walkthrough 2
    • Step 1: Location Selection
      • activate this step when the user hovers a location on the map and the following conditions are true:
        • there are no other steps currently displayed
        • the user has not explicitly stopped "guided mode"
        • mark "Walkthrough 1" as complete on step activation if it is not already set
      • dismiss this step on location click and progress to Step 2
    • Step 2: Full dataset and charts
      • dismiss this step on "View More Data" click
        • mark "Walkthrough 2" as complete

Analytics

The following analytics should be tracked for this feature:

• when a walkthrough step is activated, the following analytics event should be logged
  • Event Category: Walkthrough
  • Event Action: Step Activated
  • Event Label: {{WalkthroughID}}_{{StepNumber}}
• when the user presses "stop guiding me", the following analytics event should be logged:
  • Event Category: Walkthrough
  • Event Action: Stopped
  • Event Label: {{WalkthroughID}}_{{StepNumber}} (e.g. "walkthrough1_2" = Step 2 of walkthrough1)
• when a walkthrough is marked as complete, the following analytics event should be logged:
  • Event Category: Walkthrough
  • Event Action: Complete
  • Event Label: {{WalkthroughID}}