Guide Health – Find out and fix issues on your guides
The “Guide Health” section in the OGL console helps developers monitor issues with the content they are creating. It provides developers with details about problems in their guides, labeled as “Guide errors,” along with recommendations for resolving them.
What is new with Guide health?
Currently, the Guide Health section offers an “Edit Guide” option for each error, redirecting users to the guide’s flow editor with a message explaining how to resolve the issue. Alternatively, the button is disabled for errors that cannot be fixed within the flow editor. We recognized opportunities to further improve the user experience. For instance, there are cases where users need to address guide errors in areas of the console outside the flow editor. This is the area we focused on and improved within the Guide Health modal.
Edit Guide Fix Guide
The “Edit Guide” button for guide errors has been renamed “Fix Guide.” As the name suggests, instead of being redirected to the flow editor to “edit” the guide, users will now be directed to the relevant area in the console to “fix” the guide. Additionally, users will be assisted by an OGL guide throughout the task.
Example User flow:
Consider the guide error where you have added a role in an activation condition on a guide which does not have an assigned value. The user flow would look something like below:
- Open Guide health modal from the heart button on the top right corner of the console.
- The Guide health modal opens up displaying the guide error. Click on the “Fix Guide” button to go ahead and fix the issue.
- Clicking on Fix guide button redirects you to the required location to fix the error which in this case, is the Activation conditions modal. There is also an OGL guide up and running to provide instructions on how to fix the error.
- The guide instructs the user to assign values to the undefined roles or delete the condition. The user would like to assign a value to the role and clicks on the pointed link. This redirects them to the required location i.e. the Custom Roles modal.
- Notice how the guide continues to this place as well, instructing the user on what must be done.
- The user now adds a value to the role and clicks on save.
- The error is now fixed!
Similar experience has been designed for each of the guide error to assist the users in resolving the error in its own unique way.
Commentary on future direction
The future looks bright and exciting for the Guide Health feature, as it is only the first step toward our goal of “Unbreakable Guides.” The idea is to provide an uninterrupted experience for users while using OGL by offering alternative ways to assist them in completing their tasks, even if a guide breaks. Guide Health will play a key role in identifying guide breaks and notifying developers about them for faster fixes.