STD: Context Sensitive Help (HELP)

Version: v1.0.0 Status: Draft SRS Source: docusaurus/docs/srs/help.md Domain: HELP

---

Overview

This document specifies tests for the Context Sensitive Help domain, which covers help content display, search functionality, administrative configuration, video management, and bulk import/export operations.

Domain Characteristics:

• Primary function: UI display and user interaction (help widget, search)
• Secondary function: Administrative configuration (CRUD, ordering, tags)
• External dependency: S3 storage for video files
• Bulk operations: Excel import/export for configuration

Test Method Rationale: Per Test Plan Section 3.3, this domain spans UI Features (display, search) and Configuration (admin, import/export). User-facing features use TM-UI, configuration import/export uses TM-API (file I/O testable at service boundary), and video management uses TM-HYB due to S3 integration complexity.

Test Case Convention: Steps describe logical actions, not UI mechanics. Use "Open help widget" or "Search for help content", not "Click the ? icon" or "Enter text in input#search-field". This ensures test intent survives UI redesigns.

---

Coverage Summary

REQ ID	Title	ACs	Tests	AC Coverage	Method	Gaps
REQ-HELP-001	Display Context-Sensitive Help	8	TC-HELP-001, TC-HELP-002, TC-HELP-003	8/8 (100%)	TM-UI	None
REQ-HELP-002	Search Help Content	7	TC-HELP-004, TC-HELP-005	7/7 (100%)	TM-UI	None
REQ-HELP-003	Configure Help Items	11	TC-HELP-006, TC-HELP-007, TC-HELP-008, TC-HELP-009	11/11 (100%)	TM-UI	None
REQ-HELP-004	Manage Help Videos	7	TC-HELP-010, TC-HELP-011, TC-HELP-012	7/7 (100%)	TM-HYB	None
REQ-HELP-005	Import/Export Help Configuration	8	TC-HELP-013, TC-HELP-014, TC-HELP-015	8/8 (100%)	TM-API	None

Totals: 5 REQs, 41 ACs, 15 Test Cases, 100% Coverage

---

Test Cases

TC-HELP-001: Help availability indication and display

Verifies: REQ-HELP-001 (AC1, AC2, AC3)

Method: TM-UI

Priority: High

Preconditions:

• User logged in with at least Junior User role
• Help items configured for at least one application screen
• At least one screen has no help items configured

Test Data:

• Screen A: 2 help items configured (with title/description)
• Screen B: No help items configured

Steps:

1. Navigate to Screen A (with configured help)
2. Observe presence of help availability indicator
3. Request help (open help widget)
4. Observe help item display
5. Navigate to Screen B (no configured help)
6. Observe absence of help availability indicator

Expected Results:

• AC1: Help availability indicator displayed on Screen A
• AC2: Help items displayed upon user request
• AC3: Each help item shows title and description
• Error-1: No help indicator on Screen B (no configured items)

Automation Status: Automated

Jira: BT-3150

---

TC-HELP-002: Video availability indication and playback

Verifies: REQ-HELP-001 (AC4, AC5, AC6)

Method: TM-UI

Priority: High

Preconditions:

• Help items visible in help widget
• At least one help item has an associated video
• At least one help item has no video

Test Data:

• Help Item A: Has associated video
• Help Item B: No video association

Steps:

1. Open help widget containing both test help items
2. Observe Help Item A for video indication
3. Observe Help Item B (should have no video indicator)
4. Select video playback for Help Item A
5. Observe video player behavior

Expected Results:

• AC4: Help Item A displays video availability indicator
• AC5: Video plays when selected
• AC6: Picture-in-Picture mode is not available in video player controls

Automation Status: Automated

Jira: BT-2705

---

TC-HELP-003: Video playback error handling

Verifies: REQ-HELP-001 (Error-2)

Method: TM-HYB

Priority: Medium

Preconditions:

• Help item configured with video reference
• Video file removed or inaccessible from S3 storage

Test Data:

• Help Item: Video reference points to non-existent file

Steps:

1. Open help widget
2. Locate help item with broken video reference
3. Attempt to play the video

Expected Results:

• Error-2: System displays error message indicating video unavailability

Automation Status: Manual (requires S3 manipulation)

Jira: BT-2705

Deviation: TM-HYB/TM-MAN used due to need to manipulate S3 storage state. Remediation: Consider mock S3 for automated error scenario testing.

---

TC-HELP-004: Search functionality across content fields

Verifies: REQ-HELP-002 (AC1, AC2, AC3, AC4)

Method: TM-UI

Priority: High

Preconditions:

• Multiple help items exist with searchable content

Test Data:

• Help Item A: Title="Import Guide", Description="How to import files", Tags="upload data"
• Help Item B: Title="Export Data", Description="Exporting results", Tags="download csv"
• Help Item C: Title="Analysis", Description="Running analysis", Tags="process compute"

Steps:

1. Open help widget
2. Observe search capability is present
3. Enter search query "import"
4. Observe results
5. Clear search and enter query "data"
6. Observe results (should match both A and B via different fields)

Expected Results:

• AC1: Search capability available in help interface
• AC2: Search matches against help item titles ("import" matches Item A title)
• AC3: Search matches against help item descriptions ("data" matches Item B description)
• AC4: Search matches against help item tags ("data" matches Item A tags)

Automation Status: Automated

Jira: BT-3152

---

TC-HELP-005: Search result display and tag visibility

Verifies: REQ-HELP-002 (AC5, AC6, AC7)

Method: TM-UI

Priority: Medium

Preconditions:

• Same as TC-HELP-004
• Non-admin user logged in

Test Data:

• Help Item A: Title="Import Guide", Tags="upload data"

Steps:

1. Login as non-admin user
2. Open help widget
3. Enter search query "upload" (matches tag only)
4. Observe search results
5. Observe result display format

Expected Results:

• AC5: Only matching help items displayed (Item A appears)
• AC6: Search terms highlighted in matching title/description
• AC7: Tags are NOT visible to non-admin user (item matches but tags hidden)

Automation Status: Automated

Jira: BT-3152

---

TC-HELP-006: Help item CRUD operations

Verifies: REQ-HELP-003 (AC1, AC2, AC3)

Method: TM-UI

Priority: High

Preconditions:

• User logged in as Admin
• Access to help item configuration

Test Data:

• New help item: Title="Test Help", Description="Test Description", Screen="Runfile List"

Steps:

1. Navigate to help item configuration
2. Create new help item with title, description, and screen assignment
3. Save the help item
4. Verify item appears in configuration list
5. Modify the help item description
6. Save changes
7. Navigate to assigned screen as regular user
8. Verify help item appears in help widget

Expected Results:

• AC1: Admin can create new help item
• AC2: Admin can modify existing help item
• AC3: Configuration includes title, description, video association, and screen assignment
• Help item appears on assigned screen for users

Automation Status: Automated

Jira: BT-3151

---

TC-HELP-007: Tag configuration by super-admin

Verifies: REQ-HELP-003 (AC4, AC5)

Method: TM-UI

Priority: Medium

Preconditions:

• User logged in as Super-Admin
• Existing help item

Test Data:

• Tags: "keyword1 keyword2 keyword3"

Steps:

1. Login as Super-Admin
2. Navigate to help item configuration
3. Edit existing help item
4. Verify tags field is visible and editable
5. Enter tags as space-separated values
6. Save configuration
7. Search for one of the tags
8. Verify help item appears in results

Expected Results:

• AC4: Super-admin can configure tags for help items
• AC5: Tags stored as space-separated values and are searchable

Automation Status: Automated

Jira: BT-2703

---

TC-HELP-008: Display order configuration and validation

Verifies: REQ-HELP-003 (AC6, AC7, AC8, Error-1)

Method: TM-UI

Priority: High

Preconditions:

• Admin user logged in
• Multiple help items exist for same screen

Test Data:

• Help Item A: Order=3
• Help Item B: Order=1
• Help Item C: Order=2
• Total items: 3

Steps:

1. Navigate to help item configuration
2. Set display order for items (A=3, B=1, C=2)
3. Save configuration
4. Open help widget on the associated screen
5. Verify items appear in configured order (B, C, A)
6. Attempt to set order value = 5 (exceeds total of 3)
7. Observe validation response

Expected Results:

• AC6: Admin can specify display order for help items
• AC7: Help items display in configured order
• AC8: Order value validation - cannot exceed total number of items
• Error-1: Validation error displayed and save prevented when order exceeds count

Automation Status: Automated

Jira: BT-3151

---

TC-HELP-009: Screen assignment multi-select and validation

Verifies: REQ-HELP-003 (AC9, Error-2)

Method: TM-UI

Priority: Medium

Preconditions:

• Admin user logged in
• Help item configuration accessible

Test Data:

• Help item to assign to multiple screens: Runfile List, Runfile Report

Steps:

1. Navigate to help item configuration
2. Create or edit help item
3. Use screen assignment interface to select multiple pages
4. Save with all required fields
5. Attempt to save without required fields (e.g., no title)
6. Observe validation

Expected Results:

• AC9: Multi-select interface available for page selection
• Error-2: Validation error when required field missing, save prevented

Automation Status: Automated

Jira: BT-3151

---

TC-HELP-010: Video selection from existing library

Verifies: REQ-HELP-004 (AC1)

Method: TM-HYB

Priority: High

Preconditions:

• Admin user logged in
• At least one video already exists in storage

Test Data:

• Existing video: "training_video.mp4"

Steps:

1. Navigate to help item configuration
2. Edit or create help item
3. Access video selection interface
4. Select existing video from list
5. Save help item

Expected Results:

• AC1: Admin can select from existing videos

Automation Status: Automated

Jira: BT-2939

---

TC-HELP-011: Video upload and naming

Verifies: REQ-HELP-004 (AC2, AC3, AC4, AC5)

Method: TM-HYB

Priority: High

Preconditions:

• Admin user logged in
• S3 storage configured and accessible
• Video file prepared for upload (MP4, <100MB)

Test Data:

• Video file: "new_tutorial.mp4"

Steps:

1. Navigate to help item configuration
2. Initiate new video upload
3. Upload video file
4. Observe default video name assignment
5. Edit video name to custom value
6. Save configuration
7. Verify video accessible in system

Expected Results:

• AC2: Admin can upload new video files
• AC3: Video stored in configured storage location (S3)
• AC4: Filename assigned as default video name ("new_tutorial")
• AC5: Admin can override default video name

Automation Status: Manual (S3 interaction verification)

Jira: BT-2939

Deviation: TM-HYB with manual verification for S3 storage confirmation. Remediation: Implement S3 state verification in test framework.

---

TC-HELP-012: Video upload error handling

Verifies: REQ-HELP-004 (Error-1, Error-2)

Method: TM-MAN

Priority: Medium

Preconditions:

• Admin user logged in
• Ability to simulate upload failure or S3 unavailability

Test Data:

• Scenario A: Valid video, simulated upload failure
• Scenario B: S3 connection unavailable

Steps:

1. Simulate upload failure condition
2. Attempt to upload video
3. Observe error message
4. Simulate S3 unavailability
5. Attempt video operation
6. Observe error message

Expected Results:

• Error-1: Upload failure displays error message indicating upload failure
• Error-2: S3 unavailable displays error message indicating storage unavailability

Automation Status: Manual (requires infrastructure manipulation)

Jira: BT-2939

Deviation: TM-MAN due to infrastructure manipulation required. Remediation: Consider mock S3 service for error scenario automation.

---

TC-HELP-013: Export help configuration to Excel

Verifies: REQ-HELP-005 (AC1, AC2)

Method: TM-API

Priority: High

Preconditions:

• Admin user logged in
• Multiple help items configured with various fields populated

Test Data:

• Help Item A: Title, Description, Video, Pages, Tags, Order all populated
• Help Item B: Minimal fields (Title, Description only)

Steps:

1. Trigger help configuration export via API/admin interface
2. Download generated Excel file
3. Open and inspect file contents

Expected Results:

• AC1: Export generates Excel format file
• AC2: File contains all configurable fields (title, description, video, pages, tags, order)

Automation Status: Manual (XLSX verification — help config import/export content verification)

Jira: BT-3151

---

TC-HELP-014: Import help configuration with order normalization

Verifies: REQ-HELP-005 (AC3, AC4, AC5, AC6)

Method: TM-API

Priority: High

Preconditions:

• Admin access
• Valid Excel file with help item configuration

Test Data:

• Excel file with 4 help items:
  • Item A: Order=1
  • Item B: Order=5
  • Item C: Order=12
  • Item D: Order=40

Steps:

1. Prepare Excel file with test data
2. Import file via API/admin interface
3. Verify help items created/updated
4. Check order values after import

Expected Results:

• AC3: Import accepts Excel format
• AC4: All configurable fields processed from import
• AC5: Order values normalized (1, 5, 12, 40 becomes 1, 2, 3, 4)
• AC6: Normalization converts to sequential 1-based ordering

Automation Status: Manual (XLSX verification — help config import/export content verification)

Jira: BT-2703

---

TC-HELP-015: Import validation and error handling

Verifies: REQ-HELP-005 (Error-1, Error-2)

Method: TM-API

Priority: Medium

Preconditions:

• Admin access

Test Data:

• Scenario A: Invalid file format (CSV instead of XLSX)
• Scenario B: Excel file with missing required fields

Steps:

1. Attempt import with invalid file format
2. Observe error response
3. Attempt import with valid format but invalid data (missing required fields)
4. Observe error response

Expected Results:

• Error-1: Invalid format displays error message describing format issue
• Error-2: Validation failure displays validation errors and rejects import

Automation Status: Manual (XLSX verification — help config import/export content verification)

Jira: BT-3151

---

Gap Analysis

No gaps identified. All 41 acceptance criteria have test coverage.

Coverage by AC Type

AC Category	Count	Covered	Notes
Display/Rendering	7	7	Verified via TM-UI
User Interaction	6	6	Verified via TM-UI (search, video playback)
Admin Configuration	12	12	Verified via TM-UI
Video Management	5	5	Verified via TM-HYB
Import/Export	6	6	Verified via TM-API
Error Handling	5	5	Verified via TM-UI/TM-HYB/TM-MAN

---

Traceability to Existing Tests

Test Case	Jira Test	Automation
TC-HELP-001	BT-3150	Selenium
TC-HELP-002, TC-HELP-003	BT-2705	Selenium/Manual
TC-HELP-004, TC-HELP-005	BT-3152	Selenium
TC-HELP-006, TC-HELP-008, TC-HELP-009	BT-3151	Selenium
TC-HELP-007	BT-2703	Selenium
TC-HELP-010, TC-HELP-011, TC-HELP-012	BT-2939	Selenium/Manual
TC-HELP-013, TC-HELP-015	BT-3151	API
TC-HELP-014	BT-2703	API

---

Notes

• HELP domain combines UI features (display, search) with administrative configuration
• Video management requires S3 integration; some error scenarios require manual testing
• Import/Export follows standard kit configuration pattern (REQ-CONFIGIO-008)
• Tags are only visible/editable by super-admin users; this role distinction must be verified
• Existing Gherkin tests in SRS cover same scenarios; this STD formalizes method and coverage
• TC-HELP-003, TC-HELP-011, TC-HELP-012 require manual steps due to infrastructure dependencies