Skip to content

Commit ceac80c

Browse files
docs(requirements): create missing system stakeholder requirements and establish traceability
1 parent a690b96 commit ceac80c

File tree

8 files changed

+26
-6
lines changed

8 files changed

+26
-6
lines changed

requirements/SHR-SYSTEM-1.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
itemId: SHR-SYSTEM-1
3+
itemTitle: System Health Monitoring and Observability
4+
itemType: Requirement
5+
Requirement type: QUALITY
6+
---
7+
8+
## Description
9+
10+
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.

requirements/SHR-SYSTEM-2.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
itemId: SHR-SYSTEM-2
3+
itemTitle: Sensitive Data Privacy and Access Control
4+
itemType: Requirement
5+
Requirement type: QUALITY
6+
---
7+
8+
## Description
9+
10+
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.

requirements/SWR_SYSTEM_CLI_HEALTH_1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
itemId: SWR-SYSTEM-CLI-HEALTH-1
3-
itemHasParent: SHR-USABILITY-1
3+
itemHasParent: SHR-SYSTEM-1
44
itemType: Requirement
55
Module: System
66
Layer: CLI

requirements/SWR_SYSTEM_GUI_HEALTH_1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
itemId: SWR-SYSTEM-GUI-HEALTH-1
3-
itemHasParent: SHR-USABILITY-1
3+
itemHasParent: SHR-SYSTEM-1
44
itemType: Requirement
55
Module: System
66
Layer: GUI

requirements/SWR_SYSTEM_GUI_SETTINGS_1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
itemId: SWR-SYSTEM-GUI-SETTINGS-1
3-
itemHasParent: SHR-PRIVACY-1
3+
itemHasParent: SHR-SYSTEM-2
44
itemType: Requirement
55
Module: System
66
Layer: GUI

specifications/SPEC-UTILS-SERVICE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
itemId: SPEC-UTILS-SERVICE
33
itemTitle: Utils Module Specification
44
itemType: Software Item Spec
5-
itemFulfills: SWR-SYSTEM-CLI-HEALTH-1, SWR-SYSTEM-GUI-HEALTH-1, SWR-SYSTEM-GUI-SETTINGS-1
5+
itemFulfills: SWR-SYSTEM-CLI-HEALTH-1, SWR-SYSTEM-GUI-HEALTH-1, SWR-SYSTEM-GUI-SETTINGS-1, SHR-SYSTEM-1, SHR-SYSTEM-2
66
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
77
Module: Utils
88
Layer: Infrastructure Service

specifications/SPEC_GUI_SERVICE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
itemId: SPEC-GUI-SERVICE
33
itemTitle: GUI Module Specification
44
itemType: Software Item Spec
5-
itemFulfills: SWR-SYSTEM-GUI-HEALTH-1, SWR-SYSTEM-GUI-SETTINGS-1
5+
itemFulfills: SHR-APPLICATION-1, SHR-SYSTEM-1, SHR-SYSTEM-2
66
itemIsRelatedTo: SPEC-APPLICATION-SERVICE, SPEC-BUCKET-SERVICE, SPEC-DATASET-SERVICE, SPEC-NOTEBOOK-SERVICE, SPEC-QUPATH-SERVICE, SPEC-SYSTEM-SERVICE
77
Module: GUI _(Graphical User Interface Framework)_
88
Layer: Presentation Interface

specifications/SPEC_SYSTEM_SERVICE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
itemId: SPEC-SYSTEM-SERVICE
33
itemTitle: System Module Specification
44
itemType: Software Item Spec
5-
itemFulfills: SWR-SYSTEM-CLI-HEALTH-1, SWR-SYSTEM-GUI-HEALTH-1, SWR-SYSTEM-GUI-SETTINGS-1
5+
itemFulfills: SWR-SYSTEM-CLI-HEALTH-1, SWR-SYSTEM-GUI-HEALTH-1, SWR-SYSTEM-GUI-SETTINGS-1, SHR-SYSTEM-1, SHR-SYSTEM-2
66
itemIsRelatedTo: SPEC-UTILS-SERVICE, SPEC-GUI-SERVICE
77
Module: System
88
Layer: Platform Service

0 commit comments

Comments
 (0)