Change 607898 had a related patch set uploaded (by Dbarratt; owner: Dbarratt):
[mediawiki/extensions/CheckUser@master] Create guided tour for Special:investigate

https://gerrit.wikimedia.org/r/607898

@Prtksxna What should trigger the guided tour? Should we add a button? or should it be triggered on page load?

In T255644#6260778, @dbarratt wrote:

@Prtksxna What should trigger the guided tour? Should we add a button? or should it be triggered on page load?

It should start automatically on the page load, but we should trigger it just once. If someone dismisses it or finishes the entire tour we don't show it again. (related T256586)

To get the tour back after closing it, you can use something like this in your console:
Initial Tour:

new mw.Api().saveOption( 'checkuser-investigate-form-tour-seen', null );

Investigate Tour:

new mw.Api().saveOption( 'checkuser-investigate-tour-seen', null );

which will reset your user preference to the default value.

or even batter, as a single command:

new mw.Api().saveOptions( { 'checkuser-investigate-tour-seen': null, 'checkuser-investigate-form-tour-seen': null } );

@Prtksxna I have a couple of questions about this, from T252984;

Checking multiple users and IPs? (attached to the Multiselect widget on the main form)
Add up to N User names and IPs and get all the information at one place. Don’t worry, we’ll create a separate CheckUser log for each of them.

• Should N be replaced by the actual limit?
• "at one place" sounds odd to me - I'd expect "in one place". It might just be a US English thing though. @aezell Do you have any thoughts?

I also thought it should be "User names or IPs" (instead of and). I also wonder if it is "Usernames" or "User names" ?

@Tchanders @dbarratt, your suggestions make sense! Yes we should replace N by the actual limit:

Add up to N (to be replaced by the real limit) Usernames or IPs and get all the information in one place. Don’t worry, we’ll create a separate CheckUser log for each of them.

I've updated T252984 too.

@Niharika @jwang Note that we also get event logging for the tour usage:

• https://www.mediawiki.org/wiki/Extension:GuidedTour/Write_an_extension_tour#Implementation
• https://meta.wikimedia.org/wiki/Schema:GuidedTour

Change 607898 merged by jenkins-bot:
[mediawiki/extensions/CheckUser@master] Create guided tour for Special:Investigate

https://gerrit.wikimedia.org/r/607898

@Prtksxna @Niharika @dbarratt

For "Matching User Agents?", I find only one cell is highlighted, even if there are other matching rows.

How "robust" do we want the tour to be if users interact with other parts of the page during the tour?

For example, if you pin a cell the tool menu won't show in "Need more context?" and "Narrowing your investigation?":

If you reorder the table while a cell is highlighted, you can be left with a cell permanently highlighted (until you refresh the page): e.g.
Start:

If you click "Block" before you get to the "Want to block?" step, the popup is not in its usual place:

There are at least a few other similar things (all fairly minor).

Might we want to grey the background of the page to prevent users interacting with anything but the guided tour (like we do, for example, in The Wikipedia Adventure (click "Start the Adventure")). Or will that undermine the point of the guided tour?

Moving this to design review so that @Prtksxna can summarize the changes we should make re @dom_walden's findings. Thanks everyone for discussing this!

Based on how much time this would take, I suggest two approaches:

Add Overlay

The overlay solves most (if not all) of the problems and is a config in GuidedTours so should be easy to add. On the other hand not being able to interact with the UI can be frustrating. There is a higher chance that the user would dismiss the entire tour just so that they can interact with the tool.

Make adjustments to when and how the tour shows up

This is in the direction of what @dom_walden was asking:

How "robust" do we want the tour to be if users interact with other parts of the page during the tour?

Looking at some of the issues from above:

For example, if you pin a cell the tool menu won’t show in “Need more context?” and “Narrowing your investigation?“

The popup should only show up when the UI element is there. Or force the UI element to be visible so that people are able to make that association.

If you reorder the table while a cell is highlighted, you can be left with a cell permanently highlighted (until you refresh the page)

This can be ignored in my opinion. It is a one time issue that occurs in a specific case. Once the tour is done it can never happen again.

If you click “Block” before you get to the “Want to block?” step, the popup is not in its usual place:

The popup should only show up if its in the order, otherwise it should remain hidden. And if it is in order, it should show up in the right place.

During estimation we decided to go with the overlay T258616: CU 2.0: Add an overlay to the GuidedTour
We'll also be adding a restart tour link on the Special:Investigate page T256586: Special:Investigate: Onboarding: Restart tour and help links