Skip to content

Commit 8e2b692

Browse files
muhabalwan-aginxmuhabalwan-aginx
authored
chore(docs): add requirements mds for existing and to be implemented … (#40)
* chore(docs): add requirements mds for existing and to be implemented functionalities
1 parent 835b901 commit 8e2b692

35 files changed

+907
-0
lines changed

‎docs/requirements/AGENT.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Requirements Documentation Instructions
2+
3+
When creating or editing requirement documents:
4+
5+
1. **Use the template** at `docs/requirements/TEMPLATE_SHR.md` for Stakeholder Requirement
6+
7+
2. **Use the template** at `docs/requirements/TEMPLATE_SWR.md` for Software Requirements
8+
9+
2. **Set Requirement Type** using this mapping:
10+
11+
| Requirement Type | Value |
12+
| ----------------------------- | --------------------------------------- |
13+
| USE_CASE | Software requirement (regulatory) |
14+
| TECHNICAL | Stakeholder requirement (system) |
15+
| FUNCTIONAL | Software requirement (user) |
16+
| INTERFACES | Stakeholder requirement (performance) |
17+
| REGULATORY | Software requirement (system) |
18+
| ENVIRONMENT | Stakeholder requirement (user) |
19+
| SOFTWARE_IO | Software requirement (performance) |
20+
| DOCUMENTATION | Stakeholder requirement (science) |
21+
| FAULT_HANDLING | Stakeholder requirement (business) |
22+
| SOFTWARE_SYSTEM | Stakeholder requirement (cybersecurity) |
23+
| USER_MAINTENANCE | Software requirement (other) |
24+
| DATA_AND_DATABASES | Software requirement (cybersecurity) |
25+
| EXTERNAL_INTERFACES | Stakeholder requirement (regulatory) |
26+
| ACCOMPANYING_DOCUMENTS | Software requirement (business) |
27+
| USER_INTERFACE_SPECIFICATION | Software requirement (user interface) |
28+
| ESSENTIAL_FUNCTION_PROTECTION | Software requirement (science) |

‎docs/requirements/SHR-APP-DISCOVERY.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-APP-DISCOVERY
3+
itemTitle: Application Discovery
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: FUNCTIONAL
7+
---
8+
9+
<!-- Original reference: SHR-TSSDK-2 -->
10+
11+
## Description
12+
13+
Users shall be able to discover available AI applications and their versions.

‎docs/requirements/SHR-APP-EXEC.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-APP-EXEC
3+
itemTitle: Application Execution Access
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: FUNCTIONAL
7+
---
8+
9+
<!-- Original reference: SHR-TSSDK-3 -->
10+
11+
## Description
12+
13+
Users shall be able to execute AI applications on slide data to generate analytical insights.

‎docs/requirements/SHR-APP-RESULTS.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-APP-RESULTS
3+
itemTitle: Application Results Access
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: FUNCTIONAL
7+
---
8+
9+
<!-- Original reference: SHR-TSSDK-5 -->
10+
11+
## Description
12+
13+
Users shall be able to access and retrieve results generated from AI application runs.

‎docs/requirements/SHR-APP-RUN-MGMT.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-APP-RUN-MGMT
3+
itemTitle: Application Run Management
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: FUNCTIONAL
7+
---
8+
9+
<!-- Original reference: SHR-TSSDK-4 -->
10+
11+
## Description
12+
13+
Users shall be able to monitor status and manage the lifecycle of their AI application runs.

‎docs/requirements/SHR-AUTH.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-AUTH
3+
itemTitle: Authenticated Platform Access
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: SECURITY
7+
---
8+
9+
<!-- Original reference: SHR-TSSDK-1 -->
10+
11+
## Description
12+
13+
Access to the Aignostics Platform shall require valid user authentication credentials.

‎docs/requirements/SHR-ERROR-COMM.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SHR-ERROR-COMM
3+
itemTitle: Error Communication
4+
itemType: Requirement
5+
# Stakeholder requirement (user)
6+
Requirement type: FUNCTIONAL
7+
---
8+
9+
<!-- Original reference: SHR-TSSDK-6 -->
10+
11+
## Description
12+
13+
Users shall receive clear information when operations fail.

‎docs/requirements/SWR-APP-DISCOVERY-DETAILS.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SWR-APP-DISCOVERY-DETAILS
3+
itemTitle: Application Details
4+
itemHasParent: SHR-APP-DISCOVERY
5+
itemType: Requirement
6+
# Software requirement (user)
7+
Requirement type: FUNCTIONAL
8+
Layer: System (backend logic)
9+
---
10+
11+
<!-- Original reference: SWR-TSSDK-2.2 -->
12+
13+
System shall provide application identification, description, and regulatory compliance information for each retrieved application.

‎docs/requirements/SWR-APP-DISCOVERY-LIST.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SWR-APP-DISCOVERY-LIST
3+
itemTitle: Application List Retrieval
4+
itemHasParent: SHR-APP-DISCOVERY
5+
itemType: Requirement
6+
# Software requirement (user)
7+
Requirement type: FUNCTIONAL
8+
Layer: System (backend logic)
9+
---
10+
11+
<!-- Original reference: SWR-TSSDK-2.1 -->
12+
13+
System shall retrieve all available AI applications accessible to the authenticated user.

‎docs/requirements/SWR-APP-DISCOVERY-VERSION-DETAILS.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
itemId: SWR-APP-DISCOVERY-VERSION-DETAILS
3+
itemTitle: Version Details
4+
itemHasParent: SHR-APP-DISCOVERY
5+
itemType: Requirement
6+
# Software requirement (user)
7+
Requirement type: FUNCTIONAL
8+
Layer: System (backend logic)
9+
---
10+
11+
<!-- Original reference: SWR-TSSDK-2.4 -->
12+
13+
System shall provide version identification, change history, input requirements, and output specifications for each retrieved version.

0 commit comments

Comments
 (0)