Onboarding
10 requirements
·
24 scenarios
Onboarding Guide Visibility
JR-onboarding-001
The onboarding guide SHALL display automatically for new users who have not completed onboarding. Closing the guide SHALL hide it for the current session only; it SHALL reappear in a new session. Permanently dismissing the guide SHALL hide it until the user manually re-opens it. The guide SHALL be re-openable via a help menu entry point. When closed, the guide SHALL be fully non-interactive to prevent invisible click-blocking. The guide SHALL animate in and out with a slide transition that respects reduced-motion preferences.
6 test scenarios
- New user sees onboarding guide JR-onboarding-001.1
- Returning user does not see guide after dismissal JR-onboarding-001.2
- Temporary close persists within session JR-onboarding-001.3
- Permanent dismiss versus temporary close JR-onboarding-001.4
- Guide animates in and out JR-onboarding-001.5
- Closed guide is non-interactive JR-onboarding-001.6
Onboarding Step Structure
JR-onboarding-002
Onboarding steps SHALL be organized into stages with clear progress indicators. Each step SHALL have a title, description, time estimate, and call-to-action. The current stage SHALL be expanded by default, and a visual progress bar SHALL fill proportionally to completed steps.
2 test scenarios
- Step displays required information JR-onboarding-002.1
- Progress updates as steps complete JR-onboarding-002.2
Onboarding Step Completion
JR-onboarding-003
Steps SHALL complete automatically when their completion criteria are met, including via real-time SSE events from the backend. Completed steps SHALL display a checkmark and collapse. Steps MAY be skipped, and skipping SHALL advance to the next step in the same stage.
2 test scenarios
- Step auto-completes via real-time event JR-onboarding-003.1
- User skips a step JR-onboarding-003.2
Onboarding Step Actions
JR-onboarding-004
Step call-to-action buttons SHALL perform their configured actions: navigating to in-app routes, opening external URLs in a new tab, opening modal dialogs, or executing trigger actions such as copying content to clipboard. Copy actions SHALL display confirmation feedback.
2 test scenarios
- Navigate action opens in-app route JR-onboarding-004.1
- Copy action shows confirmation feedback JR-onboarding-004.2
Onboarding State Persistence
JR-onboarding-005
Onboarding state including dismissal preference, completion status, and skipped steps SHALL persist across sessions. Session-only state such as minimized status SHALL reset on page refresh.
1 test scenario
- State persists across page refresh JR-onboarding-005.1
Onboarding Flow Completion
JR-onboarding-006
The onboarding flow SHALL complete when all steps are done or skipped. A success message SHALL be displayed before the guide closes. The guide SHALL remain re-openable via the help menu even after completion.
2 test scenarios
- All steps completed triggers success message JR-onboarding-006.1
- Guide re-openable after completion JR-onboarding-006.2
Tenant-Specific Onboarding
JR-onboarding-007
The onboarding stage list SHALL be selectable based on the deployment hostname so that tenant deployments can present domain-specific guidance.
2 test scenarios
- Default host uses standard onboarding JR-onboarding-007.1
- Tenant host uses domain-specific onboarding JR-onboarding-007.2
Incentives Onboarding Flow
JR-onboarding-008
The incentives onboarding flow SHALL guide users through providing property context, requesting incentive searches, and viewing results.
1 test scenario
- Incentives stages surface property, query, and results actions JR-onboarding-008.1
Onboarding Flags Update on Actions
JR-onboarding-011
The system SHALL update tenant onboarding flags as users complete incentives actions such as creating a property profile, executing an incentive search, or viewing reports.
3 test scenarios
- Property profile creation updates flag JR-onboarding-011.1
- Incentive search updates flag JR-onboarding-011.2
- Viewing reports updates flag JR-onboarding-011.3
Onboarding Progress Badge
JR-onboarding-013
The setup guide toggle button SHALL display a badge showing the number of remaining steps when onboarding is incomplete and not dismissed. The badge SHALL NOT render when all steps are complete or when the guide has been permanently dismissed.
3 test scenarios
- Badge shows remaining step count JR-onboarding-013.1
- Badge disappears when onboarding completes JR-onboarding-013.2
- Badge disappears when guide is dismissed JR-onboarding-013.3