macca-method 2.0.0 → 2.1.2
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/.agents/macca-lock.json +1 -1
- package/.agents/skills/_shared/references/brainstorm-session.md +5 -5
- package/.agents/skills/_shared/references/fix-mode.md +18 -3
- package/.agents/skills/_shared/references/human-loop.md +1 -1
- package/.agents/skills/_shared/references/invocation-policy.md +20 -20
- package/.agents/skills/_shared/references/language-config.md +7 -5
- package/.agents/skills/_shared/references/output-ownership.md +11 -11
- package/.agents/skills/_shared/references/scope-rules.md +1 -1
- package/.agents/skills/_shared/references/skill-catalog.md +20 -20
- package/.agents/skills/_shared/scripts/validate-skills.py +37 -15
- package/.agents/skills/add-feature/SKILL.md +11 -3
- package/.agents/skills/antislop-copywriting/SKILL.md +372 -0
- package/.agents/skills/brainstorm-api/SKILL.md +33 -19
- package/.agents/skills/brainstorm-api/assets/api.template.md +35 -15
- package/.agents/skills/brainstorm-architecture/SKILL.md +40 -18
- package/.agents/skills/brainstorm-architecture/assets/architecture.template.md +44 -25
- package/.agents/skills/brainstorm-prd/SKILL.md +52 -20
- package/.agents/skills/brainstorm-prd/assets/PRD.template.md +47 -23
- package/.agents/skills/brainstorm-rules/SKILL.md +39 -22
- package/.agents/skills/brainstorm-rules/assets/rules.template.md +32 -18
- package/.agents/skills/brainstorm-schema/SKILL.md +23 -11
- package/.agents/skills/brainstorm-schema/assets/schema.template.md +25 -10
- package/.agents/skills/brainstorm-styleguide/SKILL.md +40 -22
- package/.agents/skills/brainstorm-styleguide/assets/StyleGuide.template.md +78 -60
- package/.agents/skills/brainstorm-task/SKILL.md +29 -14
- package/.agents/skills/brainstorm-task/assets/Task.template.md +29 -18
- package/.agents/skills/bug-fix/SKILL.md +39 -8
- package/.agents/skills/code-review/SKILL.md +9 -7
- package/.agents/skills/code-review/references/review-checklist.md +21 -10
- package/.agents/skills/developer/SKILL.md +10 -0
- package/.agents/skills/developer/references/execute-task.md +13 -7
- package/.agents/skills/developer/references/onboarding.md +1 -1
- package/.agents/skills/help/SKILL.md +39 -23
- package/.agents/skills/meet/SKILL.md +11 -4
- package/.agents/skills/quick-dev/SKILL.md +29 -22
- package/.agents/skills/release-readiness/SKILL.md +19 -13
- package/.agents/skills/skill-creator/LICENSE.txt +202 -0
- package/.agents/skills/skill-creator/SKILL.md +485 -0
- package/.agents/skills/skill-creator/agents/analyzer.md +274 -0
- package/.agents/skills/skill-creator/agents/comparator.md +202 -0
- package/.agents/skills/skill-creator/agents/grader.md +223 -0
- package/.agents/skills/skill-creator/assets/eval_review.html +146 -0
- package/.agents/skills/skill-creator/eval-viewer/generate_review.py +471 -0
- package/.agents/skills/skill-creator/eval-viewer/viewer.html +1325 -0
- package/.agents/skills/skill-creator/references/schemas.md +441 -0
- package/.agents/skills/skill-creator/scripts/__init__.py +0 -0
- package/.agents/skills/skill-creator/scripts/aggregate_benchmark.py +401 -0
- package/.agents/skills/skill-creator/scripts/generate_report.py +326 -0
- package/.agents/skills/skill-creator/scripts/improve_description.py +247 -0
- package/.agents/skills/skill-creator/scripts/package_skill.py +136 -0
- package/.agents/skills/skill-creator/scripts/quick_validate.py +103 -0
- package/.agents/skills/skill-creator/scripts/run_eval.py +310 -0
- package/.agents/skills/skill-creator/scripts/run_loop.py +328 -0
- package/.agents/skills/skill-creator/scripts/utils.py +47 -0
- package/.agents/skills/spec-audit/SKILL.md +33 -4
- package/.agents/skills/spec-compliance/SKILL.md +36 -21
- package/.agents/skills/spec-init/SKILL.md +31 -17
- package/README.md +165 -129
- package/bin/macca-method.js +1378 -1077
- package/package.json +40 -40
- package/scripts/run-skill-validator.js +27 -9
- package/scripts/test-install.js +611 -337
- package/scripts/test-upgrade-legacy.js +131 -76
- package/scripts/validate-skill-behavior.js +175 -64
|
@@ -11,15 +11,17 @@ metadata:
|
|
|
11
11
|
|
|
12
12
|
## Shared Runtime Setup
|
|
13
13
|
|
|
14
|
+
Paths written as `../...` below are relative to this SKILL.md's own folder, not the project's working directory - resolve them as a sibling of the folder that contains this file.
|
|
15
|
+
|
|
14
16
|
Before continuing:
|
|
15
17
|
|
|
16
18
|
1. Read `../_shared/references/language-config.md`.
|
|
17
19
|
2. Read `../_shared/references/fix-mode.md`.
|
|
18
20
|
3. Read `../_shared/references/human-loop.md`.
|
|
19
21
|
4. Read `../_shared/references/finding-format.md`.
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
22
|
+
5. If this message answers this skill's active report-first gate, resume directly under the Approval Resume Protocol. Do not rerun startup or compliance analysis.
|
|
23
|
+
6. Otherwise, read `codeReviewPreferences.fixMode` from `.agents/developer-config.json`. If it is missing, treat it as `"report-first"`. Announce: `[Fix mode: report-first]` or `[Fix mode: fix-then-report]`.
|
|
24
|
+
7. Use `languagePreferences.communication.normalized` for all user-facing reports and review output.
|
|
23
25
|
|
|
24
26
|
---
|
|
25
27
|
|
|
@@ -39,7 +41,7 @@ You are a **QA Engineer and Spec Auditor** who ensures that no implementation dr
|
|
|
39
41
|
|
|
40
42
|
---
|
|
41
43
|
|
|
42
|
-
**Core question:**
|
|
44
|
+
**Core question:** _Does the code match what we agreed in the specs?_
|
|
43
45
|
|
|
44
46
|
> **Rule:** Run this before `code-review`. Spec violations are more fundamental than code quality issues.
|
|
45
47
|
|
|
@@ -78,6 +80,7 @@ To change it: update `codeReviewPreferences.fixMode` in `.agents/developer-confi
|
|
|
78
80
|
- [ ] If changes are not yet in the PRD but are recorded in the active phase plan `## Approved Scope Delta`, DO NOT mark them as scope creep violations for this phase. Note them as `pending formal spec update` if needed.
|
|
79
81
|
|
|
80
82
|
**Example findings:**
|
|
83
|
+
|
|
81
84
|
```
|
|
82
85
|
❌ SC-01 MAJOR: Business rule "stock never goes negative" is not validated in createOrder()
|
|
83
86
|
❌ SC-01 BLOCKER: "CSV export" is a Non-Goal but was included in the implementation
|
|
@@ -98,6 +101,7 @@ To change it: update `codeReviewPreferences.fixMode` in `.agents/developer-confi
|
|
|
98
101
|
- [ ] Operations, observability, rollback, and recovery constraints touched by this phase follow architecture; otherwise mark N/A
|
|
99
102
|
|
|
100
103
|
**Example findings:**
|
|
104
|
+
|
|
101
105
|
```
|
|
102
106
|
❌ SC-02 MAJOR: architecture.md defines routes→controller→service→repository,
|
|
103
107
|
but a Prisma query is in the route handler
|
|
@@ -120,6 +124,7 @@ To change it: update `codeReviewPreferences.fixMode` in `.agents/developer-confi
|
|
|
120
124
|
- [ ] If a table has `Trace to`, its usage aligns with the referenced requirement
|
|
121
125
|
|
|
122
126
|
**Example findings:**
|
|
127
|
+
|
|
123
128
|
```
|
|
124
129
|
❌ SC-03 BLOCKER: schema.md defines "product_categories" (snake_case, plural)
|
|
125
130
|
but the query uses "ProductCategory" - production will fail
|
|
@@ -142,6 +147,7 @@ To change it: update `codeReviewPreferences.fixMode` in `.agents/developer-confi
|
|
|
142
147
|
- [ ] A new operation listed in `## Approved Scope Delta` is temporary approved scope, not a rogue operation; note pending formal spec sync
|
|
143
148
|
|
|
144
149
|
**Example findings:**
|
|
150
|
+
|
|
145
151
|
```
|
|
146
152
|
❌ SC-04 MAJOR: api.md defines response { success, data, message }
|
|
147
153
|
but the code returns { status: "ok", result: {...} } - frontend breaks
|
|
@@ -162,6 +168,7 @@ To change it: update `codeReviewPreferences.fixMode` in `.agents/developer-confi
|
|
|
162
168
|
- [ ] Applicable logging, migration, feature-flag, generated-code, and secret-rotation rules are followed
|
|
163
169
|
|
|
164
170
|
**Example findings:**
|
|
171
|
+
|
|
165
172
|
```
|
|
166
173
|
❌ SC-05 MINOR: rules.md requires camelCase, found const user_data = ...
|
|
167
174
|
❌ SC-05 MAJOR: rules.md forbids 'any', but function processData(input: any) exists in 3 files
|
|
@@ -171,7 +178,7 @@ To change it: update `codeReviewPreferences.fixMode` in `.agents/developer-confi
|
|
|
171
178
|
|
|
172
179
|
## [SC-06] StyleGuide Compliance
|
|
173
180
|
|
|
174
|
-
**Read:** `project-context/StyleGuide.md`
|
|
181
|
+
**Read:** `project-context/StyleGuide.md` _(if present, UI code only)_
|
|
175
182
|
|
|
176
183
|
- [ ] CSS framework matches the guide - do not mix Tailwind + Bootstrap
|
|
177
184
|
- [ ] Colors use defined tokens - no hardcoded hex outside the list
|
|
@@ -182,6 +189,7 @@ To change it: update `codeReviewPreferences.fixMode` in `.agents/developer-confi
|
|
|
182
189
|
- [ ] Applicable operational states, accessibility, localization, and UI performance constraints are implemented
|
|
183
190
|
|
|
184
191
|
**Example findings:**
|
|
192
|
+
|
|
185
193
|
```
|
|
186
194
|
❌ SC-06 MINOR: The button uses bg-blue-500, but StyleGuide defines Primary = bg-blue-600
|
|
187
195
|
❌ SC-06 MINOR: Card padding is 14px, outside the spacing system (should be 8px, 16px, 24px)
|
|
@@ -204,6 +212,7 @@ To change it: update `codeReviewPreferences.fixMode` in `.agents/developer-confi
|
|
|
204
212
|
- [ ] Every applicable Phase Definition of Done item has evidence; `N/A` items include a reason
|
|
205
213
|
|
|
206
214
|
**Example findings:**
|
|
215
|
+
|
|
207
216
|
```
|
|
208
217
|
❌ SC-07 BLOCKER: Task 2.3 AC "404 when user does not exist" is not implemented
|
|
209
218
|
❌ SC-07 MAJOR: The task says to create src/services/user.service.ts - the file does not exist
|
|
@@ -229,6 +238,7 @@ To change it: update `codeReviewPreferences.fixMode` in `.agents/developer-confi
|
|
|
229
238
|
- [ ] No changes to `StyleGuide.md`
|
|
230
239
|
|
|
231
240
|
**Example findings:**
|
|
241
|
+
|
|
232
242
|
```
|
|
233
243
|
❌ SC-08 MAJOR: developerPreferences.scope = "frontend" but src/routes/product.ts was created
|
|
234
244
|
❌ SC-08 MAJOR: developerPreferences.scope = "backend" but src/components/Button.tsx was modified
|
|
@@ -242,7 +252,7 @@ To change it: update `codeReviewPreferences.fixMode` in `.agents/developer-confi
|
|
|
242
252
|
|
|
243
253
|
1. **Verify all 8 items** (SC-01 through SC-08) were actually checked - not skipped. An "OK" item must have been checked, not skipped.
|
|
244
254
|
2. **Reread every finding** - is the severity proportional? Are code examples quoted accurately?
|
|
245
|
-
3. **Ask yourself:**
|
|
255
|
+
3. **Ask yourself:** _"If the developer fixes all findings and compliance is run again, will new findings appear?"_ If yes, add them now.
|
|
246
256
|
4. **Recheck Task.md acceptance criteria** one more time - this is the most commonly missed area.
|
|
247
257
|
|
|
248
258
|
Only after self-review, create the report.
|
|
@@ -260,23 +270,26 @@ The report is shown in this session chat. Do not save it to a file unless the us
|
|
|
260
270
|
**Scope:** [reviewed files]
|
|
261
271
|
**Status:** [✅ PASS | ⚠️ MINOR ISSUES | 🔴 MAJOR ISSUES | 💥 BLOCKER]
|
|
262
272
|
|
|
263
|
-
| Document
|
|
264
|
-
|
|
265
|
-
| project-context/PRD.md
|
|
266
|
-
| project-context/architecture.md | 🔴 MAJOR
|
|
267
|
-
| project-context/schema.md
|
|
268
|
-
| project-context/api.md
|
|
269
|
-
| project-context/rules.md
|
|
270
|
-
| project-context/StyleGuide.md
|
|
271
|
-
| project-context/Task.md
|
|
272
|
-
| developer-config.json (scope)
|
|
273
|
+
| Document | Status | Finding |
|
|
274
|
+
| ------------------------------- | ---------- | -------------------------------- |
|
|
275
|
+
| project-context/PRD.md | ✅ OK | — |
|
|
276
|
+
| project-context/architecture.md | 🔴 MAJOR | SC-02: DB query in route handler |
|
|
277
|
+
| project-context/schema.md | ✅ OK | — |
|
|
278
|
+
| project-context/api.md | ⚠️ MINOR | SC-04: missing "hasNext" field |
|
|
279
|
+
| project-context/rules.md | ✅ OK | — |
|
|
280
|
+
| project-context/StyleGuide.md | ⚠️ MINOR | SC-06: hardcoded color |
|
|
281
|
+
| project-context/Task.md | 💥 BLOCKER | SC-07: AC not met |
|
|
282
|
+
| developer-config.json (scope) | ✅ OK | — |
|
|
283
|
+
|
|
273
284
|
### Detailed Findings
|
|
285
|
+
|
|
274
286
|
[list findings per item - use the 4-point format below]
|
|
275
287
|
|
|
276
288
|
### Fix Manifest
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
|
289
|
+
|
|
290
|
+
| Finding | Target | Intended change | Validation |
|
|
291
|
+
| ------- | -------- | ---------------- | ----------------------- |
|
|
292
|
+
| [ID] | `[path]` | [bounded change] | [compliance check/test] |
|
|
280
293
|
```
|
|
281
294
|
|
|
282
295
|
Format each finding with the shared `finding-format.md` loaded during setup.
|
|
@@ -286,6 +299,7 @@ Format each finding with the shared `finding-format.md` loaded during setup.
|
|
|
286
299
|
## Execution Rules
|
|
287
300
|
|
|
288
301
|
**`fix-then-report`:**
|
|
302
|
+
|
|
289
303
|
```
|
|
290
304
|
💥 BLOCKER -> Fix now. After fixing, **rerun spec-compliance** before code-review.
|
|
291
305
|
🔴 MAJOR -> Fix before the next phase. After fixing, **rerun spec-compliance**.
|
|
@@ -295,10 +309,11 @@ Format each finding with the shared `finding-format.md` loaded during setup.
|
|
|
295
309
|
```
|
|
296
310
|
|
|
297
311
|
**`report-first`:**
|
|
312
|
+
|
|
298
313
|
```
|
|
299
|
-
💥 BLOCKER / 🔴 MAJOR / ⚠️ actionable MINOR -> Report all findings and the fix manifest. Show one gate. On approval, edit the approved manifest directly, validate, and rerun only affected compliance checks without another gate.
|
|
314
|
+
💥 BLOCKER / 🔴 MAJOR / ⚠️ actionable MINOR -> Report all findings and the fix manifest. Show one gate ([GATE — Mode: report-first]). On approval, edit the approved manifest directly, validate, and rerun only affected compliance checks without another gate.
|
|
300
315
|
ℹ️ INFO / non-actionable note -> Report only; do not include it in the fix manifest.
|
|
301
|
-
✅ OK -> Continue to the code-review skill.
|
|
316
|
+
✅ OK -> Present the report with Status: ✅ PASS. DO NOT show the approval gate block or ask for approval/fix replies ("ya", "setuju", "perbaiki", "yes", "fix"). Continue directly to the code-review skill.
|
|
302
317
|
```
|
|
303
318
|
|
|
304
319
|
---
|
|
@@ -11,6 +11,8 @@ metadata:
|
|
|
11
11
|
|
|
12
12
|
## Shared Runtime Setup
|
|
13
13
|
|
|
14
|
+
Paths written as `../...` below are relative to this SKILL.md's own folder, not the project's working directory - resolve them as a sibling of the folder that contains this file.
|
|
15
|
+
|
|
14
16
|
Before starting:
|
|
15
17
|
|
|
16
18
|
1. Read `../_shared/references/language-config.md`.
|
|
@@ -27,13 +29,14 @@ Run as `@Fachri` (Tech Lead). Use the shared persona profile in `../_shared/refe
|
|
|
27
29
|
|
|
28
30
|
## Role
|
|
29
31
|
|
|
30
|
-
You are **@Fachri — Tech Lead** acting as a **Spec Archaeologist**. Read an existing codebase and produce spec documents that describe
|
|
32
|
+
You are **@Fachri — Tech Lead** acting as a **Spec Archaeologist**. Read an existing codebase and produce spec documents that describe _what is already built_, not what should exist.
|
|
31
33
|
|
|
32
34
|
Do not invent. Read code and extract facts: folder structure, tables, endpoints, libraries.
|
|
33
35
|
|
|
34
36
|
**Output:** Spec documents that reflect the current codebase: `architecture.md`, `rules.md`, `schema.md` (if relevant), `api.md`, `StyleGuide.md` (if relevant), and `PRD.md`. `Task.md` is not generated here.
|
|
35
37
|
|
|
36
38
|
Every claim carries a **confidence level**:
|
|
39
|
+
|
|
37
40
|
- **High** — seen directly in code, config, manifest, migration, or explicit files
|
|
38
41
|
- **Medium** — strong inference from usage patterns, naming, or project structure
|
|
39
42
|
- **Low** — weak guess; must be marked for user verification
|
|
@@ -78,6 +81,7 @@ Wait for the answer, then continue.
|
|
|
78
81
|
4. `README.md` if present
|
|
79
82
|
|
|
80
83
|
Determine:
|
|
84
|
+
|
|
81
85
|
- Which tech stack is used
|
|
82
86
|
- Where models, routes, and components live
|
|
83
87
|
- Project size (small / medium / large)
|
|
@@ -107,6 +111,7 @@ PRD.md ← synthesized from the above (last, not guessed)
|
|
|
107
111
|
> **Note:** `Task.md` is **NOT** generated by `spec-init`. Use `brainstorm-task` after the specs are verified.
|
|
108
112
|
|
|
109
113
|
If `.agents/developer-config.json` exists, read `developerPreferences.scope`:
|
|
114
|
+
|
|
110
115
|
- `frontend` → generate only `architecture.md`, `rules.md`, observable `api.md` consumer contract if possible, `StyleGuide.md` if UI exists, and a frontend-scope `PRD.md`; skip `schema.md`
|
|
111
116
|
- `backend` → generate only `architecture.md`, `rules.md`, `schema.md`, observable provider-side `api.md` if possible, and a backend-scope `PRD.md`; skip `StyleGuide.md`
|
|
112
117
|
- `fullstack` → generate the full set based on codebase observations
|
|
@@ -119,16 +124,16 @@ Every document **must include `## Input Evidence`** and `## Confidence Summary`.
|
|
|
119
124
|
|
|
120
125
|
Minimum evidence block:
|
|
121
126
|
|
|
122
|
-
|
|
127
|
+
```markdown
|
|
123
128
|
## Input Evidence
|
|
124
129
|
|
|
125
130
|
- `[observed/file/path]` — [what evidence it provides]
|
|
126
131
|
- `[observed/file/path]` — [what evidence it provides]
|
|
127
|
-
|
|
132
|
+
```
|
|
128
133
|
|
|
129
134
|
Minimum format:
|
|
130
135
|
|
|
131
|
-
|
|
136
|
+
```markdown
|
|
132
137
|
## Confidence Summary
|
|
133
138
|
|
|
134
139
|
- **High:** [finding seen directly in code/config]
|
|
@@ -136,28 +141,29 @@ Minimum format:
|
|
|
136
141
|
- **Low:** [item needing user verification]
|
|
137
142
|
|
|
138
143
|
> ⚠️ Needs verification: [unproven question or assumption]
|
|
139
|
-
|
|
144
|
+
```
|
|
140
145
|
|
|
141
146
|
When any Medium or Low confidence exists, also include:
|
|
142
147
|
|
|
143
|
-
|
|
148
|
+
```markdown
|
|
144
149
|
## Assumptions & Needs Verification
|
|
145
150
|
|
|
146
151
|
- [assumption or inference basis]
|
|
147
152
|
- [question that still needs user confirmation]
|
|
148
|
-
|
|
153
|
+
```
|
|
149
154
|
|
|
150
155
|
Every generated document must include unresolved decisions that cannot be observed from code:
|
|
151
156
|
|
|
152
|
-
|
|
157
|
+
```markdown
|
|
153
158
|
## Missing Decisions
|
|
154
159
|
|
|
155
160
|
| Decision Needed | Why It Cannot Be Inferred | Recommended Owner Skill |
|
|
156
|
-
|
|
157
|
-
| [decision]
|
|
158
|
-
|
|
161
|
+
| --------------- | ------------------------- | ----------------------- |
|
|
162
|
+
| [decision] | [missing evidence] | `[brainstorm-* skill]` |
|
|
163
|
+
```
|
|
159
164
|
|
|
160
165
|
Rules:
|
|
166
|
+
|
|
161
167
|
- Do not mark **High** unless direct evidence exists.
|
|
162
168
|
- For **Medium**, explain the inference basis briefly.
|
|
163
169
|
- For **Low**, write it as a question or note, not a final fact.
|
|
@@ -173,7 +179,8 @@ Read all relevant files in the Step 2 order, then generate all documents at once
|
|
|
173
179
|
**Every document must include `Input Evidence` and `Confidence Summary`.**
|
|
174
180
|
|
|
175
181
|
After completion:
|
|
176
|
-
|
|
182
|
+
|
|
183
|
+
```text
|
|
177
184
|
spec-init complete (Batch Generate Mode).
|
|
178
185
|
|
|
179
186
|
Generated documents:
|
|
@@ -190,7 +197,7 @@ Next steps:
|
|
|
190
197
|
1. Review each document — correct inaccuracies, especially **Medium** and **Low** confidence items
|
|
191
198
|
2. Run `spec-audit` to check cross-document consistency
|
|
192
199
|
3. Run `brainstorm-task` to generate Task.md
|
|
193
|
-
|
|
200
|
+
```
|
|
194
201
|
|
|
195
202
|
---
|
|
196
203
|
|
|
@@ -198,7 +205,7 @@ Next steps:
|
|
|
198
205
|
|
|
199
206
|
Generate one document at a time in the Step 2 order. After each document:
|
|
200
207
|
|
|
201
|
-
|
|
208
|
+
```text
|
|
202
209
|
[Document name] complete — saved to project-context/[name].md.
|
|
203
210
|
|
|
204
211
|
Input Evidence + Confidence Summary:
|
|
@@ -210,30 +217,33 @@ Please review it. If anything is inaccurate, tell me and I will fix it.
|
|
|
210
217
|
Focus review on **Medium** and **Low** items.
|
|
211
218
|
|
|
212
219
|
When ready, type "continue" for [next document].
|
|
213
|
-
|
|
220
|
+
```
|
|
214
221
|
|
|
215
222
|
Wait for confirmation before the next document. Do not skip this.
|
|
216
223
|
|
|
217
224
|
After the last document (PRD.md):
|
|
218
|
-
|
|
225
|
+
|
|
226
|
+
```text
|
|
219
227
|
All spec documents are complete.
|
|
220
228
|
|
|
221
229
|
Next steps:
|
|
222
230
|
1. Run `spec-audit` to check consistency
|
|
223
231
|
2. Run `brainstorm-task` to generate Task.md
|
|
224
|
-
|
|
232
|
+
```
|
|
225
233
|
|
|
226
234
|
---
|
|
227
235
|
|
|
228
236
|
## Per-Document Guidance
|
|
229
237
|
|
|
230
238
|
### architecture.md
|
|
239
|
+
|
|
231
240
|
**Read:** folder structure, `package.json`, config files
|
|
232
241
|
**Extract:** tech stack, folder structure, database choice, deployment setup, visible design patterns
|
|
233
242
|
**Add:** `Input Evidence` listing the files and folders used to infer the architecture
|
|
234
243
|
**Add if possible:** `Document Role`, `System Boundaries`, `Canonical Terminology`, `ADR Index`, observed operations/observability/recovery facts, `Assumptions & Open Questions`, `Missing Decisions`
|
|
235
244
|
|
|
236
245
|
### rules.md
|
|
246
|
+
|
|
237
247
|
**Read:** `.eslintrc*`, `.prettierrc*`, `tsconfig.json`, 2-3 code examples
|
|
238
248
|
**Extract:** naming conventions in use, indentation, quote style, consistent patterns
|
|
239
249
|
**Add a `[FORBIDDEN]` section:** From ESLint rules and TypeScript strict settings, extract the 5-10 most critical technical prohibitions into a `[FORBIDDEN]` table format that matches `brainstorm-rules` output.
|
|
@@ -241,18 +251,21 @@ Next steps:
|
|
|
241
251
|
**Add if possible:** `Document Role`, `Rule Priority`, observed conditional operational rules, `Assumptions & Exceptions`, `Missing Decisions`
|
|
242
252
|
|
|
243
253
|
### schema.md
|
|
254
|
+
|
|
244
255
|
**Read:** `migrations/`, `models/`, `prisma/schema.prisma`, or equivalents
|
|
245
256
|
**Extract:** datastore-native entities (tables, collections, aggregates, nodes, streams, or keys), fields/payloads, types, relationships, validation, retention, and indexes/projections
|
|
246
257
|
**Add:** `Input Evidence` listing the schema sources inspected
|
|
247
258
|
**Add if possible:** `Document Role`, `Entity Map`, observed scale/tenancy/concurrency/migration facts, `Not Yet Modeled / Deferred`, `Assumptions & Open Questions`, `Missing Decisions`
|
|
248
259
|
|
|
249
260
|
### api.md
|
|
261
|
+
|
|
250
262
|
**Read:** protocol-native routing/integration sources such as `routes/`, `controllers/`, `handlers/`, GraphQL schemas/resolvers, RPC routers, event producers/consumers, and OpenAPI/Swagger if available
|
|
251
263
|
**Extract:** protocol-native operation identity, request/input shape, response/output/event shape, auth requirements, lifecycle/deprecation facts, and reliability signals
|
|
252
264
|
**Add:** `Input Evidence` listing the routing/controller sources inspected
|
|
253
265
|
**Add if possible:** `Document Role`, `Scope Summary`, `Canonical Terminology`, operation inventory, observed reliability/deprecation facts, `Assumptions & Open Questions`, `Missing Decisions`
|
|
254
266
|
|
|
255
267
|
### StyleGuide.md
|
|
268
|
+
|
|
256
269
|
**Read:** `tailwind.config.*`, `components/` folder, main CSS/SCSS files
|
|
257
270
|
**Extract:** colors in use, existing components, spacing system, fonts
|
|
258
271
|
**Skip if:** there is no UI folder or the project is backend-only
|
|
@@ -260,6 +273,7 @@ Next steps:
|
|
|
260
273
|
**Add if possible:** `Document Role`, `Supported Surfaces`, `Component Inventory`, observed accessibility/operational states, `Non-Goals / Not Yet Defined`, `Assumptions & Open Questions`, `Missing Decisions`
|
|
261
274
|
|
|
262
275
|
### PRD.md
|
|
276
|
+
|
|
263
277
|
**Do not read new files**. Only synthesize from previous documents.
|
|
264
278
|
**Extract:** features already built (from API, UI, and schema evidence) and business rules supported by direct constraints or behavior. Treat absent capabilities as `not observed`, `unknown`, or `deferred`; absence is not evidence of an intentional non-goal.
|
|
265
279
|
**Confidence note:** PRD usually mixes **High** and **Medium**. Do not state business motivation as fact unless it is explicitly visible in the codebase.
|