Mini Content Journey

Who is your target persona?

Web UI user, sysadmin

What stage of the user journey are you targeting?

Try

Why is this content important?

There is a chapter named "Searching and bookmarking" in the Admin guide. The guide is huge and could use a review to make it shorter. "Searching and bookmarking" describes very basic functionality that is quite intuitive for users and doesn't need to be described in detail, which makes it a good candidate as an opportunity to reduce the content included in Admin guide.

Additionally, Web UI is a favorite tool to manage Satellite for a lot of users. Some features are hidden or not well understood. Introducing some of them in the form of a tutorial is a good way to raise awareness.

Related UX customer tickets that support the fact that users are using web UI and keep requesting additional features:

• https://issues.redhat.com/browse/SAT-28935
• https://issues.redhat.com/browse/SAT-28211
• https://issues.redhat.com/browse/SAT-21984

What is the main user goal aka job to be done?

As a user of the Satellite web UI, I want to learn how I can get more efficient at using the web UI.

What high level steps does the user need to take to accomplish the goal?

Access the web UI, explore it.

(Optional) What is the general sentiment of users towards this goal?

(Optional) What pain points are the user likely to encounter when accomplishing this goal?

(Optional) What other feedback do users have around this goal?

(Optional) Are there any additional opportunities you can also implement for the user when documenting this goal?

Address these issues:

• Descriptions of behavior that users can see for themselves (for example: As you start typing a search query, a list of valid options appears.)
• Duplication of the UI interface (for example: available search operators, these are displayed in the web UI)
• Procedures don't follow DITA requirements

Proposed solution:

• Test the web UI and think which features are not obvious.
• Ask around to find out what features people find worth highlighting.
• Delete most of the existing content.

Overall goal: Don't focus on what the web UI can do. Focus on what users can do with it. And trust users to figure out a lot on their own intuitively.

Examples of other docs that explain how to use a web UI through "best practices" and "power user tricks" rather than through feature-based docs:

• https://community.atlassian.com/forums/App-Central-articles/Jira-Keyboard-Shortcuts-A-Comprehensive-List-for-Power-Users/ba-p/2546146
• https://support.google.com/a/users/answer/9896256?hl=en&co=GENIE.Platform%3DAndroid

Links to existing content 

https://docs.redhat.com/en/documentation/red_hat_satellite/latest/html-single/administering_red_hat_satellite/index#Searching_and_Bookmarking_admin

People:

• SME: [SME name]
• QE: [QE name]

Release Note: No

Documentation Outline{}

• Reference:
  • Search query examples
  • Useful keyboard shortcuts (quickly focus search bars) and options (bookmarking)