project-iris 0.0.16 → 0.0.18
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/README.md +86 -15
- package/flows/aidlc/README.md +358 -214
- package/flows/aidlc/agents/README.md +154 -0
- package/flows/aidlc/agents/inception-agent.md +23 -12
- package/flows/aidlc/agents/master-agent.md +204 -24
- package/flows/aidlc/memory-bank.yaml +61 -10
- package/flows/aidlc/quick-start.md +7 -7
- package/flows/aidlc/skills/README.md +106 -0
- package/flows/aidlc/skills/construction/bolt-start.md +5 -1
- package/flows/aidlc/skills/construction/navigator.md +1 -1
- package/flows/aidlc/skills/inception/bolt-plan.md +3 -2
- package/flows/aidlc/skills/inception/context.md +2 -1
- package/flows/aidlc/skills/inception/intent-create.md +91 -2
- package/flows/aidlc/skills/inception/navigator.md +13 -8
- package/flows/aidlc/skills/inception/requirements.md +541 -95
- package/flows/aidlc/skills/inception/review.md +75 -11
- package/flows/aidlc/skills/inception/risks.md +541 -0
- package/flows/aidlc/skills/inception/story-create.md +2 -1
- package/flows/aidlc/skills/inception/units.md +2 -1
- package/flows/aidlc/skills/master/answer-question.md +1 -1
- package/flows/aidlc/skills/master/code-elevate.md +434 -0
- package/flows/aidlc/skills/master/explain-flow.md +6 -6
- package/flows/aidlc/skills/master/project-init.md +110 -12
- package/flows/aidlc/skills/operations/build.md +32 -4
- package/flows/aidlc/skills/operations/monitor.md +75 -14
- package/flows/aidlc/skills/operations/rollback.md +239 -0
- package/flows/aidlc/templates/README.md +128 -0
- package/flows/aidlc/templates/construction/bolt-template.md +5 -5
- package/flows/aidlc/templates/construction/bolt-types/ddd-construction-bolt/{ddd-02-technical-design-template.md → ddd-02-logical-design-template.md} +1 -1
- package/flows/aidlc/templates/construction/bolt-types/ddd-construction-bolt.md +123 -41
- package/flows/aidlc/templates/construction/bolt-types/simple-construction-bolt.md +6 -6
- package/flows/aidlc/templates/construction/construction-guide.md +244 -0
- package/flows/aidlc/templates/construction/construction-log-template.md +7 -6
- package/flows/aidlc/templates/construction/elevation-dynamic-model-template.md +265 -0
- package/flows/aidlc/templates/construction/elevation-static-model-template.md +204 -0
- package/flows/aidlc/templates/inception/prfaq-template.md +147 -0
- package/flows/aidlc/templates/inception/requirements-template.md +70 -5
- package/flows/aidlc/templates/inception/risks-template.md +214 -0
- package/flows/aidlc/templates/operations/deployment-unit-template.md +228 -0
- package/package.json +1 -1
- package/flows/aidlc/templates/inception/project/README.md +0 -55
- /package/flows/aidlc/templates/construction/bolt-types/ddd-construction-bolt/{ddd-01-domain-model-template.md → ddd-01-domain-design-template.md} +0 -0
|
@@ -4,26 +4,46 @@
|
|
|
4
4
|
|
|
5
5
|
## Mandatory Output Rules (READ FIRST)
|
|
6
6
|
|
|
7
|
+
### General Rules
|
|
7
8
|
- 🚫 **NEVER** use ASCII tables for options - they break at different terminal widths
|
|
8
9
|
- ✅ **ALWAYS** use numbered list format: `N - **Option**: Description`
|
|
9
10
|
- ✅ **ALWAYS** use status indicators: ✅ (done) ⏳ (current) [ ] (pending)
|
|
10
11
|
- ✅ **ALWAYS** show progress tracker at checkpoint moments
|
|
11
|
-
- ✅ **ALWAYS**
|
|
12
|
-
-
|
|
12
|
+
- ✅ **ALWAYS** ask clarifying questions BEFORE generating anything
|
|
13
|
+
- ✅ **ALWAYS** present FULL requirements at review (no summaries)
|
|
14
|
+
- 🛑 **STOP** at each checkpoint - wait for user response
|
|
15
|
+
|
|
16
|
+
### Functional Requirements Rules
|
|
17
|
+
- ✅ **ALWAYS** start with user/goal clarification before listing FRs
|
|
18
|
+
- ✅ **ALWAYS** include User Story format: "As a {user}, I want {action} so that {benefit}"
|
|
19
|
+
- ✅ **ALWAYS** include testable Acceptance Criteria (binary pass/fail)
|
|
20
|
+
- ✅ **ALWAYS** assign Priority (Must/Should/Could)
|
|
21
|
+
- ✅ **ALWAYS** identify dependencies between FRs
|
|
22
|
+
|
|
23
|
+
### Non-Functional Requirements Rules
|
|
24
|
+
- ✅ **ALWAYS** walk through ALL 5 NFR categories (Performance, Scalability, Security, Reliability, Compliance)
|
|
25
|
+
- ✅ **ALWAYS** ensure NFRs have measurable metrics (not vague)
|
|
26
|
+
- ✅ **ALWAYS** define SLOs for critical requirements
|
|
27
|
+
- ✅ **ALWAYS** document trade-offs when NFRs conflict
|
|
13
28
|
|
|
14
29
|
## Success Metrics
|
|
15
30
|
|
|
16
31
|
- ✅ Clarifying questions asked before generating
|
|
17
|
-
- ✅
|
|
18
|
-
- ✅
|
|
19
|
-
- ✅
|
|
32
|
+
- ✅ Each FR has: User Story, Acceptance Criteria, Priority, Dependencies
|
|
33
|
+
- ✅ All 5 NFR categories addressed
|
|
34
|
+
- ✅ Each NFR has: Category, Requirement, Metric, Target
|
|
35
|
+
- ✅ SLOs defined for critical requirements
|
|
36
|
+
- ✅ Trade-offs documented when requirements conflict
|
|
20
37
|
|
|
21
38
|
## Failure Modes
|
|
22
39
|
|
|
23
|
-
- ❌ Using ASCII table for checkpoints
|
|
24
40
|
- ❌ Generating requirements without asking questions first
|
|
25
|
-
- ❌
|
|
26
|
-
- ❌
|
|
41
|
+
- ❌ FRs without testable acceptance criteria
|
|
42
|
+
- ❌ FRs without user story format
|
|
43
|
+
- ❌ Vague NFRs without metrics (e.g., "must be fast", "must be secure")
|
|
44
|
+
- ❌ Skipping NFR categories without explicit user confirmation
|
|
45
|
+
- ❌ Summarizing at review instead of showing full details
|
|
46
|
+
- ❌ Not documenting trade-offs between conflicting requirements
|
|
27
47
|
|
|
28
48
|
---
|
|
29
49
|
|
|
@@ -41,18 +61,17 @@ Show at start of this skill:
|
|
|
41
61
|
|
|
42
62
|
---
|
|
43
63
|
|
|
44
|
-
## Checkpoints
|
|
64
|
+
## Checkpoints
|
|
45
65
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
| Checkpoint 2 | Requirements review | User approval |
|
|
66
|
+
- **Checkpoint 1**: Clarifying questions for Functional Requirements
|
|
67
|
+
- **Checkpoint 2**: NFR category discovery (5 categories)
|
|
68
|
+
- **Checkpoint 3**: Full requirements review and approval
|
|
50
69
|
|
|
51
70
|
---
|
|
52
71
|
|
|
53
72
|
## Goal
|
|
54
73
|
|
|
55
|
-
Elicit, analyze, and document functional and non-functional requirements through structured inquiry.
|
|
74
|
+
Elicit, analyze, and document functional and non-functional requirements through structured inquiry, following AI-DLC's comprehensive approach.
|
|
56
75
|
|
|
57
76
|
---
|
|
58
77
|
|
|
@@ -68,45 +87,334 @@ Elicit, analyze, and document functional and non-functional requirements through
|
|
|
68
87
|
|
|
69
88
|
## Process
|
|
70
89
|
|
|
71
|
-
### Step 1:
|
|
90
|
+
### Step 1: Functional Requirements Discovery
|
|
72
91
|
|
|
73
|
-
**Checkpoint 1**:
|
|
92
|
+
**Checkpoint 1**: Ask clarifying questions BEFORE generating anything.
|
|
93
|
+
|
|
94
|
+
```markdown
|
|
95
|
+
## Functional Requirements Discovery
|
|
74
96
|
|
|
75
|
-
```text
|
|
76
97
|
Before I generate requirements, I need to understand:
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
98
|
+
|
|
99
|
+
### Users & Goals
|
|
100
|
+
1. Who are the primary users of this feature?
|
|
101
|
+
2. What problem does this solve for them?
|
|
102
|
+
3. What key outcomes/success metrics matter?
|
|
103
|
+
|
|
104
|
+
### Scope & Boundaries
|
|
105
|
+
4. What are the main user flows/actions?
|
|
106
|
+
5. What is explicitly OUT of scope?
|
|
107
|
+
|
|
108
|
+
### Constraints
|
|
109
|
+
6. Any regulatory/compliance requirements?
|
|
110
|
+
7. Any technical constraints or dependencies?
|
|
111
|
+
8. Timeline or budget constraints?
|
|
112
|
+
|
|
113
|
+
### Concerns
|
|
114
|
+
9. What concerns you most about this feature?
|
|
115
|
+
10. Any known risks or unknowns?
|
|
116
|
+
|
|
117
|
+
Please answer these questions so I can generate accurate requirements.
|
|
82
118
|
```
|
|
83
119
|
|
|
84
120
|
**Wait for user response.**
|
|
85
121
|
|
|
86
122
|
---
|
|
87
123
|
|
|
88
|
-
### Step 2: Generate Requirements
|
|
124
|
+
### Step 2: Generate Functional Requirements
|
|
125
|
+
|
|
126
|
+
After user answers, generate FRs covering:
|
|
127
|
+
|
|
128
|
+
- **Core Functionality**: Main user flows from answers
|
|
129
|
+
- **Data Requirements**: What data is created, stored, retrieved
|
|
130
|
+
- **Integration Points**: External systems, APIs
|
|
131
|
+
- **Error Handling**: Edge cases, failure scenarios
|
|
132
|
+
- **Business Rules**: Validation, constraints
|
|
133
|
+
|
|
134
|
+
**Structure each FR as:**
|
|
135
|
+
|
|
136
|
+
```markdown
|
|
137
|
+
### FR-{N}: {Title}
|
|
138
|
+
- **User Story**: As a {user}, I want {action} so that {benefit}
|
|
139
|
+
- **Description**: {Detailed explanation of what the system must do}
|
|
140
|
+
- **Acceptance Criteria**:
|
|
141
|
+
- [ ] {Testable criterion 1 - binary pass/fail}
|
|
142
|
+
- [ ] {Testable criterion 2 - binary pass/fail}
|
|
143
|
+
- [ ] {Testable criterion 3 - binary pass/fail}
|
|
144
|
+
- **Priority**: Must/Should/Could
|
|
145
|
+
- **Dependencies**: {Other FRs, external systems, or "None"}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
### Step 3: NFR Category Discovery
|
|
151
|
+
|
|
152
|
+
**Checkpoint 2**: Walk through each NFR category with targeted questions.
|
|
153
|
+
|
|
154
|
+
Present each category one at a time:
|
|
155
|
+
|
|
156
|
+
#### Category 1: Performance
|
|
157
|
+
|
|
158
|
+
```markdown
|
|
159
|
+
## NFR Category 1/5: Performance
|
|
160
|
+
|
|
161
|
+
1. **Response Time**: What's acceptable for main operations?
|
|
162
|
+
- 1 - Fast (< 100ms) - Real-time feel
|
|
163
|
+
- 2 - Standard (< 500ms) - Typical web app
|
|
164
|
+
- 3 - Tolerant (< 2s) - Complex operations
|
|
165
|
+
- 4 - Specify custom target
|
|
166
|
+
|
|
167
|
+
2. **Throughput**: Expected request volume?
|
|
168
|
+
- Requests per second: ___
|
|
169
|
+
- Peak vs normal ratio: ___
|
|
170
|
+
|
|
171
|
+
3. **Latency-sensitive operations**: Any operations needing special attention?
|
|
172
|
+
|
|
173
|
+
Your answers (or 'skip' if not applicable):
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
**Wait for response, then continue to next category.**
|
|
177
|
+
|
|
178
|
+
#### Category 2: Scalability
|
|
179
|
+
|
|
180
|
+
```markdown
|
|
181
|
+
## NFR Category 2/5: Scalability
|
|
182
|
+
|
|
183
|
+
1. **Current Load**:
|
|
184
|
+
- Expected daily active users: ___
|
|
185
|
+
- Peak concurrent users: ___
|
|
186
|
+
- Data volume (records): ___
|
|
187
|
+
|
|
188
|
+
2. **Growth** (next 12 months):
|
|
189
|
+
- 1 - Low (< 2x growth)
|
|
190
|
+
- 2 - Medium (2-5x growth)
|
|
191
|
+
- 3 - High (5-10x growth)
|
|
192
|
+
- 4 - Hyper (> 10x growth)
|
|
193
|
+
|
|
194
|
+
3. **Scaling Strategy**:
|
|
195
|
+
- 1 - Horizontal (add instances)
|
|
196
|
+
- 2 - Vertical (larger instances)
|
|
197
|
+
- 3 - Auto-scaling (dynamic)
|
|
198
|
+
- 4 - Need recommendation
|
|
199
|
+
|
|
200
|
+
Your answers:
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
**Wait for response.**
|
|
204
|
+
|
|
205
|
+
#### Category 3: Security
|
|
206
|
+
|
|
207
|
+
```markdown
|
|
208
|
+
## NFR Category 3/5: Security
|
|
209
|
+
|
|
210
|
+
1. **Authentication**:
|
|
211
|
+
- 1 - OAuth 2.0 / OIDC (social/enterprise SSO)
|
|
212
|
+
- 2 - JWT (stateless tokens)
|
|
213
|
+
- 3 - Session-based (traditional)
|
|
214
|
+
- 4 - API Keys (service-to-service)
|
|
215
|
+
- 5 - None (public access)
|
|
216
|
+
- 6 - Inherit from project standards
|
|
217
|
+
|
|
218
|
+
2. **Authorization**:
|
|
219
|
+
- 1 - RBAC (role-based)
|
|
220
|
+
- 2 - ABAC (attribute-based)
|
|
221
|
+
- 3 - Simple (admin/user)
|
|
222
|
+
- 4 - None needed
|
|
223
|
+
|
|
224
|
+
3. **Data Sensitivity**:
|
|
225
|
+
- 1 - Public (no sensitive data)
|
|
226
|
+
- 2 - Internal (business data)
|
|
227
|
+
- 3 - Confidential (PII, financial)
|
|
228
|
+
- 4 - Regulated (HIPAA, PCI-DSS)
|
|
229
|
+
|
|
230
|
+
4. **Encryption**:
|
|
231
|
+
- At rest required? (yes/no)
|
|
232
|
+
- In transit required? (yes/no, default: yes)
|
|
233
|
+
|
|
234
|
+
Your answers:
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
**Wait for response.**
|
|
238
|
+
|
|
239
|
+
#### Category 4: Reliability
|
|
240
|
+
|
|
241
|
+
```markdown
|
|
242
|
+
## NFR Category 4/5: Reliability
|
|
243
|
+
|
|
244
|
+
1. **Availability Target**:
|
|
245
|
+
- 1 - 99.0% (~3.6 days downtime/year) - Internal tools
|
|
246
|
+
- 2 - 99.9% (~8.7 hours/year) - Standard apps
|
|
247
|
+
- 3 - 99.95% (~4.4 hours/year) - Business critical
|
|
248
|
+
- 4 - 99.99% (~52 min/year) - Mission critical
|
|
249
|
+
|
|
250
|
+
2. **Recovery**:
|
|
251
|
+
- RTO (time to recover): ___
|
|
252
|
+
- RPO (acceptable data loss): ___
|
|
253
|
+
|
|
254
|
+
3. **Failure Handling**:
|
|
255
|
+
- Graceful degradation needed? (yes/no)
|
|
256
|
+
- Which features can degrade?
|
|
257
|
+
|
|
258
|
+
4. **Backup**:
|
|
259
|
+
- Frequency: ___
|
|
260
|
+
- Retention period: ___
|
|
261
|
+
|
|
262
|
+
Your answers:
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
**Wait for response.**
|
|
266
|
+
|
|
267
|
+
#### Category 5: Compliance
|
|
268
|
+
|
|
269
|
+
```markdown
|
|
270
|
+
## NFR Category 5/5: Compliance
|
|
271
|
+
|
|
272
|
+
1. **Regulatory Requirements** (select all that apply):
|
|
273
|
+
- 1 - GDPR (EU data protection)
|
|
274
|
+
- 2 - HIPAA (healthcare - US)
|
|
275
|
+
- 3 - PCI-DSS (payment cards)
|
|
276
|
+
- 4 - SOC 2 (service controls)
|
|
277
|
+
- 5 - SOX (financial - US)
|
|
278
|
+
- 6 - None specific
|
|
279
|
+
- 7 - Other: ___
|
|
280
|
+
|
|
281
|
+
2. **Audit Requirements**:
|
|
282
|
+
- Audit logging needed? (yes/no)
|
|
283
|
+
- Log retention period: ___
|
|
284
|
+
- Immutable logs required? (yes/no)
|
|
285
|
+
|
|
286
|
+
3. **Data Residency**:
|
|
287
|
+
- Geographic restrictions? (yes/no)
|
|
288
|
+
- Allowed regions: ___
|
|
289
|
+
|
|
290
|
+
Your answers:
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
**Wait for response.**
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
### Step 4: Define SLOs
|
|
89
298
|
|
|
90
|
-
|
|
299
|
+
Based on NFR answers, define Service Level Objectives:
|
|
91
300
|
|
|
92
|
-
|
|
301
|
+
```markdown
|
|
302
|
+
## Service Level Objectives (SLOs)
|
|
303
|
+
|
|
304
|
+
Based on your requirements, here are the proposed SLOs:
|
|
93
305
|
|
|
94
|
-
|
|
95
|
-
-
|
|
96
|
-
-
|
|
97
|
-
-
|
|
306
|
+
### Availability SLO
|
|
307
|
+
- **Indicator**: % of successful requests (non-5xx)
|
|
308
|
+
- **Target**: {X}% over 30-day window
|
|
309
|
+
- **Error Budget**: {Y} minutes/month
|
|
98
310
|
|
|
99
|
-
|
|
311
|
+
### Latency SLO
|
|
312
|
+
- **Indicator**: Response time at p95
|
|
313
|
+
- **Target**: < {X}ms
|
|
314
|
+
- **Scope**: All API endpoints
|
|
100
315
|
|
|
101
|
-
|
|
102
|
-
-
|
|
103
|
-
-
|
|
104
|
-
-
|
|
105
|
-
|
|
316
|
+
### Error Rate SLO
|
|
317
|
+
- **Indicator**: % of failed requests
|
|
318
|
+
- **Target**: < {X}%
|
|
319
|
+
- **Window**: 24-hour rolling
|
|
320
|
+
|
|
321
|
+
Do these SLOs align with your expectations?
|
|
322
|
+
1 - **Yes**: Continue
|
|
323
|
+
2 - **Adjust**: Modify targets
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
---
|
|
327
|
+
|
|
328
|
+
### Step 5: Define Measurement Criteria (AI-DLC Requirement)
|
|
329
|
+
|
|
330
|
+
**Per AI-DLC specification, Measurement Criteria must trace to the business intent.**
|
|
331
|
+
|
|
332
|
+
Unlike technical SLOs, Measurement Criteria capture business-level success indicators.
|
|
333
|
+
|
|
334
|
+
```markdown
|
|
335
|
+
## Measurement Criteria
|
|
336
|
+
|
|
337
|
+
Measurement Criteria trace back to the business intent and help validate whether the feature delivers expected value.
|
|
338
|
+
|
|
339
|
+
### Business Outcome Metrics
|
|
340
|
+
|
|
341
|
+
1. **Primary Success Metric**: What single metric best indicates this feature is successful?
|
|
342
|
+
- Metric: ___
|
|
343
|
+
- Current baseline (if known): ___
|
|
344
|
+
- Target: ___
|
|
345
|
+
- Measurement method: ___
|
|
346
|
+
|
|
347
|
+
2. **User Adoption Metrics**:
|
|
348
|
+
- Expected active users: ___
|
|
349
|
+
- Feature usage frequency: ___
|
|
350
|
+
- Time to first value: ___
|
|
351
|
+
|
|
352
|
+
3. **Business Impact Metrics**:
|
|
353
|
+
- Revenue impact (if applicable): ___
|
|
354
|
+
- Cost reduction (if applicable): ___
|
|
355
|
+
- Efficiency gain (if applicable): ___
|
|
356
|
+
|
|
357
|
+
### Leading Indicators
|
|
358
|
+
What early signals will indicate we're on track?
|
|
359
|
+
- ___
|
|
360
|
+
- ___
|
|
361
|
+
|
|
362
|
+
### Lagging Indicators
|
|
363
|
+
What will confirm long-term success?
|
|
364
|
+
- ___
|
|
365
|
+
- ___
|
|
366
|
+
|
|
367
|
+
### Measurement Timeline
|
|
368
|
+
- **Week 1-2**: {Early indicators to monitor}
|
|
369
|
+
- **Month 1**: {Short-term success criteria}
|
|
370
|
+
- **Quarter 1**: {Long-term validation}
|
|
371
|
+
```
|
|
106
372
|
|
|
107
|
-
**
|
|
373
|
+
**Wait for user input on key metrics.**
|
|
108
374
|
|
|
109
|
-
|
|
375
|
+
**After receiving answers, document in requirements.md:**
|
|
376
|
+
|
|
377
|
+
```markdown
|
|
378
|
+
## Measurement Criteria
|
|
379
|
+
|
|
380
|
+
### Primary Success Metric
|
|
381
|
+
- **Metric**: {metric name}
|
|
382
|
+
- **Baseline**: {current state}
|
|
383
|
+
- **Target**: {goal}
|
|
384
|
+
- **Measurement**: {how to measure}
|
|
385
|
+
|
|
386
|
+
### Business Traceability
|
|
387
|
+
| Metric | Business Goal | FR/NFR Link |
|
|
388
|
+
|--------|---------------|-------------|
|
|
389
|
+
| {Metric 1} | {Which business goal it validates} | FR-1, FR-2 |
|
|
390
|
+
| {Metric 2} | {Which business goal it validates} | NFR-P1 |
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
---
|
|
394
|
+
|
|
395
|
+
### Step 6: Document Trade-offs
|
|
396
|
+
|
|
397
|
+
If requirements conflict, document trade-offs:
|
|
398
|
+
|
|
399
|
+
```markdown
|
|
400
|
+
## Requirements Trade-offs
|
|
401
|
+
|
|
402
|
+
I've identified these trade-offs in your requirements:
|
|
403
|
+
|
|
404
|
+
### Trade-off 1: {e.g., Performance vs Security}
|
|
405
|
+
- **Conflict**: {Description}
|
|
406
|
+
- **Options**:
|
|
407
|
+
1 - {Option A with implications}
|
|
408
|
+
2 - {Option B with implications}
|
|
409
|
+
- **Recommendation**: {Your recommendation}
|
|
410
|
+
- **Your decision**: ___
|
|
411
|
+
|
|
412
|
+
{Repeat for other trade-offs}
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
---
|
|
416
|
+
|
|
417
|
+
### Step 7: Document Requirements
|
|
110
418
|
|
|
111
419
|
1. **Read Path**: Check `schema.requirements` from `.iris/aidlc/memory-bank.yaml`
|
|
112
420
|
*(Default: `memory-bank/intents/{intent-name}/requirements.md`)*
|
|
@@ -117,63 +425,140 @@ After user answers, generate functional and non-functional requirements.
|
|
|
117
425
|
|
|
118
426
|
```markdown
|
|
119
427
|
## Functional Requirements
|
|
428
|
+
|
|
120
429
|
### FR-1: {Title}
|
|
430
|
+
- **User Story**: As a {user}, I want {action} so that {benefit}
|
|
121
431
|
- **Description**: {What the system must do}
|
|
122
|
-
- **Acceptance Criteria**:
|
|
432
|
+
- **Acceptance Criteria**:
|
|
433
|
+
- [ ] {Testable criterion 1}
|
|
434
|
+
- [ ] {Testable criterion 2}
|
|
123
435
|
- **Priority**: {Must/Should/Could}
|
|
436
|
+
- **Dependencies**: {Other FRs or "None"}
|
|
124
437
|
|
|
125
438
|
## Non-Functional Requirements
|
|
126
|
-
|
|
127
|
-
|
|
439
|
+
|
|
440
|
+
### Performance
|
|
441
|
+
- **NFR-P1**: Response time p95 < {X}ms
|
|
442
|
+
- **NFR-P2**: Throughput > {X} req/s
|
|
443
|
+
|
|
444
|
+
### Scalability
|
|
445
|
+
- **NFR-S1**: Support {X} concurrent users
|
|
446
|
+
|
|
447
|
+
### Security
|
|
448
|
+
- **NFR-SEC1**: {Authentication method}
|
|
449
|
+
- **NFR-SEC2**: {Authorization model}
|
|
450
|
+
|
|
451
|
+
### Reliability
|
|
452
|
+
- **NFR-R1**: {X}% availability
|
|
453
|
+
- **NFR-R2**: RTO < {X}, RPO < {Y}
|
|
454
|
+
|
|
455
|
+
### Compliance
|
|
456
|
+
- **NFR-C1**: {Regulatory requirements}
|
|
457
|
+
|
|
458
|
+
## SLOs
|
|
459
|
+
- **Availability**: {X}%
|
|
460
|
+
- **Latency (p95)**: < {X}ms
|
|
461
|
+
- **Error Rate**: < {X}%
|
|
462
|
+
|
|
463
|
+
## Measurement Criteria (AI-DLC Required)
|
|
464
|
+
|
|
465
|
+
### Primary Success Metric
|
|
466
|
+
- **Metric**: {metric name}
|
|
467
|
+
- **Baseline**: {current state}
|
|
468
|
+
- **Target**: {goal}
|
|
469
|
+
- **Measurement**: {how to measure}
|
|
470
|
+
|
|
471
|
+
### Business Traceability
|
|
472
|
+
| Metric | Business Goal | FR/NFR Link |
|
|
473
|
+
|--------|---------------|-------------|
|
|
474
|
+
| {Metric 1} | {Which business goal it validates} | FR-1, FR-2 |
|
|
475
|
+
|
|
476
|
+
## Trade-off Decisions
|
|
477
|
+
- {Trade-off 1}: Chose {option} because {reason}
|
|
128
478
|
```
|
|
129
479
|
|
|
130
480
|
4. **Validate Testability**:
|
|
131
481
|
- ❌ "Fast response" → ✅ "Response < 200ms p95"
|
|
132
482
|
- ❌ "Secure" → ✅ "OAuth 2.0 with MFA"
|
|
133
483
|
- ❌ "Scalable" → ✅ "Support 10K concurrent users"
|
|
484
|
+
- ❌ "User can manage data" → ✅ "User can create, read, update, delete records"
|
|
134
485
|
|
|
135
486
|
---
|
|
136
487
|
|
|
137
|
-
### Step
|
|
138
|
-
|
|
139
|
-
**Checkpoint 2**: Present FULL requirements for approval.
|
|
488
|
+
### Step 8: Requirements Review
|
|
140
489
|
|
|
141
|
-
**
|
|
490
|
+
**Checkpoint 3**: Present FULL requirements for approval.
|
|
142
491
|
|
|
143
|
-
**Show
|
|
492
|
+
**CRITICAL: Show complete details. Do NOT summarize.**
|
|
144
493
|
|
|
145
|
-
```
|
|
494
|
+
```markdown
|
|
146
495
|
### Inception Progress
|
|
147
496
|
- [x] Intent created
|
|
148
|
-
- [ ] Requirements gathered ← current (Checkpoint
|
|
149
|
-
- [ ] Artifacts reviewed
|
|
497
|
+
- [ ] Requirements gathered ← current (Checkpoint 3: approval)
|
|
498
|
+
- [ ] Artifacts reviewed
|
|
150
499
|
- [ ] Ready for Construction
|
|
151
|
-
```
|
|
152
500
|
|
|
153
|
-
|
|
501
|
+
---
|
|
154
502
|
|
|
155
|
-
|
|
156
|
-
### Requirements Review
|
|
503
|
+
## Complete Requirements Review
|
|
157
504
|
|
|
158
|
-
|
|
505
|
+
### Functional Requirements
|
|
159
506
|
|
|
160
|
-
|
|
507
|
+
#### FR-1: {Title}
|
|
508
|
+
- **User Story**: As a {user}, I want {action} so that {benefit}
|
|
161
509
|
- **Description**: {full description}
|
|
162
|
-
- **Acceptance Criteria**:
|
|
510
|
+
- **Acceptance Criteria**:
|
|
511
|
+
- [ ] {criterion 1}
|
|
512
|
+
- [ ] {criterion 2}
|
|
163
513
|
- **Priority**: {Must/Should/Could}
|
|
514
|
+
- **Dependencies**: {list or "None"}
|
|
164
515
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
516
|
+
{Continue for all FRs...}
|
|
517
|
+
|
|
518
|
+
---
|
|
519
|
+
|
|
520
|
+
### Non-Functional Requirements
|
|
521
|
+
|
|
522
|
+
#### Performance
|
|
523
|
+
- **NFR-P1**: Response time p95 < {X}ms
|
|
524
|
+
- **NFR-P2**: Throughput > {X} req/s
|
|
525
|
+
|
|
526
|
+
#### Scalability
|
|
527
|
+
- **NFR-S1**: Support {X} concurrent users
|
|
528
|
+
- **NFR-S2**: Scale to {X}x load within {Y} minutes
|
|
169
529
|
|
|
170
|
-
|
|
530
|
+
#### Security
|
|
531
|
+
- **NFR-SEC1**: {Authentication method}
|
|
532
|
+
- **NFR-SEC2**: {Authorization model}
|
|
533
|
+
- **NFR-SEC3**: Data encryption {details}
|
|
534
|
+
|
|
535
|
+
#### Reliability
|
|
536
|
+
- **NFR-R1**: {X}% availability
|
|
537
|
+
- **NFR-R2**: RTO < {X}, RPO < {Y}
|
|
538
|
+
|
|
539
|
+
#### Compliance
|
|
540
|
+
- **NFR-C1**: {Regulatory requirements}
|
|
541
|
+
- **NFR-C2**: Audit logs retained {X} days
|
|
542
|
+
|
|
543
|
+
---
|
|
544
|
+
|
|
545
|
+
### SLOs
|
|
546
|
+
- **Availability**: {X}%
|
|
547
|
+
- **Latency (p95)**: < {X}ms
|
|
548
|
+
- **Error Rate**: < {X}%
|
|
549
|
+
|
|
550
|
+
### Measurement Criteria (Business Traceability)
|
|
551
|
+
- **Primary Metric**: {metric} - Baseline: {X} → Target: {Y}
|
|
552
|
+
- **Business Goal Link**: {Which intent goal this validates}
|
|
553
|
+
|
|
554
|
+
### Trade-off Decisions
|
|
555
|
+
- {Trade-off 1}: Chose {option} because {reason}
|
|
171
556
|
|
|
172
557
|
---
|
|
173
558
|
|
|
174
559
|
Do these requirements capture your intent?
|
|
175
|
-
1 -
|
|
176
|
-
2 -
|
|
560
|
+
1 - **Approve**: Save and continue
|
|
561
|
+
2 - **Revise**: Request changes (specify what)
|
|
177
562
|
```
|
|
178
563
|
|
|
179
564
|
**Wait for user response.**
|
|
@@ -183,35 +568,50 @@ Do these requirements capture your intent?
|
|
|
183
568
|
## Output
|
|
184
569
|
|
|
185
570
|
```markdown
|
|
186
|
-
## Requirements
|
|
187
|
-
|
|
188
|
-
###
|
|
189
|
-
|
|
190
|
-
-
|
|
191
|
-
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
571
|
+
## Requirements Complete: {intent-name}
|
|
572
|
+
|
|
573
|
+
### Summary
|
|
574
|
+
- **Functional Requirements**: {N} defined
|
|
575
|
+
- **Non-Functional Requirements**: {N} across 5 categories
|
|
576
|
+
- **SLOs**: {N} defined
|
|
577
|
+
- **Measurement Criteria**: {N} business metrics defined
|
|
578
|
+
- **Trade-offs**: {N} documented
|
|
579
|
+
- **Technical Constraints**: {N} intent-specific
|
|
580
|
+
|
|
581
|
+
### FR Quality
|
|
582
|
+
- ✅ All FRs have User Story format
|
|
583
|
+
- ✅ All FRs have testable Acceptance Criteria
|
|
584
|
+
- ✅ All FRs have Priority assigned
|
|
585
|
+
- ✅ Dependencies mapped
|
|
586
|
+
|
|
587
|
+
### NFR Coverage
|
|
588
|
+
- ✅ Performance: {count} requirements
|
|
589
|
+
- ✅ Scalability: {count} requirements
|
|
590
|
+
- ✅ Security: {count} requirements
|
|
591
|
+
- ✅ Reliability: {count} requirements
|
|
592
|
+
- ✅ Compliance: {count} requirements
|
|
593
|
+
|
|
594
|
+
### Measurement Criteria (AI-DLC Required)
|
|
595
|
+
- ✅ Primary success metric defined with baseline and target
|
|
596
|
+
- ✅ Business traceability documented (metrics → goals → FRs)
|
|
597
|
+
- ✅ Measurement timeline established
|
|
197
598
|
|
|
198
599
|
### Technical Constraints
|
|
600
|
+
- **Standards**: Loaded by Construction Agent from `memory-bank/standards/`
|
|
601
|
+
- **Intent-Specific**: {constraints from Q7 not covered by standards, or "None"}
|
|
199
602
|
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
Intent-specific constraints:
|
|
203
|
-
- {any feature-specific constraint not in standards}
|
|
204
|
-
|
|
205
|
-
### Artifact Updated
|
|
603
|
+
### Artifact Created
|
|
206
604
|
- `{intent-path}/requirements.md`
|
|
207
605
|
|
|
208
606
|
### Actions
|
|
209
607
|
|
|
210
|
-
1 - **
|
|
211
|
-
2 - **
|
|
608
|
+
1 - **risks**: Define risk register for this intent
|
|
609
|
+
2 - **context**: Define system context and boundaries
|
|
610
|
+
3 - **auto-continue**: Batch-generate remaining artifacts
|
|
611
|
+
4 - **menu**: Return to inception menu
|
|
212
612
|
|
|
213
613
|
### Suggested Next Step
|
|
214
|
-
→ **
|
|
614
|
+
→ **risks** - Identify and document risks for `{intent-name}`
|
|
215
615
|
|
|
216
616
|
**Type a number or press Enter for suggested action.**
|
|
217
617
|
```
|
|
@@ -220,33 +620,79 @@ Intent-specific constraints:
|
|
|
220
620
|
|
|
221
621
|
## After Approval
|
|
222
622
|
|
|
223
|
-
Once requirements are approved at Checkpoint
|
|
623
|
+
Once requirements are approved at Checkpoint 3:
|
|
224
624
|
|
|
225
625
|
1. Save to `{intent}/requirements.md`
|
|
226
626
|
2. Update inception-log.md with artifact status
|
|
227
|
-
3.
|
|
627
|
+
3. Present transition options to user
|
|
228
628
|
|
|
229
629
|
---
|
|
230
630
|
|
|
231
631
|
## Transition
|
|
232
632
|
|
|
233
|
-
|
|
633
|
+
### Inception Phase Flow
|
|
634
|
+
|
|
635
|
+
After requirements approved, the Inception flow continues:
|
|
636
|
+
|
|
637
|
+
```text
|
|
638
|
+
Requirements ← YOU ARE HERE
|
|
639
|
+
↓
|
|
640
|
+
Risks (recommended) ─────────────┐
|
|
641
|
+
↓ │
|
|
642
|
+
Context ──────────────────────── │ ─→ Can batch-generate
|
|
643
|
+
↓ │ from here if
|
|
644
|
+
Units ───────────────────────────┤ requirements are
|
|
645
|
+
↓ │ comprehensive
|
|
646
|
+
Stories ─────────────────────────┤
|
|
647
|
+
↓ │
|
|
648
|
+
Bolt Plan ───────────────────────┘
|
|
649
|
+
↓
|
|
650
|
+
Review All Artifacts (Checkpoint 4)
|
|
651
|
+
↓
|
|
652
|
+
Ready for Construction
|
|
653
|
+
```
|
|
654
|
+
|
|
655
|
+
### Next Step Options
|
|
656
|
+
|
|
657
|
+
1 - **risks** (Recommended)
|
|
658
|
+
Define risk register before proceeding
|
|
659
|
+
→ `.iris/aidlc/skills/inception/risks.md`
|
|
660
|
+
Use if: Regulatory concerns, complex integrations, unknowns identified
|
|
661
|
+
|
|
662
|
+
2 - **context**
|
|
663
|
+
Define system boundaries and external actors
|
|
664
|
+
→ `.iris/aidlc/skills/inception/context.md`
|
|
665
|
+
Use if: Risks already covered in project standards
|
|
666
|
+
|
|
667
|
+
3 - **auto-continue**
|
|
668
|
+
Batch-generate Context → Units → Stories → Bolt Plan
|
|
669
|
+
→ Executes skills in sequence, reviews all at Checkpoint 4
|
|
670
|
+
Use if: Rapid iteration needed, will review all artifacts together
|
|
671
|
+
|
|
672
|
+
4 - **menu**
|
|
673
|
+
Return to Inception navigator
|
|
674
|
+
→ `.iris/aidlc/skills/inception/navigator.md`
|
|
675
|
+
Use if: Need to check status or switch intents
|
|
234
676
|
|
|
235
|
-
|
|
236
|
-
- Units
|
|
237
|
-
- Stories
|
|
238
|
-
- Bolt Plan
|
|
677
|
+
### Decision Criteria
|
|
239
678
|
|
|
240
|
-
|
|
679
|
+
- **Choose risks if**: Compliance requirements exist, external dependencies identified, concerns flagged in requirements discovery
|
|
680
|
+
- **Choose context if**: Simple feature with clear boundaries, risks already in project standards
|
|
681
|
+
- **Choose auto-continue if**: Comprehensive requirements captured, trust AI elaboration, will review carefully at Checkpoint 4
|
|
241
682
|
|
|
242
683
|
---
|
|
243
684
|
|
|
244
685
|
## Test Contract
|
|
245
686
|
|
|
246
687
|
```yaml
|
|
247
|
-
input: User answers to 5
|
|
248
|
-
output: requirements.md with
|
|
249
|
-
checkpoints:
|
|
250
|
-
- Checkpoint 1:
|
|
251
|
-
- Checkpoint 2:
|
|
688
|
+
input: User answers to FR questions + NFR category questions (5 categories) + Measurement Criteria questions
|
|
689
|
+
output: requirements.md with FRs (user stories, acceptance criteria), NFRs (5 categories), SLOs, Measurement Criteria (business traceability), trade-offs
|
|
690
|
+
checkpoints: 3
|
|
691
|
+
- Checkpoint 1: FR clarifying questions answered
|
|
692
|
+
- Checkpoint 2: All 5 NFR categories addressed
|
|
693
|
+
- Checkpoint 3: Full requirements approved (includes Measurement Criteria)
|
|
694
|
+
ai_dlc_alignment:
|
|
695
|
+
- Measurement Criteria traces to business intent (spec requirement)
|
|
696
|
+
- SLOs provide technical targets
|
|
697
|
+
- Trade-offs documented for complex decisions
|
|
252
698
|
```
|