From fd14727656a3384e7de5b561aef82d7f8dd9d3c0 Mon Sep 17 00:00:00 2001 From: Michael Dratch Date: Fri, 20 Feb 2026 15:32:05 -0500 Subject: [PATCH] documentation updates --- docs/user-docs/docs/custom-checks.md | 1 + docs/user-docs/docs/user-guide.md | 63 ++++++++++++++++++++-------- docs/user-docs/mkdocs.yml | 5 +++ 3 files changed, 51 insertions(+), 18 deletions(-) create mode 100644 docs/user-docs/docs/custom-checks.md diff --git a/docs/user-docs/docs/custom-checks.md b/docs/user-docs/docs/custom-checks.md new file mode 100644 index 00000000..0f24d384 --- /dev/null +++ b/docs/user-docs/docs/custom-checks.md @@ -0,0 +1 @@ +# Custom Checks diff --git a/docs/user-docs/docs/user-guide.md b/docs/user-docs/docs/user-guide.md index bbb8a0aa..d407f14e 100644 --- a/docs/user-docs/docs/user-guide.md +++ b/docs/user-docs/docs/user-guide.md @@ -1,4 +1,4 @@ -# Building an Eligibility Screener +# User Guide This section explains how to create, configure, test, and publish an eligibility screener using the Benefit Decision Toolkit (BDT). @@ -48,21 +48,31 @@ These tabs represent the main stages of screener development. The **Manage Benefits** tab is where you define the eligibility logic used by your screener. -A single screener can evaluate eligibility for one or multiple benefits. The evaluation logic for each benefit is configured separately. This design a single BDT screener to screens users for multiple related programs, while keeping management of each benefit seperate. +In the BDT platform, a **Benefit** is a configured set of eligibility rules that evaluates whether a user qualifies for a specific program. -> TODO: Add image of Manage Benefits tab +When a user submits information through the screener form: -### 3.1 Benefits Overview +1. The screener collects the user’s inputs. +2. BDT passes those inputs to each configured Benefit. +3. Each Benefit evaluates its eligibility rules. +4. The Benefit returns an eligibility result. +5. The result is displayed to the user on the front-end form. -When you open the **Manage Benefits** tab, you will see a list of benefits associated with the screener. +A single screener can evaluate eligibility for one or multiple benefits. Each benefit’s logic is configured independently within the **Manage Benefits** tab. + +This allows a single screener to assess users for multiple related programs while keeping the eligibility rules for each benefit separate and manageable. + +### 3.1 Manage Benefits Overview + +The **Manage Benefits** tab displays all benefits configured for your screener. From this page, you can: -- Create a new benefit -- Edit an existing benefit -- Remove a benefit +- **Create** a new benefit +- **Edit** an existing benefit +- **Delete** a benefit -Selecting a benefit opens the **Configure Benefit** page. +Selecting a benefit opens the **Configure Benefit** page, where you define or modify its eligibility rules. > TODO: Add image of Configure Benefit page @@ -70,23 +80,40 @@ Selecting a benefit opens the **Configure Benefit** page. ## 4. Configuring a Benefit -The **Configure Benefit** page is where you define the rules that determine eligibility. +The **Configure Benefit** page is where you define the rules that determine whether a user qualifies for a specific benefit. -Eligibility logic in BDT is built using **Eligibility Checks**. +Each benefit contains one or more **Eligibility Checks**. + +> A user is considered **eligible for the benefit only if all eligibility checks evaluate to `True`.** + +--- ### What Is an Eligibility Check? An **Eligibility Check** is a reusable rule component that: -- Accepts one or more user inputs +- Accepts one or more user inputs (from your form) - Evaluates a defined condition -- Returns a boolean result (True or False) +- Returns a boolean result (`True` or `False`) + +You configure each check by selecting a check type and setting its parameters. + +#### Example + +Suppose a benefit requires that applicants: + +- Be at least 65 years old +- Live in the state of California + +You could configure: -For example, a rule might require applicants to be at least 65 years old. You could add a _Person Minimum Age_ check and configure the minimum age parameter to `65`. +- A **Person Minimum Age** check with a minimum age of `65` +- A **State of Residence** check set to `California` -By combining multiple checks, you define the full set of eligibility rules for a benefit. +If **both** checks return `True`, the user is eligible. +If **either** check returns `False`, the user is not eligible. -Currently, a benefit evaluates as **eligible** only if _all_ of its eligibility checks return `True`. +By combining multiple eligibility checks, you define the complete eligibility criteria for a benefit. --- @@ -103,11 +130,11 @@ To use a check: 1. Select the check from the list 2. Click **Add** -3. Configure its parameters +3. Add values for each of its required configuration parameters Once added, the check appears in the benefit’s list of configured checks. > TODO: Add image of check list > TODO: Add image of check parameter configuration -For information about creating reusable custom checks, see **Creating Custom Checks**. +For information about creating reusable custom checks, see [Custom Checks](custom-checks.md). diff --git a/docs/user-docs/mkdocs.yml b/docs/user-docs/mkdocs.yml index 8c4d69df..b6bf1131 100644 --- a/docs/user-docs/mkdocs.yml +++ b/docs/user-docs/mkdocs.yml @@ -2,3 +2,8 @@ site_name: Benefits Decision Toolkit theme: name: material + +nav: + - Instroduction: index.md + - User Guide: user-guide.md + - Custom Checks: custom-checks.md