Creating Keywords for Awesome Search Results

Adding keywords to an FAQ is hugely important so that the user gets the best results we can generate. You should add keywords to every FAQ that you create. This document explains how to add effective keywords to your FAQs. Let’s get started ...

When a user searches the FAQs for something like ...

How to cancel my account?

… the normal FAQ search will find our FAQ on that topic because the FAQ has the words “cancel” and “account” in it. But what if the user enters something like these:

Can I delete my account?
Cancel membership
How do I stop my service?
cancel my subscription


While it’s clear that all of these searches should display the FAQ on canceling an account, they don’t. That’s where keywords come in.

In the keyword field at the bottom of the FAQ editor, you can enter additional phrases that should cause the FAQ to match as well. Use commas to separate the phrases:

delete my account, cancel membership, stop my service, cancel my subscription

Keywords should also use multiple words unless you have a highly targeted word like “cancellation” which could really only mean canceling your account. Keywords should be at least two words so you don’t grab FAQs that don’t really match. Take, for example, the keywords

backup, backing up, backed up

Those keywords could match FAQs about backup URLs or about backing up your link data which are two completely different topics.

For an FAQ about Backup URLs, it would be much better to include “URL” in the keywords, along with any pluralized versions:

backup url, backup urls

This brings up another point. Keywords should be used to match what users will commonly type, even if what they type is not grammatically correct, is misspelled, or has spelling variations.

For example, users will commonly type the word “backup” in three different ways: backup, back up, and back-up. To cover all the possible combinations, you can list them all:

backup url, back up url, back-up url, backup urls, back up urls, back-up urls

Users will also use different tenses: backed up, backing up, etc. When you start including those combinations, you can end up with some very long keyword lists!

To make adding keywords much simpler, you can use Perl Compatible Regular Expression (PCRE) “patterns” as keywords. (These will be explained in the next section.)

Just prefix any keyword with pat: and this tells ClickMagick to use a PCRE pattern search for that keyword. This one pattern will match all of those combinations of “backup urls” just listed:

pat:back[-\s]?up urls?

You can freely mix patterns and non-patterns in a keyword list—just separate them with commas.

A great way to look for keywords to add to FAQs is to review the FAQ Search Log of actual entries that users have typed into the FAQ search tool.
 
Note: All keyword searches are case-insensitive. You don’t need to use variants for capitalization.
 


Commonly Used Patterns in Keywords

You don’t need to be an expert at PCRE patterns to create effective keywords provided that you know a few pattern-creation shortcuts.

When creating a pattern for a verb, always consider the optional active tense, past tense, and “-ing” forms. For nouns, always consider the plural form. Hyphenated words come up a lot too… With those examples in mind, here are some “formulas” you can model to build your keyword patterns:

 
Tip: Memorize these patterns and you’ll be a keyword-creating expert!
 
urls?   If a “?” mark follows a single letter it means the letter is optional. This pattern matches url or urls.
 
test(s