qfai 1.5.0 → 1.5.1
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 +1 -1
- package/assets/init/.qfai/assistant/skills/qfai-discussion/SKILL.md +9 -3
- package/assets/init/.qfai/assistant/skills/qfai-discussion/templates/02_Inception-Deck.md +6 -0
- package/assets/init/.qfai/assistant/skills/qfai-discussion/templates/03_Story-Workshop.md +23 -0
- package/assets/init/.qfai/assistant/skills/qfai-discussion/templates/11_OQ-Register.md +4 -4
- package/assets/init/.qfai/assistant/skills/qfai-discussion/templates/13_Deferred.md +3 -3
- package/assets/init/.qfai/assistant/skills/qfai-discussion/templates/14_Review-Request.md +6 -0
- package/assets/init/.qfai/assistant/skills/qfai-discussion/templates/review/Rxx_reviewer.md +2 -0
- package/assets/init/.qfai/assistant/skills/qfai-discussion/templates/review/review_request.md +6 -0
- package/assets/init/.qfai/specs/README.md +3 -3
- package/dist/cli/index.cjs +170 -346
- package/dist/cli/index.cjs.map +1 -1
- package/dist/cli/index.mjs +174 -350
- package/dist/cli/index.mjs.map +1 -1
- package/dist/index.cjs +145 -323
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +149 -327
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -246,7 +246,7 @@ flowchart LR
|
|
|
246
246
|
- Contracts SSOT: `.qfai/contracts/**`
|
|
247
247
|
- Report outputs (`.qfai/report/**`) are derived artifacts and not SSOT.
|
|
248
248
|
|
|
249
|
-
## Minimal tutorial (v1.5.
|
|
249
|
+
## Minimal tutorial (v1.5.1)
|
|
250
250
|
|
|
251
251
|
1. `npx qfai init`
|
|
252
252
|
2. Run `/qfai-discussion` to structure scope, open questions, and produce a discussion pack under `.qfai/discussion/discussion-<ts>/`.
|
|
@@ -89,7 +89,9 @@ Every major artifact in this stage MUST include this table schema:
|
|
|
89
89
|
- `99_delta.md`
|
|
90
90
|
- Discussion completion requires `Disposition: open` count to be zero in `11_OQ-Register.md`.
|
|
91
91
|
- `deferred` is allowed only when required metadata is complete in `13_Deferred.md`.
|
|
92
|
+
- `02_Inception-Deck.md` MUST contain at least one Mermaid diagram in ` ```mermaid ` fences.
|
|
92
93
|
- `03_Story-Workshop.md` MUST contain at least one Mermaid diagram in ` ```mermaid ` fences.
|
|
94
|
+
- If UI requirements exist, include an HTML+CSS visual mock in `03_Story-Workshop.md`.
|
|
93
95
|
- Review roster is fixed by `.qfai/assistant/steering/review-roster.yml` and must be executed in full.
|
|
94
96
|
- RCP wording must be sourced from `.qfai/assistant/templates/rcp_footer.md`.
|
|
95
97
|
- Discussion artifacts are logs/rationale and must not duplicate spec SSOT.
|
|
@@ -133,8 +135,8 @@ Produce a unified 15-file discussion pack with explicit decisions, requirements,
|
|
|
133
135
|
## Required Process
|
|
134
136
|
|
|
135
137
|
1. Run the core interview for product concept, scope, stakeholders, and constraints (`01_Context.md`).
|
|
136
|
-
2. Run Inception Deck (10 questions) for ambiguity removal and project alignment (`02_Inception-Deck.md`).
|
|
137
|
-
3. Run Story Workshop to capture user stories, user flows, and at least one Mermaid diagram (`03_Story-Workshop.md`).
|
|
138
|
+
2. Run Inception Deck (10 questions) for ambiguity removal and project alignment, and include at least one Mermaid diagram (`02_Inception-Deck.md`).
|
|
139
|
+
3. Run Story Workshop to capture user stories, user flows, and at least one Mermaid diagram; add HTML+CSS screen mock when UI requirements exist (`03_Story-Workshop.md`).
|
|
138
140
|
4. Register source traceability in `04_Sources.md` with stable `SRC-XXXX` identifiers.
|
|
139
141
|
5. Define scope boundaries and success criteria in `05_Scope.md`.
|
|
140
142
|
6. Capture functional requirements in `06_REQ.md` with `REQ-0001` format.
|
|
@@ -172,7 +174,7 @@ Rules:
|
|
|
172
174
|
|
|
173
175
|
- `OQ-ID` (`OQ-0001` format)
|
|
174
176
|
- `Title`
|
|
175
|
-
- `Gate` (`
|
|
177
|
+
- `Gate` (`discussion|sdd|atdd|tdd|ops`)
|
|
176
178
|
- `Disposition` (`open|resolved|deferred|rejected`)
|
|
177
179
|
- `Owner` (`user|agent|team`)
|
|
178
180
|
- `Rationale` (required for deferred/rejected)
|
|
@@ -250,8 +252,10 @@ Before declaring completion, you MUST:
|
|
|
250
252
|
- verify all 15 mandatory output files exist and are populated;
|
|
251
253
|
- ensure `Disposition: open` count is zero in `11_OQ-Register.md`;
|
|
252
254
|
- ensure every deferred item has full metadata in `13_Deferred.md`;
|
|
255
|
+
- ensure `02_Inception-Deck.md` includes at least one Mermaid diagram;
|
|
253
256
|
- ensure `Example Seeds` sections are present and perspective coverage is explicit in `03_Story-Workshop.md`;
|
|
254
257
|
- ensure `03_Story-Workshop.md` includes at least one Mermaid diagram;
|
|
258
|
+
- ensure UI-related stories include an HTML+CSS screen mock section in `03_Story-Workshop.md`;
|
|
255
259
|
- avoid duplicating finalized spec content in discussion outputs.
|
|
256
260
|
|
|
257
261
|
## Evidence (MANDATORY)
|
|
@@ -291,7 +295,9 @@ When done, report:
|
|
|
291
295
|
- [ ] Deferred table fields follow the mandatory data model (all 11 columns present).
|
|
292
296
|
- [ ] `Disposition: open` count is zero at completion.
|
|
293
297
|
- [ ] Deferred items include required metadata.
|
|
298
|
+
- [ ] `02_Inception-Deck.md` includes at least one Mermaid diagram.
|
|
294
299
|
- [ ] `03_Story-Workshop.md` includes at least one Mermaid diagram.
|
|
300
|
+
- [ ] UI-related stories include HTML+CSS screen mock details in `03_Story-Workshop.md`.
|
|
295
301
|
- [ ] Mermaid fence rules were satisfied when diagrams were used.
|
|
296
302
|
- [ ] Evidence file exists and includes Work Orders Summary + Reviewer result.
|
|
297
303
|
- [ ] Reviewer returned `PASS`.
|
|
@@ -37,6 +37,12 @@
|
|
|
37
37
|
- High-level architecture:
|
|
38
38
|
- Key components:
|
|
39
39
|
|
|
40
|
+
```mermaid
|
|
41
|
+
flowchart LR
|
|
42
|
+
User["User"] --> App["App / Service"]
|
|
43
|
+
App --> Data["Data Store"]
|
|
44
|
+
```
|
|
45
|
+
|
|
40
46
|
## 7. What Keeps Us Up at Night (Risks)
|
|
41
47
|
|
|
42
48
|
| Risk | Probability | Impact | Mitigation |
|
|
@@ -42,3 +42,26 @@ flowchart TD
|
|
|
42
42
|
- Entry point:
|
|
43
43
|
- Steps:
|
|
44
44
|
- Exit point:
|
|
45
|
+
|
|
46
|
+
## Screen Mock (HTML+CSS)
|
|
47
|
+
|
|
48
|
+
- Use this section when UI requirements exist.
|
|
49
|
+
- Visual mock only; do not include JavaScript behavior.
|
|
50
|
+
|
|
51
|
+
```html
|
|
52
|
+
<section class="screen-mock">
|
|
53
|
+
<h1>Screen Title</h1>
|
|
54
|
+
<p>Primary information shown to the user.</p>
|
|
55
|
+
<button type="button">Primary Action</button>
|
|
56
|
+
</section>
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
```css
|
|
60
|
+
.screen-mock {
|
|
61
|
+
max-width: 560px;
|
|
62
|
+
margin: 24px auto;
|
|
63
|
+
padding: 20px;
|
|
64
|
+
border: 1px solid #d0d7de;
|
|
65
|
+
border-radius: 12px;
|
|
66
|
+
}
|
|
67
|
+
```
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
## OQ Table
|
|
4
4
|
|
|
5
|
-
| OQ-ID | Title | Gate
|
|
6
|
-
| ------- | ----- |
|
|
7
|
-
| OQ-0001 | TBD |
|
|
5
|
+
| OQ-ID | Title | Gate | Disposition | Owner | Rationale | Options | Recommendation | Next-Decision-Point | Due | Evidence |
|
|
6
|
+
| ------- | ----- | ---------- | ----------- | ----- | --------- | ------------------------------------ | -------------- | -------------------- | ---------- | ---------------- |
|
|
7
|
+
| OQ-0001 | TBD | discussion | deferred | user | TBD | Option A / Option B (recommended: A) | Option A | Trigger and due date | YYYY-MM-DD | Conversation log |
|
|
8
8
|
|
|
9
9
|
## Rules
|
|
10
10
|
|
|
11
|
-
- Allowed `Gate`: `
|
|
11
|
+
- Allowed `Gate`: `discussion`, `sdd`, `atdd`, `tdd`, `ops`.
|
|
12
12
|
- Allowed `Disposition`: `open`, `resolved`, `deferred`, `rejected`.
|
|
13
13
|
- Before discussion completion, `Disposition: open` must be zero.
|
|
14
14
|
- For `deferred` and `rejected`, `Rationale` is mandatory.
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Deferred Items
|
|
4
4
|
|
|
5
|
-
| OQ-ID | Title | Gate
|
|
6
|
-
| ------- | ----- |
|
|
7
|
-
| OQ-0001 | TBD |
|
|
5
|
+
| OQ-ID | Title | Gate | Deferred-Reason | Deferred-Until | Owner | Due | Severity | Impact | Mitigation | Evidence |
|
|
6
|
+
| ------- | ----- | ---------- | --------------- | -------------- | ----- | ---------- | -------- | ---------------------------------------------- | -------------------- | ---------------- |
|
|
7
|
+
| OQ-0001 | TBD | discussion | TBD | TBD | user | YYYY-MM-DD | medium | Impact on spec/tests/implementation/operations | Temporary workaround | Conversation log |
|
|
8
8
|
|
|
9
9
|
## Validation Rules
|
|
10
10
|
|
|
@@ -30,7 +30,13 @@
|
|
|
30
30
|
- Consistency with upstream/downstream artifacts
|
|
31
31
|
- Testability and acceptance clarity
|
|
32
32
|
- Operational and security risks
|
|
33
|
+
- Mermaid diagrams are sufficient for decision-making quality (not only presence)
|
|
34
|
+
- Scope boundary (in/out) is consistent across text/diagram/table
|
|
35
|
+
- Acceptance criteria are consistent with flows/state transitions
|
|
36
|
+
- Security/operations risks are reflected in diagrams where relevant
|
|
33
37
|
- Mermaid diagrams use ` ```mermaid ` fences only
|
|
38
|
+
- HTML+CSS screen mock is usable for UI alignment when UI requirements exist
|
|
39
|
+
- If UI requirements exist and no screen mock is provided, request changes
|
|
34
40
|
- OQ register exit condition (open count = 0)
|
|
35
41
|
- Deferred items have full metadata
|
|
36
42
|
|
|
@@ -11,7 +11,9 @@
|
|
|
11
11
|
- [ ] Traceability consistency
|
|
12
12
|
- [ ] Requirement and risk coverage
|
|
13
13
|
- [ ] Clarity and actionability
|
|
14
|
+
- [ ] Mermaid diagrams are sufficient for decisions (scope/AC/risk consistency)
|
|
14
15
|
- [ ] Mermaid diagrams use ` ```mermaid ` fences only
|
|
16
|
+
- [ ] HTML+CSS screen mock exists when UI requirements are present
|
|
15
17
|
- [ ] OQ register exit condition (open count = 0)
|
|
16
18
|
- [ ] Deferred items have full metadata
|
|
17
19
|
|
package/assets/init/.qfai/assistant/skills/qfai-discussion/templates/review/review_request.md
CHANGED
|
@@ -17,7 +17,13 @@
|
|
|
17
17
|
- Consistency with upstream/downstream artifacts
|
|
18
18
|
- Testability and acceptance clarity
|
|
19
19
|
- Operational and security risks
|
|
20
|
+
- Mermaid diagrams are sufficient for decision-making quality (not only presence)
|
|
21
|
+
- Scope boundary (in/out) is consistent across text/diagram/table
|
|
22
|
+
- Acceptance criteria are consistent with flows/state transitions
|
|
23
|
+
- Security/operations risks are reflected in diagrams where relevant
|
|
20
24
|
- Mermaid diagrams use ` ```mermaid ` fences only (no ` ```text ` or language-less fences)
|
|
25
|
+
- HTML+CSS screen mock is usable for UI alignment when UI requirements exist
|
|
26
|
+
- If UI requirements exist and no screen mock is provided, request changes
|
|
21
27
|
- OQ register exit condition (open count = 0)
|
|
22
28
|
- Deferred items have full metadata in `13_Deferred.md`
|
|
23
29
|
- Validate hard gate evidence exists (`.qfai/report/validate.log`).
|
|
@@ -63,13 +63,13 @@ Each `spec-XXXX/` must satisfy:
|
|
|
63
63
|
|
|
64
64
|
- `specs/` is definition-only. Keep operational status as run logs under `.qfai/report/run-*/`.
|
|
65
65
|
- Do not keep state markers like `release_candidate`, `Status`, `Progress`, or runtime `Risk` sections in spec files.
|
|
66
|
-
- `/qfai-sdd` requires a complete `
|
|
67
|
-
- Blocking OQ in `
|
|
66
|
+
- `/qfai-sdd` requires a complete `discussion/discussion-*/` pack and stops if it is missing or incomplete.
|
|
67
|
+
- Blocking OQ in `discussion-*/11_OQ-Register.md` (`Disposition: open`) must be resolved before SDD proceeds.
|
|
68
68
|
- Preflight writes `.qfai/report/preflight_summary.md` before spec generation to record selected inputs and open gaps.
|
|
69
69
|
- `_shared/04_Business-Flow.md` must include at least one ` ```mermaid ` block and at least one `flowchart` or `sequenceDiagram`.
|
|
70
70
|
- Business Flow must be documented in `_shared/04_Business-Flow.md` (Markdown). Legacy `*Business-flow*.feature` is deprecated.
|
|
71
71
|
- Gherkin is documented in `spec-XXXX/03_Acceptance-Criteria.md`.
|
|
72
|
-
- If diagrams are written in
|
|
72
|
+
- If diagrams are written in discussion/spec/evidence artifacts, use ` ```mermaid ` fences only (do not use ` ```text ` or language-less fences).
|
|
73
73
|
- Delta file accepts `09_delta.md` or any `*_delta.md`.
|
|
74
74
|
- `07_Decisions.md` / `08_Open-questions.md` and `_shared/08_Decisions.md` / `_shared/09_Open-questions.md` / `_shared/10_delta.md` are required even when empty.
|
|
75
75
|
- When empty, explicitly write `0 items` (or equivalent wording) in each file.
|