We're delighted that you've chosen to get started with our Beta Version of Scroll Content Quality for Confluence Cloud. This article gives you a tour of the app's key functionality. You'll learn how to:
Allow access — Give Scroll Content Quality access to enable Scroll Content Quality to view and edit your space.
Activate Scroll Content Quality — Enable Scroll Content Quality in one of your Confluence spaces.
Customize rules — Edit rules or create entirely new ones that fit your personal use case.
Check page content — Check written page content for quality issues right after publishing.
Read report and fix issues — Get a closer look at quality issues the app identifies and fix them right away in your editor.
1: Allow access
Activating Scroll Content Quality in one of your Confluence spaces you can do in a matter of seconds. To start, navigate to the space in which you want to enable a quality check and choose Scroll Content Quality in your sidebar.
When doing so for the first time, Confluence will ask you to give Scroll Quality Content access to your Atlassian account. Click Allow Access and Accept the permissions in the newly opened “Authorize app” browser window.
2: Activate Scroll Content Quality in a Space
After allowing access, click the Activate quality check button to activate Scroll Content Quality in your Space.
Space admin permissions are required to activate Scroll Content Quality in your space.
At the moment Scroll Quality Checker can’t be activated in personal spaces.
Once activated, a check function in form of a byline icon will be usable on every page in your space. This check can be seen and used by any users with viewing permissions.
3: Customize Rules
After activating Scroll Content Quality and allowing access, the app offers a predefined set of rules that is built around general requirements for content quality in technical documentation.
Use the Configure rules button to customize these rules or to create entirely new ones that fit your personal use case. To learn more about configuring rules and which syntax to use, see Configure Rules.
Once you’ve customized the ruleset to your liking, click the Save button to apply the rules throughout your space. Now it's time for you and your team to start checking your pages for quality issues based on these rules.
4: Check Written Content
If a page is part of a space that has activated Scroll Content Quality, you’ll notice a content byline icon under the page title that enables you to check your written content.
Byline icon states
This byline icon shows two different states:
If the page has not been published since activation of the app or since a rule change has been saved, the byline icon will read “Page not yet checked”. Click the byline icon and confirm Check page to switch to the active state. Doing so will also open the page report in a new dialog.
After publishing a page or manually activating the check by using the byline icon, the number of identified quality issues will be stated on the page. Quality issues can also be described as rule breaks or content that doesn’t align with your defined set of rules.
The colored circle that appears next to the issue count is defined by the the highest level of severity for all quality issues on the page. For more details and to check issue severity, click on the byline icon to open the page report in a new dialog.
5: Read Report and Fix Issues
The page report offers more details about the quality issues found by the Scroll Content Quality check. Together with the page editor, this dialog can be used to find and fix all quality issues on the page.
For an optimal workflow, open the page editor in a new tab next to your page report. By using Confluence’s built-in Find and Replace function (Cmd+F) you can fix multiple elements at once.
Rule report structure
In the report, all quality issues are grouped by the defined rules in the rule editor and are sorted by their level of severity. Depending on your rule settings, each rule is presented with slight differences, but all of them share the same basic structure:
Level of severity
Shown as a colored label for each rule.
There are three levels of severity:
🔴 Critical: Critical or technical quality issue. Fix is required.
🟠 Major: The quality issue will most likely alter the page's content quality. Fix is highly recommended.
🔵 Minor: The quality issue depends on the use case. Fix is optional.
Shown as the title for each rule.
Defines the overall intention of the rule.
Left side of the table lists all quality issues identified as a part of the rule.
References the affected element that is causing the quality issue.
Quality issue description and/or solution
Right side of the table lists all quality issues identified as a part of the rule.
Defines the quality issue or offers a fix that should be used instead.
That's it! You now know how to activate Scroll Content Quality in a space, create and customize rules, and enable you team to find and fix quality issues in their Confluence content.
This concludes the overview of key functionality. To get a more detailed idea about Scroll Content Quality's feature set, we recommend learning more about how to customize rules, see Configure Rules.