By Bri Hillmer on Writing docs from October 18, 2016
How good is your search? Does it help your users find what they are looking for?
In a previous post, I raved about the usefulness of using Google Analytics in your software documentation. In this post, I will expand on how awesomely useful setting up Site Search in Google Analytics[1] can be.
Once it is set up Site Search provides you with the terms and phrases users are searching. As the data aggregates over time start by noticing the trends in your data.
Each search term will include several metrics that you can use to evaluate how the search is performing.
For each search term the following metrics are reported:
Results Pageviews/Search, %Search Exits, %Search Refinements, and Average Search Depth are all ideally low.
Results Pageviews/Search is ideally 1; If it is higher than 1, this means that people have to dig to find relevant results.
Higher Search Exit percentages mean that your users are not finding what they need in your search results. In the below screenshot of my Google Analytics, this metric looks terrible. This is because our community (where most users search) has a different domain than our knowledge base so, in my case, a higher percentage isn't necessarily a bad thing.
If %Search Refinements is high, users are having trouble finding what they're looking for.
An Average Search Depth higher than 2 often means people don’t find what they want from the first search.
When it comes to Time after Search, the higher it is the better. Time after Search is ideally long enough to assume that the user consumed the content and got the answer they were looking for.
While the aggregate metrics are great for getting an overall sense of how your search is doing zooming into individual search terms is where the real gold is.
The most frequent searches will be listed first. These will often reflect the names of features within your software. These searches are probably performed by users that know your software pretty well.
The less frequent searches will give you visibility into how your users think and what they are trying to do.
It's a great idea to perform these searches yourself to ensure that the results include the articles you want to return. Examining search results at this level of detail can lead to a number of improvements.
Search terms often help you to better understand how your users' language differs from the language used in your software and documentation. Synonyms, a common search customization, allows you to take the terms that users use and match it up with the terms use in your documentation.
While synonyms are handy, you might still find that you need to re-title an article in order to get users to click on it in the search results. Keep an eye on the search term metrics to see if the addition of the synonym is working. If not, consider re-titling the article to use language that is more natural for your users.
Reviewing search terms often leads to writing new documentation. Users' search terms often highlight functionality that is difficult to find.
For example here are some articles that I have written based on search terms:
Finally, search terms can lead to improvements in the software itself.
While the documentation can help customers find features and functionality that are hard to find, if it is persistent, it's probably best to consider making a change to the software.
For example, "close survey" and other variations of what customers search when trying to figure out how to close a survey have long been a popular search term in our documentation.
When we redesigned the home page recently, I asked the development team make this easier to find!
General posts useful to all documentarians about writing documentation, editing and publishing workflows, and more.
Your flight plan for how to get the most out of KnowledgeOwl features and integrate them into your workflows.
Major KnowledgeOwl company announcements.
Learn how others are using KnowledgeOwl & get pro tips on how to make the most of KO!
Find out more about who we are and what we value.
We believe good support is the foundation of good business. Learn about support tools and methodology.
Learn more about tools to solve various documentarian issues, within and beyond KnowledgeOwl.
Not sure what category you need? Browse all the posts on our blog.
Watch a 5-minute video and schedule time to speak with one of our owls.