Skip to main content

Quality checks

Janis Vavere avatar
Written by Janis Vavere
Updated over a year ago

We use AI to check the quality of items using the INCOSE and/or EARS ruleset.

Quality check statuses

There are 3 statuses for our quality checks, available on the right-hand side of each item in the document view:

  • Yellow warning icon = Improvements found. Click on it to see what rules are broken and which are met.

  • Green checkmark icon = Rules met. No action is needed, all good.

  • Gray N/A = Not applicable. Quality is not checked for that field. For example, when it was purposely disabled.


Moreover, we highlight an item's text with yellow where rules are broken. Hover any highlight to see which rule is not being met.
​


You can also hover over the rules list to see the definition of a given rule.

Quality check settings

You can manually enable or disable quality checks per the whole document. Click the View settings button at the top of the document view and switch the Quality check on or off.

Setting quality check rules per item type

To make it easier for all authors in the company to follow the same set of rules, you can decide what quality rules apply in general at a company level and then at an item type and even attribute level. You can change these settings under:

  • Organization settings -> Quality checks for the general settings

  • Organization settings -> Item types -> Pick an item type -> Attribute

Did this answer your question?