Check Content for Findability

Checking Your Content for Findability

Acrolinx can check your content and tell you what keywords a search engine would probably prioritize when indexing your content — these show up as discovered keywords.

You can then see how many of your discovered keywords match up with your target keywords.

To check your content for findability, follow these steps:

  1. Open a document, then open the Acrolinx sidebar if it isn't open already.
  2. Click CHECK to check your content, discover existing keywords and get findability metrics for targeted keywords.
  3. Open the Findability tab Findability tab and review the keywords.

    The Findability tab Findability tab has two sections:

    • discovered-kw-section-icon.png Discovered Keywords

      These are keywords that frequently show up in your content. There are a few metrics we use to build this list, which we'll go into further on in this section.

    • target-kw-section-icon.png Target Keywords

      These are keywords that you want to target for findability. They should include the search keywords that you want your content to match against.

    Review and analyze the keyword information to see how you can optimize your content.

Reviewing Keywords

When you review your discovered and targeted keywords, you can use the findability metrics to help organize and assess your keywords.

Here's a short explanation of those metrics:

findability-icon-frequency.png
FrequencyThe frequency metric is a measurement of the keyword count in relation to the size of the document. It's expressed as a score out of 100.
findability-icon-count.png
CountThe number of times the keyword appeared in your content.
findability-icon-prominence.png
ProminenceThis metric measures the prominent placement of keywords in your content. Prominent placement can be in the document title, headings, or opening paragraph. Acrolinx uses a special formula to give each keyword a prominence score out of 10


Keyword Warnings

Acrolinx also warns you when there's a problem with your findability metrics. For example, when Acrolinx warns you when the prominence scores of your keywords don't match the order of priority. The following illustration explains these warnings in more detail:

1) Yellow prominence warning

The keyword that's above this one has a lower prominence score.

In this example, we need to make the keyword "context definition file" more prominent in the content, or drag it below the keyword "guideline" so that "guideline" has a higher priority.

2) Red prominence warningThe keyword that's two places higher in priority has a lower prominence score than this one.

In this example, we need to make the keyword "context definition file" more prominent in the content, or drag it below the keyword "context" so that "context" has a higher priority.

3) Red count warningThe count is zero, so it looks like this target keyword is completely missing from the content.

In this example, we need to add the keyword "rule" at least once in the content.

An Example Scenario

Earlier on in this article, we discussed how synonyms can increase the findability of your content. We mentioned an example of some terminology that we changed in our product content. Let's take a look at that example in more detail.

Remember that we stopped the terms "rule" as in "style rule." Instead, we say "guideline." But of course we expect most of our customers to enter "rule" as a search term when looking for help on anything related to style or grammar guidelines (formerly "rules"). If we don't include those terms in our content somehow, people will have trouble finding it.

The following illustration shows the discovered and targeted keywords for help article about content-specific guidelines.

Findability Issues

We've highlighted some important keyword metrics in the targeted keywords list.

  • The prominence of our top keyword is 0.

    This is our top keyword but it's not prominent enough in the article. This might be a problem if people are quickly scanning the article to see if it's relevant for their task. We want our top target keyword to be prominent so that people can quickly see exactly what the article is about.

    You can see the prominence warnings for the two keywords underneath it. As we explained in the section on warnings, these prominence warnings indicate that a keyword further up in the list has a low prominence score.

  • The frequency for the keyword "rule" is 0.

    This means that the keyword is completely missing from the content. It's one of our targeted keywords because it's a synonym of "guideline," but we haven't used that word in the article at all

Solutions

To solve the first issue, we have to incorporate the keyword "rule" into the content without confusing the reader with inconsistent terminology. We do this by adding a note about the name change at the top of the page:

From 5.0 onwards, we refer to  rules  and  rule sets  as  guidelines  and  writing guides. 

To solve the second problem, we can change the title and introductory sentence so that they both include our top target keyword.

Title
BEFORE:
Configuring Guidelines So that They Only Apply to Certain Contexts
AFTER:
Configuring Guidelines to Be Context-specific
First Sentence
BEFORE:
You can configure your guidelines so that they only apply in certain contexts.
AFTER:
Context-specific guidelines are guidelines that only apply in certain contexts such as titles or lists.

If we run another check, you can see that the metrics that we initially highlighted have improved.

The frequency and prominence scores for the target keywords "rule" and "context-specific" have gone up, so we've improved the findability for those target keywords.


Try using a similar method for your own content.

  1. Create a comprehensive list of target keywords for your piece of content.
  2. Make sure that the frequency is greater than zero for all target keywords.
  3. Make sure that the prominence scores of your top target keywords match the order in which you've prioritized them.