Add additional search terms

You can include additional search terms using using the web editor or the desktop editor.

Edit article properties (web app version 4)

Click the edit icon next to the article title

Edit properties

On the right-hand side of the article editor you can edit properties.

Edit article properties (desktop version 4)

You can modify the meta information for the article using the Document Inspector tab.

Additional search terms will improve how your users find your training docs while searching your ScreenSteps knowledge base.

SEO title and SEO description will only affect external search engines like Google. If your knowledge base is marked as Private or isn't being indexed by search engines, then do not worry about SEO titles and descriptions because Google isn't indexing your article.

How additional search terms affect search results

Additional search terms will make it easier for your users find articles in your ScreenSteps knowledge base using alternate search terms. 

For example you might write an article titled "How to insert a widget," but your customers also refer to widgets as gadgets. If they type in "gadget" in the search field they won't get any results. By adding additional search terms you could add the word "gadget" to the article and they would be able to find the article by searching for either "widget" or "gadget".

When you search a ScreenSteps site some parts of an article are given more weight than others. The weight given to each part of an article will affect where in the list of search results an article appears. 

The article title and additional search terms carry the highest weight and articles with the search term in either of these fields will appear higher in the list of search results. The next most significant field is tags followed by article content.

How should I format additional search terms?

You do not have to separate Search Terms by commas or quotes. Just put a space between each word.

Whatever words you enter in the "Search Terms" box will be indexed. If a user enters keywords in the ScreenSteps search field, and any part of the keywords are terms in the "Search Terms" box, then the article will show up as a result.

SEO fields will not be exported to external services such as Zendesk.

There are 3 meta fields available:

  1. Additional Search Terms: Search terms that the ScreenSteps search engine will use when searching your article.
  2. SEO Title: Changes the page title tag for the article. This is the title that will show up in search engines (like Google).
  3. SEO Description: Changes the page meta description tag. If your site is public search engines use this information to provide a preview of the article.

2 Comments

Marcus

SEO is not exported to external services like Zendesk. But if we wanted to export all manuals in bulk, would the SEO information be retained in the output files. (Even if via the Screensteps API)

Trevor DeVore

@marcus - you have access to the SEO information via the API. You can see a sample response for an article at the following url:

http://help.screensteps.com/m/screensteps-api/l/623202-example-requests-and-responses-v2-json-api

Add your comment

E-Mail me when someone replies to this comment