ton/ASG_Framework
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

update

Browse Source
This commit is contained in:
narawat
2026-09-08 16:51:22 +07:00
parent 4ffe543487
commit 06b7f8b34a
2 changed files with 48 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ASG_Framework.md
+43 -23
View File
@@ -592,23 +592,6 @@ These rules serve as a binary decision framework:
- [ ] **NFR-XXX**: [Verifiable acceptance condition] - [ ] **NFR-XXX**: [Verifiable acceptance condition]
- *Example: [ ] FR-001: Sommpanion landing page renders with all required elements* - *Example: [ ] FR-001: Sommpanion landing page renders with all required elements*
## 6. Requirements Traceability Matrix
| Requirement ID | WT ID | SP ID | UI ID | IMP ID | Description | Implementation File | Test File |
|----------------|-------|-------|-------|--------|-------------|---------------------|-----------|
| FR-XXX | WT-XXX | SP-XXX | UI-XXX | IMP-XXX | [Brief description] | `path/to/file.ext` | `tests/file.spec.js` |
| NFR-XXX | WT-XXX | SP-XXX | UI-XXX | IMP-XXX | [Brief description] | `path/to/file.ext` | `tests/file.spec.js` |
**Notes**:
- Functional Requirements (FR) define what the system shall do
- Non-Functional Requirements (NFR) define system qualities (performance, availability, security, etc.)
- **WT-XXX** IDs link requirements to walkthrough journey steps in `3-walkthrough.md`
- **SP-XXX** IDs are assigned to each specification item in `4-specification.md` for downstream traceability (Validation, Implementation Plan)
- **UI-XXX** IDs are assigned to each UI artifact in `5-ui_specification.md` for downstream traceability (Validation, Implementation Plan)
- **IMP-XXX** IDs are assigned to each implementation task in `7-implementation-plan.md` for downstream mapping to validation tests
- KPIs are measurable targets that validate whether requirements were met post-deployment
- Each requirement must include a clear requirement ID for traceability
- All acceptance conditions must be verifiable through testing or manual inspection
``` ```
### Solution Design Template ### Solution Design Template
@@ -732,17 +715,32 @@ components:
properties: properties:
data: data:
type: string type: string
x-requirement-id: FR-002 # Reference to Requirements document (WHAT) x-requirement-id: FR-002
x-solution-design-ref: SD-001.2 # Reference to Solution Design decision (HOW/WHY) x-solution-design-ref: SD-001.2
x-spec-id: SP-002 # Specification item ID for downstream traceability x-spec-id: SP-002
metadata:
type: object
properties:
timestamp:
type: string
format: date-time
x-requirement-id: FR-004
x-solution-design-ref: SD-001.3
x-spec-id: SP-004
Response: Response:
type: object type: object
properties: properties:
status: status:
type: string type: string
x-requirement-id: FR-003 # Reference to Requirements document (WHAT) x-requirement-id: FR-003
x-solution-design-ref: SD-001.1 # Reference to Solution Design decision (HOW/WHY) x-solution-design-ref: SD-001.1
x-spec-id: SP-003 # Specification item ID for downstream traceability x-spec-id: SP-003
record_count:
type: integer
minimum: 0
x-requirement-id: FR-005
x-solution-design-ref: SD-001.4
x-spec-id: SP-005
``` ```
### UI Specification Template ### UI Specification Template
@@ -834,6 +832,28 @@ components:
--- ---
## Appendix: Requirements Traceability Matrix
This matrix traces each requirement through all downstream artifacts. It is maintained as a living cross-reference document, not embedded inline in `1-requirements.md`.
| Requirement ID | WT ID | SP ID | UI ID | IMP ID | Description | Implementation File | Test File |
|----------------|-------|-------|-------|--------|-------------|---------------------|-----------|
| FR-XXX | WT-XXX | SP-XXX | UI-XXX | IMP-XXX | [Brief description] | `path/to/file.ext` | `tests/file.spec.js` |
| NFR-XXX | WT-XXX | SP-XXX | UI-XXX | IMP-XXX | [Brief description] | `path/to/file.ext` | `tests/file.spec.js` |
**Notes**:
- Functional Requirements (FR) define what the system shall do
- Non-Functional Requirements (NFR) define system qualities (performance, availability, security, etc.)
- **WT-XXX** IDs link requirements to walkthrough journey steps in `3-walkthrough.md`
- **SP-XXX** IDs are assigned to each specification item in `4-specification.md` for downstream traceability (Validation, Implementation Plan)
- **UI-XXX** IDs are assigned to each UI artifact in `5-ui_specification.md` for downstream traceability (Validation, Implementation Plan)
- **IMP-XXX** IDs are assigned to each implementation task in `7-implementation-plan.md` for downstream mapping to validation tests
- KPIs are measurable targets that validate whether requirements were met post-deployment
- Each requirement must include a clear requirement ID for traceability
- All acceptance conditions must be verifiable through testing or manual inspection
---
## Conclusion ## Conclusion
This ASG Documentation Framework ensures that documentation is: This ASG Documentation Framework ensures that documentation is:
etc.md
+5 -12
View File
@@ -1,15 +1,8 @@
8. Lines 11 & 27, 12 & 58 (Purpose) 1. Specification YAML template missing
me: it is ok as-is me: agreed. fix it
2. Requirements Traceability Matrix
me: remove Requirements's Traceability Matrix. it should be in an appendix.