"Targets" now called "style guides"
To make the language in Acrolinx a little more intuitive, we've renamed Targets to style guides. The feature itself will still work as expected.
When you check with an Acrolinx Integration, you get an Acrolinx Score. The Acrolinx Score is a standardized score out of 100 that reflects the average of all goal scores. The higher the score, the higher the quality of the content.
Content scores help you quantify a document's quality and compare it with other documents. The Acrolinx Score reflects the overall quality of your content with a score between 1 and 100. You also get scores for how well you meet each of your goals such as Spelling and Grammar or Tone. The overall Acrolinx Score is simply an average of the scores for each goal that you've set.
The Acrolinx Scorecard displays the Acrolinx Score and the goal scores with colored bars. These colors show the range of acceptability of the Acrolinx Score and the goal scores respectively. The color coding is as simple as a traffic light, so you can quickly see how you scored.
The scores can have one of three colors:
|
Color |
Description |
Acrolinx Score |
|---|---|---|
|
Green |
Excellent |
Over 79 |
|
Yellow |
Acceptable |
Between 60 and 79 |
|
Red |
Unacceptable |
Under 60 |
You can configure if a goal counts toward the score. This helps writers prioritize issues, and it might be important if you use the Acrolinx Score as a quality gateway.
When you create a style guide, all goals are required by default. You can also set a goal to "Recommended," which means Acrolinx will show guidance for it but it won’t count toward your score.
To set a goal to "Required" or "Recommended," follow these steps:
-
Go to Style > Style guides and click the name of the style guide you'd like to edit.
-
Find the relevant goal, and click the score icon
on the far right to switch betweenRequired and Recommended.
-
Click SAVE.
Example 2. Example
Suppose you want your writers to deliver content that is grammatically correct and has no spelling issues. You aren't as strict about consistency, but some tips for writing consistently might be helpful. In this case, you'd create a style guide with the goals Spelling and Grammar and Consistency, and set Consistency to "recommended." Your writers will see the consistency issues, but these issues won't affect the Acrolinx Score.
The Acrolinx Score is the average of all the goal scores rounded to the nearest whole number. For example, suppose that you check a document, open your Scorecard, and see the following scores:
|
Goal |
Score |
|---|---|
|
Terminology |
59 |
|
Spelling and Grammar |
71 |
|
Consistency |
33 |
|
Clarity |
75 |
|
Tone |
77 |
If you take the average of all the goal scores and round it to the nearest whole number, you get a final Acrolinx Score of 63.
Acrolinx calculates each individual goal score with the following formula:
Normalized document length / (Normalized document length + issue count)
This formula has the following variables:
-
Document length
The number of words in the document.
-
Normalized document length
A factor that determines the degree to which an issue impacts the score.
-
Issue count
The number of issues that Acrolinx found in the goal.