From ceac80c10a7ef02e81d194b03e334ed1d56f4321 Mon Sep 17 00:00:00 2001 From: muhab Date: Mon, 3 Nov 2025 11:55:22 +0100 Subject: [PATCH] docs(requirements): create missing system stakeholder requirements and establish traceability --- requirements/SHR-SYSTEM-1.md | 10 ++++++++++ requirements/SHR-SYSTEM-2.md | 10 ++++++++++ requirements/SWR_SYSTEM_CLI_HEALTH_1.md | 2 +- requirements/SWR_SYSTEM_GUI_HEALTH_1.md | 2 +- requirements/SWR_SYSTEM_GUI_SETTINGS_1.md | 2 +- specifications/SPEC-UTILS-SERVICE.md | 2 +- specifications/SPEC_GUI_SERVICE.md | 2 +- specifications/SPEC_SYSTEM_SERVICE.md | 2 +- 8 files changed, 26 insertions(+), 6 deletions(-) create mode 100644 requirements/SHR-SYSTEM-1.md create mode 100644 requirements/SHR-SYSTEM-2.md diff --git a/requirements/SHR-SYSTEM-1.md b/requirements/SHR-SYSTEM-1.md new file mode 100644 index 00000000..86de4c97 --- /dev/null +++ b/requirements/SHR-SYSTEM-1.md @@ -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. diff --git a/requirements/SHR-SYSTEM-2.md b/requirements/SHR-SYSTEM-2.md new file mode 100644 index 00000000..bc5ca390 --- /dev/null +++ b/requirements/SHR-SYSTEM-2.md @@ -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. diff --git a/requirements/SWR_SYSTEM_CLI_HEALTH_1.md b/requirements/SWR_SYSTEM_CLI_HEALTH_1.md index 718d14ba..1d5639d4 100644 --- a/requirements/SWR_SYSTEM_CLI_HEALTH_1.md +++ b/requirements/SWR_SYSTEM_CLI_HEALTH_1.md @@ -1,6 +1,6 @@ --- itemId: SWR-SYSTEM-CLI-HEALTH-1 -itemHasParent: SHR-USABILITY-1 +itemHasParent: SHR-SYSTEM-1 itemType: Requirement Module: System Layer: CLI diff --git a/requirements/SWR_SYSTEM_GUI_HEALTH_1.md b/requirements/SWR_SYSTEM_GUI_HEALTH_1.md index 963ea315..bfd89207 100644 --- a/requirements/SWR_SYSTEM_GUI_HEALTH_1.md +++ b/requirements/SWR_SYSTEM_GUI_HEALTH_1.md @@ -1,6 +1,6 @@ --- itemId: SWR-SYSTEM-GUI-HEALTH-1 -itemHasParent: SHR-USABILITY-1 +itemHasParent: SHR-SYSTEM-1 itemType: Requirement Module: System Layer: GUI diff --git a/requirements/SWR_SYSTEM_GUI_SETTINGS_1.md b/requirements/SWR_SYSTEM_GUI_SETTINGS_1.md index f315f621..442ab923 100644 --- a/requirements/SWR_SYSTEM_GUI_SETTINGS_1.md +++ b/requirements/SWR_SYSTEM_GUI_SETTINGS_1.md @@ -1,6 +1,6 @@ --- itemId: SWR-SYSTEM-GUI-SETTINGS-1 -itemHasParent: SHR-PRIVACY-1 +itemHasParent: SHR-SYSTEM-2 itemType: Requirement Module: System Layer: GUI diff --git a/specifications/SPEC-UTILS-SERVICE.md b/specifications/SPEC-UTILS-SERVICE.md index 51009049..1b952dd6 100644 --- a/specifications/SPEC-UTILS-SERVICE.md +++ b/specifications/SPEC-UTILS-SERVICE.md @@ -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 diff --git a/specifications/SPEC_GUI_SERVICE.md b/specifications/SPEC_GUI_SERVICE.md index fcf9d483..be2a1a54 100644 --- a/specifications/SPEC_GUI_SERVICE.md +++ b/specifications/SPEC_GUI_SERVICE.md @@ -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 diff --git a/specifications/SPEC_SYSTEM_SERVICE.md b/specifications/SPEC_SYSTEM_SERVICE.md index 5d8f8a1a..747bf508 100644 --- a/specifications/SPEC_SYSTEM_SERVICE.md +++ b/specifications/SPEC_SYSTEM_SERVICE.md @@ -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