Auditable

No notes

A formula that needs explaining should have a one-line note saying its purpose, source or owner.

What MaxCheck detects

A formula line item with empty Notes whose formula needs explaining: 3 or more distinct references, a nested IF, or over 150 characters. Plus one module hint when more than half of a module's formula line items (at least 4) have no notes. Inputs and No Data line items are skipped.

Why it hurts

Notes are the only place in the model to say what a line item is for and where its data comes from. A formula like this one is hard to read without one.

Example

Taken from the rule's own test cases: formulas it must flag, and formulas it must not.

HintFlags this(three references)

Price * Volume - Discount
  • Notes: empty

Fine (has notes)

Price * Volume - Discount
  • Notes: Source: ERP load.

How to fix

Add a one-line note: purpose, source, or owner.

Severity
HintShown in the report. Hints never count toward a score.
Area
Auditable
Runs in
Basic and full check
Rule ID
A_EMPTYNOTES
Version
Rule 2.0.0, rule set 1.4.0

Does your model do this?

Upload the line-items blueprint. This rule runs in the basic check, in your browser, with no email.

Check your model