Skip to content

Commit 3487783

Browse files
chore(docs): add requirements mds for existing and to be implemented functionalities
1 parent e9c385a commit 3487783

36 files changed

+190
-314
lines changed

docs/requirements/AGENT.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
When creating or editing requirement documents:
44

5-
1. **Use the template** at `docs/requirements/SWR-TEMPLATE.md`
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
68

79
2. **Set Requirement Type** using this mapping:
810

docs/requirements/AllRequirements.md

Lines changed: 0 additions & 149 deletions
This file was deleted.

docs/requirements/SHR-TSSDK-2.md renamed to docs/requirements/SHR-APP-DISCOVERY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
itemId: SHR-TSSDK-2
2+
itemId: SHR-APP-DISCOVERY
33
itemTitle: Application Discovery
44
itemType: Requirement
55
# Stakeholder requirement (user)
66
Requirement type: FUNCTIONAL
77
---
88

9-
<!-- Original reference: SHR: TSSDK-2 -->
9+
<!-- Original reference: SHR-TSSDK-2 -->
1010

1111
## Description
1212

docs/requirements/SHR-TSSDK-3.md renamed to docs/requirements/SHR-APP-EXEC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
itemId: SHR-TSSDK-3
2+
itemId: SHR-APP-EXEC
33
itemTitle: Application Execution Access
44
itemType: Requirement
55
# Stakeholder requirement (user)
66
Requirement type: FUNCTIONAL
77
---
88

9-
<!-- Original reference: SHR: TSSDK-3 -->
9+
<!-- Original reference: SHR-TSSDK-3 -->
1010

1111
## Description
1212

docs/requirements/SHR-TSSDK-5.md renamed to docs/requirements/SHR-APP-RESULTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
itemId: SHR-TSSDK-5
2+
itemId: SHR-APP-RESULTS
33
itemTitle: Application Results Access
44
itemType: Requirement
55
# Stakeholder requirement (user)
66
Requirement type: FUNCTIONAL
77
---
88

9-
<!-- Original reference: SHR: TSSDK-5 -->
9+
<!-- Original reference: SHR-TSSDK-5 -->
1010

1111
## Description
1212

docs/requirements/SHR-TSSDK-4.md renamed to docs/requirements/SHR-APP-RUN-MGMT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
itemId: SHR-TSSDK-4
2+
itemId: SHR-APP-RUN-MGMT
33
itemTitle: Application Run Management
44
itemType: Requirement
55
# Stakeholder requirement (user)
66
Requirement type: FUNCTIONAL
77
---
88

9-
<!-- Original reference: SHR: TSSDK-4 -->
9+
<!-- Original reference: SHR-TSSDK-4 -->
1010

1111
## Description
1212

docs/requirements/SHR-TSSDK-1.md renamed to docs/requirements/SHR-AUTH.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
itemId: SHR-TSSDK-1
2+
itemId: SHR-AUTH
33
itemTitle: Authenticated Platform Access
44
itemType: Requirement
55
# Stakeholder requirement (user)
66
Requirement type: SECURITY
77
---
88

9-
<!-- Original reference: SHR: TSSDK-1 -->
9+
<!-- Original reference: SHR-TSSDK-1 -->
1010

1111
## Description
1212

docs/requirements/SHR-TSSDK-6.md renamed to docs/requirements/SHR-ERROR-COMM.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
itemId: SHR-TSSDK-6
2+
itemId: SHR-ERROR-COMM
33
itemTitle: Error Communication
44
itemType: Requirement
55
# Stakeholder requirement (user)
66
Requirement type: FUNCTIONAL
77
---
88

9-
<!-- Original reference: SHR: TSSDK-6 -->
9+
<!-- Original reference: SHR-TSSDK-6 -->
1010

1111
## Description
1212

docs/requirements/SWR-TSSDK-2-2.md renamed to docs/requirements/SWR-APP-DISCOVERY-DETAILS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
itemId: SWR-TSSDK-2-2
2+
itemId: SWR-APP-DISCOVERY-DETAILS
33
itemTitle: Application Details
4-
itemHasParent: SHR-TSSDK-2
4+
itemHasParent: SHR-APP-DISCOVERY
55
itemType: Requirement
66
# Software requirement (user)
77
Requirement type: FUNCTIONAL

docs/requirements/SWR-TSSDK-2-1.md renamed to docs/requirements/SWR-APP-DISCOVERY-LIST.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
itemId: SWR-TSSDK-2-1
2+
itemId: SWR-APP-DISCOVERY-LIST
33
itemTitle: Application List Retrieval
4-
itemHasParent: SHR-TSSDK-2
4+
itemHasParent: SHR-APP-DISCOVERY
55
itemType: Requirement
66
# Software requirement (user)
77
Requirement type: FUNCTIONAL

0 commit comments

Comments
 (0)