Skip to content

docs: fix requirements documentation traceability #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 4, 2025
Merged

docs: fix requirements documentation traceability #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9e04703
docs: add missing "Requirement Type" to some requirements
santi698 Nov 4, 2025
243323b
docs: annotate requirement type in requirement files with the actual …
santi698 Nov 4, 2025
386c2bf
docs(requirements): add missing itemTitle to system health and settin…
santi698 Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion requirements/SHR-APPLICATION-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SHR-APPLICATION-1
itemTitle: Application Discovery and Navigation
itemType: Requirement
Requirement type: ENVIRONMENT
Requirement type: ENVIRONMENT # Stakeholder requirement (user)
---

## Description
Expand Down
2 changes: 1 addition & 1 deletion requirements/SHR-APPLICATION-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SHR-APPLICATION-2
itemTitle: Application Run Management
itemType: Requirement
Requirement type: ENVIRONMENT
Requirement type: ENVIRONMENT # Stakeholder requirement (user)
---

## Description
Expand Down
2 changes: 1 addition & 1 deletion requirements/SHR-APPLICATION-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SHR-APPLICATION-3
itemTitle: Application Results Management
itemType: Requirement
Requirement type: ENVIRONMENT
Requirement type: ENVIRONMENT # Stakeholder requirement (user)
---

## Description
Expand Down
2 changes: 1 addition & 1 deletion requirements/SHR-BUCKET-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SHR-BUCKET-1
itemTitle: Cloud Storage File Management
itemType: Requirement
Requirement type: ENVIRONMENT
Requirement type: ENVIRONMENT # Stakeholder requirement (user)
---

## Description
Expand Down
2 changes: 1 addition & 1 deletion requirements/SHR-DATASET-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SHR-DATASET-1
itemTitle: Dataset Discovery and Download
itemType: Requirement
Requirement type: ENVIRONMENT
Requirement type: ENVIRONMENT # Stakeholder requirement (user)
---

## Description
Expand Down
2 changes: 1 addition & 1 deletion requirements/SHR-NOTEBOOK-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SHR-NOTEBOOK-1
itemTitle: Notebook Environment Management
itemType: Requirement
Requirement type: ENVIRONMENT
Requirement type: ENVIRONMENT # Stakeholder requirement (user)
---

## Description
Expand Down
2 changes: 1 addition & 1 deletion requirements/SHR-SYSTEM-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SHR-SYSTEM-1
itemTitle: System Health Monitoring and Observability
itemType: Requirement
Requirement type: ENVIRONMENT
Requirement type: ENVIRONMENT # Stakeholder requirement (user)
---

## Description
Expand Down
2 changes: 1 addition & 1 deletion requirements/SHR-SYSTEM-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SHR-SYSTEM-2
itemTitle: Sensitive Data Privacy and Access Control
itemType: Requirement
Requirement type: ENVIRONMENT
Requirement type: ENVIRONMENT # Stakeholder requirement (user)
---

## Description
Expand Down
2 changes: 1 addition & 1 deletion requirements/SHR-VISUALIZATION-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SHR-VISUALIZATION-1
itemTitle: Image Visualization and Analysis Tools
itemType: Requirement
Requirement type: ENVIRONMENT
Requirement type: ENVIRONMENT # Stakeholder requirement (user)
---

## Description
Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-1-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-1-1
itemTitle: List Available Applications
itemHasParent: SHR-APPLICATION-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-1-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-1-2
itemTitle: List Available Application Versions
itemHasParent: SHR-APPLICATION-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-1
itemTitle: Validate Slide Metadata Completeness
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-10.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-10
itemTitle: Provide File Selection Interface
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: User Interface (frontend)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-11.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-11
itemTitle: Detect Compatible Slide Files
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
3 changes: 2 additions & 1 deletion requirements/SWR-APPLICATION-2-12.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ itemId: SWR-APPLICATION-2-12
itemTitle: Poll Application Run Status at Regular Intervals
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

System shall poll application run status at regular intervals and shall detect when runs reach completed status.
3 changes: 2 additions & 1 deletion requirements/SWR-APPLICATION-2-13.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ itemId: SWR-APPLICATION-2-13
itemTitle: Accept Optional Run Name and Description
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

System shall accept optional user-provided run name and description during application run submission. The system shall validate that run names do not exceed 100 characters and descriptions do not exceed 500 characters when provided, and shall store these metadata fields with the run record.
3 changes: 2 additions & 1 deletion requirements/SWR-APPLICATION-2-14.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ itemId: SWR-APPLICATION-2-14
itemTitle: Accept Optional Custom Item Names and Descriptions
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

System shall accept optional user-provided custom names and descriptions for individual items (e.g., slides) during application run submission. The system shall validate that custom item names do not exceed 100 characters and descriptions do not exceed 500 characters when provided, and shall store these metadata fields with the corresponding item records.
9 changes: 5 additions & 4 deletions requirements/SWR-APPLICATION-2-15.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ itemId: SWR-APPLICATION-2-15
itemTitle: Display Run Name and Description in Run List
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (frontend interface)
---
System shall display user-provided run names and descriptions in the application run list
interface. The system shall show the run name as the primary identifier when provided, otherwise
shall display a system-generated identifier, and shall make descriptions accessible through the

System shall display user-provided run names and descriptions in the application run list
interface. The system shall show the run name as the primary identifier when provided, otherwise
shall display a system-generated identifier, and shall make descriptions accessible through the
interface when available.
3 changes: 2 additions & 1 deletion requirements/SWR-APPLICATION-2-16.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ itemId: SWR-APPLICATION-2-16
itemTitle: Display Run Items with Metadata
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: User Interface (frontend)
---

System shall display all items included in an application run showing thumbnail images, custom item names when provided otherwise filenames, custom item descriptions when provided, and file paths.
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-2
itemTitle: Validate MPP Resolution Against Application Limits
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-3
itemTitle: Upload Slide Files to Platform Storage
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-4
itemTitle: Submit Application Run with Validation Error Handling
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-5
itemTitle: Create Application Run with Unique Identifier
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-6.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-6
itemTitle: Provide Application Run Status Information
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-7
itemTitle: Cancel Running Application Runs
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-8
itemTitle: Generate Metadata from Slide Files
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-2-9.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-2-9
itemTitle: Monitor Application Run Status on User Request
itemHasParent: SHR-APPLICATION-2
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-3-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-3-1
itemTitle: Download Application Run Results
itemHasParent: SHR-APPLICATION-3
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-APPLICATION-3-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-APPLICATION-3-2
itemTitle: Validate Output Artifact Integrity
itemHasParent: SHR-APPLICATION-3
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
3 changes: 2 additions & 1 deletion requirements/SWR-APPLICATION-3-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ itemId: SWR-APPLICATION-3-3
itemTitle: Download Partial Results from Cancelled Runs
itemHasParent: SHR-APPLICATION-3
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

System shall provide access to download completed partial results when application runs have been cancelled by users. The system shall make available all output artifacts that were successfully generated before cancellation occurred.
2 changes: 1 addition & 1 deletion requirements/SWR-BUCKET-1-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-BUCKET-1-1
itemTitle: Upload Directory Structure to Bucket Storage
itemHasParent: SHR-BUCKET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-BUCKET-1-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-BUCKET-1-2
itemTitle: List Bucket Files
itemHasParent: SHR-BUCKET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-BUCKET-1-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-BUCKET-1-3
itemTitle: Download Files with Content Validation
itemHasParent: SHR-BUCKET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-BUCKET-1-4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-BUCKET-1-4
itemTitle: Delete Individual Files from Bucket
itemHasParent: SHR-BUCKET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-BUCKET-1-5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-BUCKET-1-5
itemTitle: Enable Download and Delete Upon File Selection
itemHasParent: SHR-BUCKET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-BUCKET-1-6.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-BUCKET-1-6
itemTitle: Remove Selected Files from Bucket Storage
itemHasParent: SHR-BUCKET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-BUCKET-1-7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-BUCKET-1-7
itemTitle: Reflect File Removal in User Interface
itemHasParent: SHR-BUCKET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: User Interface (frontend)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-BUCKET-1-8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-BUCKET-1-8
itemTitle: Disable File Operation Controls Without Selection
itemHasParent: SHR-BUCKET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: User Interface (frontend)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-BUCKET-1-9.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-BUCKET-1-9
itemTitle: Confirm File Download Completion
itemHasParent: SHR-BUCKET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: User Interface (frontend)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-DATASET-1-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-DATASET-1-1
itemTitle: Download Dataset Instance via CLI Command
itemHasParent: SHR-DATASET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-DATASET-1-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-DATASET-1-2
itemTitle: Verify Downloaded File Integrity
itemHasParent: SHR-DATASET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-DATASET-1-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-DATASET-1-3
itemTitle: Provide Download Completion Confirmation
itemHasParent: SHR-DATASET-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: User Interface (frontend)
---

Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR-NOTEBOOK-1-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ itemId: SWR-NOTEBOOK-1-1
itemTitle: Launch Notebook Extension
itemHasParent: SHR-NOTEBOOK-1
itemType: Requirement
Requirement type: FUNCTIONAL
Requirement type: FUNCTIONAL # Software requirement (user)
Layer: System (backend logic)
---

Expand Down
Loading
Loading