Skip to content

docs(requirements): create missing system stakeholder requirements and establish traceability #240

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 1 commit into from
Nov 3, 2025
Merged

docs(requirements): create missing system stakeholder requirements and establish traceability #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions requirements/SHR-SYSTEM-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
itemId: SHR-SYSTEM-1
itemTitle: System Health Monitoring and Observability
itemType: Requirement
Requirement type: QUALITY
---

## Description

Users shall be able to monitor the operational health and status of the system through multiple interfaces to ensure system reliability, diagnose issues, and maintain confidence in system availability. The system shall provide transparent, real-time visibility into its operational state across all user interaction points.
10 changes: 10 additions & 0 deletions requirements/SHR-SYSTEM-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
itemId: SHR-SYSTEM-2
itemTitle: Sensitive Data Privacy and Access Control
itemType: Requirement
Requirement type: QUALITY
---

## Description

Users shall have control over the visibility of sensitive information within the system including secrets, credentials, and configuration data. The system shall provide mechanisms to protect sensitive data from inadvertent exposure while allowing authorized users to access information when needed for troubleshooting or configuration purposes.
2 changes: 1 addition & 1 deletion requirements/SWR_SYSTEM_CLI_HEALTH_1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
itemId: SWR-SYSTEM-CLI-HEALTH-1
itemHasParent: SHR-USABILITY-1
itemHasParent: SHR-SYSTEM-1
itemType: Requirement
Module: System
Layer: CLI
Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR_SYSTEM_GUI_HEALTH_1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
itemId: SWR-SYSTEM-GUI-HEALTH-1
itemHasParent: SHR-USABILITY-1
itemHasParent: SHR-SYSTEM-1
itemType: Requirement
Module: System
Layer: GUI
Expand Down
2 changes: 1 addition & 1 deletion requirements/SWR_SYSTEM_GUI_SETTINGS_1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
itemId: SWR-SYSTEM-GUI-SETTINGS-1
itemHasParent: SHR-PRIVACY-1
itemHasParent: SHR-SYSTEM-2
itemType: Requirement
Module: System
Layer: GUI
Expand Down
2 changes: 1 addition & 1 deletion specifications/SPEC-UTILS-SERVICE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SPEC-UTILS-SERVICE
itemTitle: Utils Module Specification
itemType: Software Item Spec
itemFulfills: SWR-SYSTEM-CLI-HEALTH-1, SWR-SYSTEM-GUI-HEALTH-1, SWR-SYSTEM-GUI-SETTINGS-1
itemFulfills: SWR-SYSTEM-CLI-HEALTH-1, SWR-SYSTEM-GUI-HEALTH-1, SWR-SYSTEM-GUI-SETTINGS-1, SHR-SYSTEM-1, SHR-SYSTEM-2
itemIsRelatedTo: SPEC-GUI-SERVICE, SPEC-BUCKET-SERVICE, SPEC-DATASET-SERVICE, SPEC-NOTEBOOK-SERVICE, SPEC-PLATFORM-SERVICE, SPEC-QUPATH-SERVICE, SPEC-SYSTEM-SERVICE, SPEC-WSI-SERVICE
Module: Utils
Layer: Infrastructure Service
Expand Down
2 changes: 1 addition & 1 deletion specifications/SPEC_GUI_SERVICE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SPEC-GUI-SERVICE
itemTitle: GUI Module Specification
itemType: Software Item Spec
itemFulfills: SWR-SYSTEM-GUI-HEALTH-1, SWR-SYSTEM-GUI-SETTINGS-1
itemFulfills: SHR-APPLICATION-1, SHR-SYSTEM-1, SHR-SYSTEM-2
itemIsRelatedTo: SPEC-APPLICATION-SERVICE, SPEC-BUCKET-SERVICE, SPEC-DATASET-SERVICE, SPEC-NOTEBOOK-SERVICE, SPEC-QUPATH-SERVICE, SPEC-SYSTEM-SERVICE
Module: GUI _(Graphical User Interface Framework)_
Layer: Presentation Interface
Expand Down
2 changes: 1 addition & 1 deletion specifications/SPEC_SYSTEM_SERVICE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
itemId: SPEC-SYSTEM-SERVICE
itemTitle: System Module Specification
itemType: Software Item Spec
itemFulfills: SWR-SYSTEM-CLI-HEALTH-1, SWR-SYSTEM-GUI-HEALTH-1, SWR-SYSTEM-GUI-SETTINGS-1
itemFulfills: SWR-SYSTEM-CLI-HEALTH-1, SWR-SYSTEM-GUI-HEALTH-1, SWR-SYSTEM-GUI-SETTINGS-1, SHR-SYSTEM-1, SHR-SYSTEM-2
itemIsRelatedTo: SPEC-UTILS-SERVICE, SPEC-GUI-SERVICE
Module: System
Layer: Platform Service
Expand Down
Loading