@comfanion/workflow 4.38.1-dev.15 → 4.38.1-dev.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
package/src/build-info.json
CHANGED
|
@@ -255,11 +255,22 @@ Brief prose section with:
|
|
|
255
255
|
- Each module gets its own FR table
|
|
256
256
|
- Example: "Order Management Module" → FR-ORD-001, FR-ORD-002
|
|
257
257
|
|
|
258
|
-
**Table format:**
|
|
258
|
+
**Table format (with traceability):**
|
|
259
259
|
|
|
260
|
-
| ID | Requirement | Priority |
|
|
261
|
-
|
|
262
|
-
| FR-001 | {{requirement}} | P0 |
|
|
260
|
+
| ID | Requirement | Priority | Module | Doc Section | Arch § | Epic | Status |
|
|
261
|
+
|----|-------------|----------|--------|-------------|--------|------|--------|
|
|
262
|
+
| FR-001 | {{requirement}} | P0 | {{module}} | → Unit: `{{name}}` | §{{N}} | → Epic: `{{file}}` | ⬜ |
|
|
263
|
+
|
|
264
|
+
**Column filling:**
|
|
265
|
+
- **@pm (you):** ID, Requirement, Priority, Module — filled when writing PRD
|
|
266
|
+
- **@architect:** Doc Section, Arch § — filled when creating architecture/unit docs
|
|
267
|
+
- **@pm:** Epic — filled when creating epics (`/epics`)
|
|
268
|
+
- **@dev:** Status — marked ✅ when done
|
|
269
|
+
|
|
270
|
+
**Doc Section format:**
|
|
271
|
+
- Use `→ Unit: Name`, `→ Module: Name`, `→ Service: Name`, etc.
|
|
272
|
+
- Examples: `→ Unit: Task`, `→ Module: Auth`, `→ Service: NotificationService`
|
|
273
|
+
- Leave blank initially, @architect fills later
|
|
263
274
|
|
|
264
275
|
With **Notes:** for business rules after each domain table.
|
|
265
276
|
|
|
@@ -272,10 +283,19 @@ FR-INV-001 # Inventory module
|
|
|
272
283
|
|
|
273
284
|
### 5. Non-Functional Requirements
|
|
274
285
|
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
286
|
+
**Table format (with traceability):**
|
|
287
|
+
|
|
288
|
+
| ID | Requirement | Priority | Module | Doc Section | Arch § | Status |
|
|
289
|
+
|----|-------------|----------|--------|-------------|--------|--------|
|
|
290
|
+
| NFR-001 | {{requirement}} | P0 | — | — | §{{N}} | ⬜ |
|
|
291
|
+
|
|
292
|
+
**Column filling:**
|
|
293
|
+
- **@pm (you):** ID, Requirement, Priority, Module (if specific)
|
|
294
|
+
- **@architect:** Doc Section (if specific), Arch §
|
|
295
|
+
- **@dev:** Status
|
|
296
|
+
|
|
297
|
+
**Optional details section:**
|
|
298
|
+
Add Performance/Security/Scalability subsections if NFRs need detailed explanation.
|
|
279
299
|
|
|
280
300
|
### 6. Critical Business Rules
|
|
281
301
|
|
|
@@ -117,18 +117,21 @@ TaskFlow is a B2B platform for managing distributed teams. The system handles ta
|
|
|
117
117
|
|
|
118
118
|
## Functional Requirements
|
|
119
119
|
|
|
120
|
+
> **Traceability:** Each FR tracks Module, Unit, Architecture section, Epic, and Status.
|
|
121
|
+
> **Maintained by:** @pm (Epic), @architect (Module/Unit/Arch §), @dev (Status).
|
|
122
|
+
|
|
120
123
|
### {{Domain_1}}
|
|
121
124
|
|
|
122
|
-
| ID | Requirement | Priority |
|
|
123
|
-
|
|
124
|
-
| FR-001 | {{requirement}} | P0 |
|
|
125
|
-
| FR-002 | {{requirement}} | P0 |
|
|
126
|
-
| FR-003 | {{requirement}} | P1 |
|
|
125
|
+
| ID | Requirement | Priority | Module | Doc Section | Arch § | Epic | Status |
|
|
126
|
+
|----|-------------|----------|--------|-------------|--------|------|--------|
|
|
127
|
+
| FR-001 | {{requirement}} | P0 | {{module}} | → Unit: `{{name}}` | §{{N}} | → Epic: `{{file}}` | ⬜ |
|
|
128
|
+
| FR-002 | {{requirement}} | P0 | {{module}} | → Module: `{{name}}` | §{{N}} | → Epic: `{{file}}` | ⬜ |
|
|
129
|
+
| FR-003 | {{requirement}} | P1 | {{module}} | → Service: `{{name}}` | §{{N}} | → Epic: `{{file}}` | ⬜ |
|
|
127
130
|
|
|
128
|
-
<!--
|
|
129
|
-
| FR-001 | User can create task with title, description, due date | P0 |
|
|
130
|
-
| FR-002 | User can assign task to team member | P0 |
|
|
131
|
-
| FR-003 | System sends notification on assignment | P1 |
|
|
131
|
+
<!-- Example:
|
|
132
|
+
| FR-001 | User can create task with title, description, due date | P0 | Task | → Unit: `Task` | §3.1 | → Epic: `epic-01-task-crud.md` | ✅ |
|
|
133
|
+
| FR-002 | User can assign task to team member | P0 | Task | → Unit: `Task` | §3.1 | → Epic: `epic-01-task-crud.md` | ⬜ |
|
|
134
|
+
| FR-003 | System sends notification on assignment | P1 | Notification | → Service: `NotificationService` | §3.3 | → Epic: `epic-03-notifications.md` | ⬜ |
|
|
132
135
|
-->
|
|
133
136
|
|
|
134
137
|
**Notes:**
|
|
@@ -136,24 +139,40 @@ TaskFlow is a B2B platform for managing distributed teams. The system handles ta
|
|
|
136
139
|
|
|
137
140
|
### {{Domain_2}}
|
|
138
141
|
|
|
139
|
-
| ID | Requirement | Priority |
|
|
140
|
-
|
|
141
|
-
| FR-010 | {{requirement}} | P0 |
|
|
142
|
+
| ID | Requirement | Priority | Module | Doc Section | Arch § | Epic | Status |
|
|
143
|
+
|----|-------------|----------|--------|-------------|--------|------|--------|
|
|
144
|
+
| FR-010 | {{requirement}} | P0 | {{module}} | → Unit: `{{name}}` | §{{N}} | → Epic: `{{file}}` | ⬜ |
|
|
142
145
|
|
|
143
146
|
---
|
|
144
147
|
|
|
145
148
|
## Non-Functional Requirements
|
|
146
149
|
|
|
150
|
+
> **Traceability:** NFRs also track Module (if specific), Architecture section, and Status.
|
|
151
|
+
|
|
152
|
+
| ID | Requirement | Priority | Module | Doc Section | Arch § | Status |
|
|
153
|
+
|----|-------------|----------|--------|-------------|--------|--------|
|
|
154
|
+
| NFR-001 | {{requirement}} | P0 | — | — | §{{N}} | ⬜ |
|
|
155
|
+
| NFR-002 | {{requirement}} | P0 | {{module}} | → Unit: `{{name}}` | §{{N}} | ⬜ |
|
|
156
|
+
|
|
157
|
+
<!-- Example:
|
|
158
|
+
| NFR-001 | API response time < 200ms (p95) | P0 | — | — | §5 Performance | ⬜ |
|
|
159
|
+
| NFR-002 | Task data encrypted at rest | P0 | Task | → Unit: `Task` | §4 Security | ⬜ |
|
|
160
|
+
-->
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## Non-Functional Requirements (Details)
|
|
165
|
+
|
|
166
|
+
> Optional: Add detailed notes for complex NFRs here.
|
|
167
|
+
|
|
147
168
|
### Performance
|
|
148
|
-
|
|
149
|
-
|--------|--------|
|
|
150
|
-
| {{metric}} | {{value}} |
|
|
169
|
+
- {{details_if_needed}}
|
|
151
170
|
|
|
152
171
|
### Security
|
|
153
|
-
- {{
|
|
172
|
+
- {{details_if_needed}}
|
|
154
173
|
|
|
155
174
|
### Scalability
|
|
156
|
-
- {{
|
|
175
|
+
- {{details_if_needed}}
|
|
157
176
|
|
|
158
177
|
---
|
|
159
178
|
|