Skip to content

[SC-17782] Document the Rules tier calculation method - #1552

Open
juanmleng wants to merge 1 commit into
mainfrom
juan/sc-17782-rule-based-tier-assignment
Open

juanmleng wants to merge 1 commit into
mainfrom
juan/sc-17782-rule-based-tier-assignment

Conversation

@juanmleng

@juanmleng juanmleng commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

Pull Request Description

What and why?

Merge only after ValidMind/backend#3535 and ValidMind/frontend#2843 have merged — this documents a feature that has not shipped yet.

Risk tier templates gain a third calculation method, Rules, where an ordered list of rules assigns the tier: the first rule that matches wins, and a default tier applies when none do. A rule's conditions can compare an inventory field or count the components scored at chosen levels, so a methodology that escalates on how many severe answers there are and where — and decision-tree or knock-out methodologies in general — can be expressed directly. The risk tiering guides only described Scorecard and Risk Matrix.

This adds a Set up a Rules template section to Configure risk tier calculation, with a tip on expressing a decision tree as rules and Rules items in the publish checklist. Manage risk tier assessments now covers the read-only Tier Assignment Rules section, the Why list under Calculated Tier, and that a tier is not calculated — and publishing is unavailable — until required inputs are complete. The method lists in Working with risk tiering and Manage risk tier templates include Rules.

How to test

Automated tests

From the repository root, render each changed page:

skills/validmind-docs-coverage/scripts/render-pages.sh \
  guide/risk-tiering/configure-risk-tier-calculation.qmd \
  guide/risk-tiering/manage-risk-tier-assessments.qmd \
  guide/risk-tiering/manage-risk-tier-templates.qmd \
  guide/risk-tiering/working-with-risk-tiering.qmd
git diff --check

Expected: all four pages render. The only warning, Unable to resolve link target: validmind/validmind.qmd, comes from site navigation and appears on unchanged pages too.

Manual testing

  1. Open site/_site/guide/risk-tiering/configure-risk-tier-calculation.html and check the new Set up a Rules template section, its links to the Scorecard steps and to Supported field types and operators, and the Rules only checklist.
  2. Open site/_site/guide/risk-tiering/manage-risk-tier-assessments.html and check Tier Assignment Rules, Calculated Tier and Publish an assessment.

Preview of each changed page:

What needs special review?

  • The feature has not shipped yet; this PR should merge only after ValidMind/backend#3535 and ValidMind/frontend#2843.
  • Publish an assessment now states that publishing needs complete inputs. That applies to every calculation method, not only Rules.

Dependencies, breaking changes, and deployment notes

Documents ValidMind/backend#3535 and ValidMind/frontend#2843; merge after both. No breaking changes.

Release notes

Risk tier templates have a new Rules calculation method, suited to decision-tree and knock-out methodologies. Define an ordered list of rules — for example, "more than 4 critical answers, or a critical answer in Consumer Impact and in Fairness" — and the first rule that matches sets the tier, with a default when none do. Each assessment shows which rule set the tier and why. Learn more about Rules templates

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

Add a Rules setup section to the calculation guide, with a tip on
expressing a decision tree as rules and Rules publish requirements.
Cover the Tier Assignment Rules section, the Why list and incomplete
inputs on the assessment page, and list Rules among the methods.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@juanmleng juanmleng added the documentation Improvements or additions to documentation label Oct 6, 2026
@juanmleng juanmleng self-assigned this Oct 6, 2026
@juanmleng
juanmleng marked this pull request as ready for review October 6, 2026 09:25
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Lighthouse check results

✓ INFO: Average accessibility score is 0.93 (required: ≥0.9) — View the workflow run

Audit mode: changed pages (4 URL(s))

Show Lighthouse scores

Commit SHA: 8e09e5e

For a thorough audit, run the Lighthouse check workflow manually (Actions → Lighthouse check → Run workflow) with depth 0–2, or add the lighthouse:full label for depth 2 on the next validate run.

Page Accessibility Performance Best Practices SEO
/guide/risk-tiering/configure-risk-tier-calculation.html 0.93 0.77 1.00 0.82
/guide/risk-tiering/configure-risk-tier-calculation.html 0.93 0.82 1.00 0.82
/guide/risk-tiering/manage-risk-tier-assessments.html 0.93 0.78 1.00 0.82
/guide/risk-tiering/manage-risk-tier-assessments.html 0.93 0.78 1.00 0.82
/guide/risk-tiering/manage-risk-tier-templates.html 0.93 0.78 1.00 0.82
/guide/risk-tiering/manage-risk-tier-templates.html 0.93 0.77 1.00 0.82
/guide/risk-tiering/working-with-risk-tiering.html 0.92 0.75 1.00 0.82
/guide/risk-tiering/working-with-risk-tiering.html 0.92 0.79 1.00 0.82
/guide/risk-tiering/configure-risk-tier-calculation.html 0.93 0.77 1.00 0.82
/guide/risk-tiering/manage-risk-tier-assessments.html 0.93 0.77 1.00 0.82
/guide/risk-tiering/manage-risk-tier-templates.html 0.93 0.77 1.00 0.82
/guide/risk-tiering/working-with-risk-tiering.html 0.92 0.78 1.00 0.82

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant