From 06b7f8b34a9503cf98dab10bf1e1f98681bf47e2 Mon Sep 17 00:00:00 2001 From: narawat Date: Tue, 8 Sep 2026 16:51:22 +0700 Subject: [PATCH] update --- ASG_Framework.md | 66 +++++++++++++++++++++++++++++++----------------- etc.md | 17 ++++--------- 2 files changed, 48 insertions(+), 35 deletions(-) diff --git a/ASG_Framework.md b/ASG_Framework.md index dcdee18..bb9ea84 100644 --- a/ASG_Framework.md +++ b/ASG_Framework.md @@ -592,23 +592,6 @@ These rules serve as a binary decision framework: - [ ] **NFR-XXX**: [Verifiable acceptance condition] - *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 @@ -732,17 +715,32 @@ components: properties: data: type: string - x-requirement-id: FR-002 # Reference to Requirements document (WHAT) - x-solution-design-ref: SD-001.2 # Reference to Solution Design decision (HOW/WHY) - x-spec-id: SP-002 # Specification item ID for downstream traceability + x-requirement-id: FR-002 + x-solution-design-ref: SD-001.2 + 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: type: object properties: status: type: string - x-requirement-id: FR-003 # Reference to Requirements document (WHAT) - x-solution-design-ref: SD-001.1 # Reference to Solution Design decision (HOW/WHY) - x-spec-id: SP-003 # Specification item ID for downstream traceability + x-requirement-id: FR-003 + x-solution-design-ref: SD-001.1 + 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 @@ -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 This ASG Documentation Framework ensures that documentation is: diff --git a/etc.md b/etc.md index 3ef4ba5..2bb36c5 100644 --- a/etc.md +++ b/etc.md @@ -1,15 +1,8 @@ -8. Lines 11 & 27, 12 & 58 (Purpose) -me: it is ok as-is - - - - - - - - - - +1. Specification YAML template missing +me: agreed. fix it + +2. Requirements Traceability Matrix +me: remove Requirements's Traceability Matrix. it should be in an appendix.