Content Groups

So, What Are Content Groups?

Content Groups let you create logical collections of your content that reflect how you think about your projects. For example, you might want to group all the content published on your blog or all the content from your marketing department. 
You can then view and compare aggregated metrics by Content Group. 
Define your Content Group using a range of criteria, such as, department or language.

Every document can only be in ONE Content Group. If a document matches the criteria of more than one Content Group, Acrolinx includes it in the Content Group that is higher up in the Content Group list. You can change the Content Group positioning according to your needs.

What Can I Use Content Groups For?

It's a way to classify checks into content collections, such as blogs, product marketing texts, or item descriptions for an e-shop. Acrolinx identifies which document belongs to which Content Group by the path and name that is sent by the integration. You can then track Content Groups in Acrolinx Analytics, for example in the Content Quality, Business Value, and Checking Activity dashboards.

How Acrolinx calculates the baseline and records the checks for a Content Group.

The Average Acrolinx Score

Acrolinx calculates the average Acrolinx Score for a month on the last check results. It doesn't matter if the last check was performed in the same month or earlier.

For example, the Content Group SHOP in the chart above shows the average Acrolinx Score in March as 77, these are the values that Acrolinx uses to calculate the score:

  • 80 - The last check of Item 1, performed in February.
  • 85 - The last check of Item 2, performed in March.
  • 65 - The last and only check of Item 3, performed in February.

The Baseline

For each Content Group, you can set a baseline range with a start and end time. The average Acrolinx Score of all checks for that Content Group within that period becomes the baseline. Acrolinx includes only content that was checked after the start time you've set.

In the chart above, you can see that the time period set for the Content Group PRODUCT MARKETING is highlighted purple. Only the Acrolinx Scores within that highlighted area are taken into account for the baseline.

Creating a Content Group

You can create Content Groups in the Analytics Administration section in the dashboard. You define each Content Group by different criteria.

For example, to create a Product Marketing Content Group, you can choose the Product Marketing Writing Guide as the criteria for defining your Content Group. Make sure that the criteria you choose match existing content or content that's going to be created.

To create a Content Group, follow these steps:

  1. Navigate to Analytics  Administration  Content Groups.
  2. Click  to add a Content Group.
  3. Enter a name.
  4. Set a Target Score if you aim for a certain Acrolinx Score for this Content Group. This helps you to compare the achieved Score with your goal.
  5. Choose one or more criteria:
    • User  Role is  a list of Acrolinx user roles.
    • Custom User Information lists the custom user fields that you've defined in the Custom Fields section. For more information on custom fields, see the article Custom User Information and Document Information.
    • Document  Path is a regular expression of a path to a folder on a file system or a web resource.

      Examples of Document PathsRegular Expression
      All documents ending with '.docx'. .*\.docx$
      All documents from a web resource (starting with http: or https: ). ^(http|https):.*
      All web documents from a certain domain (in this example ^(http|https)://www\.acrolinx\.com/.*
      All documents containing a certain sub path. .*/subpath/.*

      Example for a Windows subpath: .*\\Documents\\sampleDocs\\.*

      Example for a POSIX subpath: .*/Documents/sampleDocs/.*

      When you use regular expressions, bear in mind that you need to use the syntax for Java-style regular expressions. If you're not sure if the expression you want to use is valid, you can easily test it with this Java Regular Expression Tester.

    • Custom Document Information  Name is a list of content types you've defined in your custom fields.
    • Guidance  Writing Guide or Checking Profile is a list of all the writing guides and checking profiles you've set up on your Acrolinx server.
    • Guidance > Language is a list of all the languages available to Acrolinx.

    Choose your criteria carefully, since later changes only apply to new checks. If you change your criteria later, you might need to run a batch check on the content in that Content Group.

  6. The Content Group is initially empty - content that matches your criteria is added to the group with the next check. If needed you can run a batch check to include all content at once. You can use the Content Analyzer or the Command Line Checker to run a set of checks.

    The Content Groups that you create aren’t retroactive and only include content that's checked from the creation date forward.

  7. Optional:
    • Check only Content Group content 
      When you've created one or more Content Groups, you can prevent checks on content that doesn't belong to any Content Group. 
      To do so just tick:

      When the check box is ticked, Acrolinx won't perform any checks on content that doesn't match the criteria of a Content Group. Authors will get a message stating why Acrolinx won't perform a check.

    • Set a Baseline
      After you've added some content to a group (by running some checks) you can set a baseline, to analyze the group for a selected time period. To set a baseline for your Content Group follow the steps in the section below.

Setting a Baseline

A Content Group's baseline is the average Acrolinx Score of all the content in a Content Group for the selected period. You can change the time period that you select for your baseline, and calculate a new baseline for that Content Group. Note that you can only set a baseline for content that you've checked already.

To set a baseline, follow these steps:

  1. Select a start date and an end date. Make sure that these dates are somewhere between the creation date of the Content Group and the current date.

    Content Groups only include content that's checked from the day you create the Content Group. We can't calculate the baseline from a time before you added the content to the Content Group.