Enable Rich Snippets

Search queries are traditionally divided into three categories: 

  • Navigational. The user intent is to quickly find the link to a particular discussion, knowledge article, case, or another such document.
  • Informational. Queries through which the user is looking to learn something, which could be a definition of a term or a instructional article.
  • Transactional. Shopping is on the top of the user's mind.

With Enable Rich Snippets, user experience can be improved immensely during informational search queries. Enable Rich Snippets extracts the first <ol> (ordered) or <ul> (unordered) list from the most relevant result in response to most search queries that start with "what" or "how to" and displays the list right on the search results page (Figure 1).

NOTE.

 

A related feature to handle informational queries not beginning with "how to" has been explained in Knowledge Graph.

Enable Rich Snippets

Figure 1. In response to the search query—how to boost a document for specific keywords—Enable Rich Snippets extracts the first steps from Boost Documents for Specific Keywords and presents them on the search results page, enabling users to quickly get an overview of the procedure.

When Enable Rich Snippets Work

Once turned on, the feature will display a rich snippet each time all the following conditions are fulfilled:

  1. Search query is in the form "how to {{something}}".
  2. At least one matching document corresponding to the query is found.
  3. The document has at least one ordered (<ol>) or unordered (<ul>) list.

Best Practices

Here are some best practices for getting the most relevant rich snippets on the search results page.

  • Convey essential information in the first 3-4 bullet points of a list. Bullet point 5 and beyond are not part of rich snippets.
  • Keep each bullet point to a maximum of 80 characters; the characters are be truncated starting from number 81.
  • Avoid using snippets. The lists in snippets are ignored. (MadCap Flare)
  • Cover the main points in the first list, if there are more than one lists on a page. Enable Rich Snippets extracts points from the top list and overlooks others.

Turn On Enable Rich Snippets on a Search Client

Turning on Enable Rich Snippets is easy and it goes a long way in improving user experience.

  1. Go to Search Tuning from main navigation and select a search client where rich snippets will work.

  2. Toggle Enable Rich Snippets to the right to turn it on.

To turn off rich snippets, select a search client and toggle Enable Rich Snippets to the left.

Last updatedFriday, September 25, 2020