In-Product Onboarding Revamp Proposal - Checklist Extension

Hi everyone! :waving_hand: :waving_hand:

This is a continuation of Thiago’s onboarding experience revamp proposal (link) with a focus on the in-product aspects.

More specifically, this proposal details what the Checklist Extension mentioned here, should do.

The goal of the Checklist Extension is to let the user explore and learn the main XWiki features and workflows, with practical steps. These steps would become tasks for the user.

The Checklist Extension should:

  • help the end-users of XWiki understand how to use the product

  • offer a different task selection based on the extensions installed

  • be customizable by Admins

The Checklist Application would be placed in the bottom right corner of the screen, where the “Show tour” button currently is. By default, the Checklist Application would be opened, to draw attention to itself, but users would have the ability of collapsing the application.

The Checklist Application would provide all users with a set of default tasks. For example:

  • Create a page
  • Comment on a page
  • Add an annotation to a page
  • Insert an Info macro while editing a page
  • Insert a table of contents while editing a page
  • Insert an image while editing a page
  • Mention a user while editing a page
  • Upload an attachment to a page

Going Further

The task selection would grow based on the installed extensions.

For example, if the Administrator of the wiki installs the Blog Application Extension, users that didn’t yet complete all their Checklist items, would receive a “Create a Blog Post” task.

Configuration

Administrators should be able to create, edit and delete tasks. They should also be able to categorize tasks based on user groups (e.g.: maybe only a certain group of people would be allowed to create blog posts, in that case, only those people should receive that specific task).

Other configuration options should include: disabling the addition of new tasks on extension install.

Here is a similar feature implemented by a competitor, to help visualize how it would look:

Hi @gabrielc, thanks for the proposal!

First, be aware that the initial onboarding discussion do not have a clear consensus regarding adding this kind of task-based onboarding.
So it’s possible that this kind of thing will never be available in XWiki Standard.

+1, if I already know XWiki (or wikis in general) and created an account specifically to edit something, any onboarding will feel like unnecessary intermediate steps.

Meaning that if I completed all tasks at some point, I will not have an tasks-based onboarding when a new extension is installed?

Two additional observations:

  • What would the user interface look like on mobiles and small screens?
  • Possibly not for you to answer but it could be interesting to know if open-source libraries already exist to support us in this development.

That’s what I was thinking. To not make the extension annoying. But I can also see benefits in having the widget reappear once a new extension is installed. Maybe have it configurable by the Admin? I don’t have strong feelings towards one option or the other tbh.

Good question. I think it would be quite hard to make the Checklist widget look well on mobile, and I don’t expect many people would use mobile as their main way of consuming XWiki, so I think the same approach taken by the Tour App could be used - hide it on mobile screens (?).

Looked a bit and found Usertour to be quite interesting. It has everything I proposed and more. But it is licensed under AGPLv3 (would it be compatible with XWiki’s license?) and it seems to be branded unless you pay a licensing fee.

Thanks for the feedback!!

Hey Gabriel, thanks for the proposal!

Configuration by an Admins I think it’s the way to go.

On a first look, it can be really annoying to be presented new steps time and time again as new extensions are installed. However, for some Admins this might be exactly what they want (for some custom extension, for example). To make sure everyone in their company understands some key aspect or something like that.

1 Like