macca-method 2.1.2 → 3.0.0-rc.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/.agents/macca-lock.json +2 -1
- package/.agents/macca-managed-skills.txt +1 -0
- package/.agents/skills/_shared/references/additional-skills.md +17 -1
- package/.agents/skills/_shared/references/brainstorm-session.md +61 -21
- package/.agents/skills/_shared/references/config-mutation.md +58 -18
- package/.agents/skills/_shared/references/fix-mode.md +21 -7
- package/.agents/skills/_shared/references/human-loop.md +2 -0
- package/.agents/skills/_shared/references/implementation-principles.md +4 -0
- package/.agents/skills/_shared/references/interaction-contract.md +33 -0
- package/.agents/skills/_shared/references/invocation-policy.md +14 -3
- package/.agents/skills/_shared/references/language-config.md +24 -4
- package/.agents/skills/_shared/references/output-ownership.md +12 -5
- package/.agents/skills/_shared/references/planning-principles.md +35 -0
- package/.agents/skills/_shared/references/scope-delta.md +21 -0
- package/.agents/skills/_shared/references/scope-rules.md +1 -1
- package/.agents/skills/_shared/references/skill-catalog.md +30 -13
- package/.agents/skills/_shared/references/workspace-safety.md +11 -0
- package/.agents/skills/_shared/scripts/config-file.js +132 -0
- package/.agents/skills/_shared/scripts/config-validator.js +164 -0
- package/.agents/skills/_shared/scripts/read-preferences.js +128 -0
- package/.agents/skills/add-feature/SKILL.md +24 -18
- package/.agents/skills/brainstorm-api/SKILL.md +24 -23
- package/.agents/skills/brainstorm-api/assets/api.template.md +11 -23
- package/.agents/skills/brainstorm-architecture/SKILL.md +41 -48
- package/.agents/skills/brainstorm-architecture/assets/architecture.template.md +24 -16
- package/.agents/skills/brainstorm-prd/SKILL.md +26 -28
- package/.agents/skills/brainstorm-prd/assets/PRD.template.md +10 -9
- package/.agents/skills/brainstorm-rules/SKILL.md +42 -46
- package/.agents/skills/brainstorm-rules/assets/rules.template.md +8 -8
- package/.agents/skills/brainstorm-schema/SKILL.md +17 -17
- package/.agents/skills/brainstorm-schema/assets/schema.template.md +9 -8
- package/.agents/skills/brainstorm-styleguide/SKILL.md +27 -26
- package/.agents/skills/brainstorm-styleguide/assets/StyleGuide.template.md +27 -51
- package/.agents/skills/brainstorm-task/SKILL.md +53 -37
- package/.agents/skills/brainstorm-task/assets/Task.template.md +11 -12
- package/.agents/skills/bug-fix/SKILL.md +78 -175
- package/.agents/skills/bug-fix/assets/bug-log.template.md +61 -0
- package/.agents/skills/code-review/SKILL.md +14 -6
- package/.agents/skills/code-review/references/review-checklist.md +24 -44
- package/.agents/skills/developer/SKILL.md +23 -25
- package/.agents/skills/developer/references/close-phase.md +11 -6
- package/.agents/skills/developer/references/execute-task.md +15 -8
- package/.agents/skills/developer/references/onboarding.md +16 -19
- package/.agents/skills/help/SKILL.md +49 -49
- package/.agents/skills/meet/SKILL.md +37 -85
- package/.agents/skills/quick-dev/SKILL.md +40 -75
- package/.agents/skills/release-readiness/SKILL.md +1 -1
- package/.agents/skills/setup-macca-method/SKILL.md +79 -0
- package/.agents/skills/spec-audit/SKILL.md +21 -17
- package/.agents/skills/spec-compliance/SKILL.md +36 -18
- package/.agents/skills/spec-init/SKILL.md +53 -22
- package/CHANGELOG.md +31 -0
- package/README.md +92 -1195
- package/bin/macca-method.js +833 -286
- package/docs/configuration.md +174 -0
- package/docs/troubleshooting.md +180 -0
- package/docs/workflows.md +175 -0
- package/package.json +48 -4
- package/scripts/lib/npm-command.js +76 -0
- package/scripts/test-cli-setup.js +869 -0
- package/scripts/test-config.js +320 -0
- package/scripts/test-install.js +63 -28
- package/scripts/test-installer-safety.js +545 -0
- package/scripts/test-npm-command.js +143 -0
- package/scripts/test-package-safety.js +252 -0
- package/scripts/test-preferences.js +475 -0
- package/scripts/test-upgrade-legacy.js +11 -21
- package/scripts/validate-docs.js +166 -0
- package/scripts/validate-package.js +285 -0
- package/scripts/validate-skill-behavior.js +914 -12
- package/.agents/skills/antislop-copywriting/SKILL.md +0 -372
- package/.agents/skills/skill-creator/LICENSE.txt +0 -202
- package/.agents/skills/skill-creator/SKILL.md +0 -485
- package/.agents/skills/skill-creator/agents/analyzer.md +0 -274
- package/.agents/skills/skill-creator/agents/comparator.md +0 -202
- package/.agents/skills/skill-creator/agents/grader.md +0 -223
- package/.agents/skills/skill-creator/assets/eval_review.html +0 -146
- package/.agents/skills/skill-creator/eval-viewer/generate_review.py +0 -471
- package/.agents/skills/skill-creator/eval-viewer/viewer.html +0 -1325
- package/.agents/skills/skill-creator/references/schemas.md +0 -441
- package/.agents/skills/skill-creator/scripts/__init__.py +0 -0
- package/.agents/skills/skill-creator/scripts/aggregate_benchmark.py +0 -401
- package/.agents/skills/skill-creator/scripts/generate_report.py +0 -326
- package/.agents/skills/skill-creator/scripts/improve_description.py +0 -247
- package/.agents/skills/skill-creator/scripts/package_skill.py +0 -136
- package/.agents/skills/skill-creator/scripts/quick_validate.py +0 -103
- package/.agents/skills/skill-creator/scripts/run_eval.py +0 -310
- package/.agents/skills/skill-creator/scripts/run_loop.py +0 -328
- package/.agents/skills/skill-creator/scripts/utils.py +0 -47
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: brainstorm-styleguide
|
|
3
|
-
description:
|
|
3
|
+
description: Creates or updates `StyleGuide.md` covering visual tokens, components, accessibility, localization, responsive behavior, and operational UI states. Use for explicit UI/UX planning, targeted completion/update user intent, or an authorized owner handoff, including spec-init Missing Decisions and approved technical sync.
|
|
4
4
|
compatibility: Requires the complete MACCA-METHOD collection with sibling _shared resources and workspace file access.
|
|
5
5
|
metadata:
|
|
6
6
|
persona: "Akram"
|
|
@@ -17,7 +17,7 @@ Run as `@Akram` (UI/UX Designer). Use the shared persona profile in `../_shared/
|
|
|
17
17
|
|
|
18
18
|
## Role
|
|
19
19
|
|
|
20
|
-
You are a **Senior UI/UX Designer** who
|
|
20
|
+
You are a **Senior UI/UX Designer** who defines accessible, consistent UI guidance sized to the project's actual surfaces.
|
|
21
21
|
|
|
22
22
|
**Expertise:**
|
|
23
23
|
|
|
@@ -37,45 +37,47 @@ This skill generates **StyleGuide.md** through an interactive interview. It prev
|
|
|
37
37
|
|
|
38
38
|
## Usage
|
|
39
39
|
|
|
40
|
-
1.
|
|
40
|
+
1. Select the mode in `../_shared/references/brainstorm-session.md` before startup questions. Baseline-completion, targeted update, and approved technical sync take precedence over the new-document interview below. New UI planning follows usable PRD and architecture decisions; bounded work needs only its applicable inputs.
|
|
41
41
|
|
|
42
42
|
2. **Read existing project-context** before any user interaction:
|
|
43
43
|
- `project-context/PRD.md` — target platforms and referenced UI patterns
|
|
44
44
|
- `project-context/architecture.md` — chosen frontend tech stack
|
|
45
|
-
-
|
|
45
|
+
- Read the configured scope value from the safe preference summary under `language-config.md`
|
|
46
46
|
|
|
47
47
|
3. **Shared Runtime Setup** — before the interview (paths written as `../...` are relative to this SKILL.md's own folder, not the project's working directory):
|
|
48
48
|
- Read `../_shared/references/language-config.md`.
|
|
49
49
|
- Read `../_shared/references/config-mutation.md`.
|
|
50
50
|
- Read `../_shared/references/brainstorm-session.md`.
|
|
51
51
|
- Read `../_shared/references/scope-rules.md`.
|
|
52
|
-
- Use `
|
|
53
|
-
- Use `
|
|
52
|
+
- Use the resolved communication language from `language-config.md` for chat.
|
|
53
|
+
- Use the resolved document language from `language-config.md` for the final `project-context/StyleGuide.md`.
|
|
54
54
|
- Apply `brainstormPreferences.discussionMode`, `recommendations`, and `discoveryDepth` using the shared session policy.
|
|
55
|
-
-
|
|
55
|
+
- Use shared mode selection and setup only; reuse saved preferences and ask only missing preferences. Count remaining applicable topics rather than announcing a full interview for a bounded update.
|
|
56
56
|
|
|
57
57
|
4. If scope = `backend`, DO NOT create `StyleGuide.md`. Explain that UI work is outside the current scope.
|
|
58
58
|
|
|
59
59
|
5. Run the interview in the chosen mode. Wait for answers.
|
|
60
60
|
|
|
61
|
-
6.
|
|
62
|
-
|
|
63
|
-
> ⚠️ **If the file already exists:** "(A) Overwrite all, (B) Cancel and review first." Wait for the answer.
|
|
61
|
+
6. In new-document mode, complete applicable discovery and create `project-context/StyleGuide.md` (create `project-context/` if needed). For an existing file, follow the selected bounded mode; retain evidence, confidence, IDs, unrelated unknowns, and unrelated text. Regenerate only on an explicit request with approval of the named replacement.
|
|
64
62
|
|
|
65
63
|
7. Summarize the result and provide next steps.
|
|
66
64
|
|
|
65
|
+
## Domain Applicability: Smallest Sufficient UI
|
|
66
|
+
|
|
67
|
+
Apply the shared planning principles loaded by `brainstorm-session.md`. Reuse approved UI conventions and native/existing controls first. Define only components, tokens, states, and responsive behavior needed by approved surfaces. Do not automatically create a design system, dark mode, localization, icon library, or complex styling package. Additional tooling needs a current requirement, why simpler options fail, implementation/maintenance cost appropriate to the team/budget, and a concrete escalation trigger.
|
|
68
|
+
|
|
69
|
+
Critical depth means deeper usability and failure-state questions, not more UI infrastructure. Preserve accessibility, keyboard/focus behavior, labels, contrast, reduced-motion support, and applicable security/recovery states. Unknown required UI decisions stay open rather than `N/A`; future possibilities do not authorize components or tasks.
|
|
70
|
+
|
|
67
71
|
## Interview Topics (8)
|
|
68
72
|
|
|
69
|
-
### 1.
|
|
73
|
+
### 1. Styling Approach
|
|
70
74
|
|
|
71
|
-
**Ask:** _"What
|
|
75
|
+
**Ask:** _"What styling already exists, and what do the approved screens need that native or existing styles cannot provide?"_
|
|
72
76
|
|
|
73
77
|
**Collect:**
|
|
74
78
|
|
|
75
|
-
-
|
|
76
|
-
-
|
|
77
|
-
- Or CSS modules / styled-components / vanilla CSS?
|
|
78
|
-
- Utility-first or component-based?
|
|
79
|
+
- Existing/native styling approach and version if relevant
|
|
80
|
+
- Needed reusable conventions; a framework is optional
|
|
79
81
|
|
|
80
82
|
### 2. Color Palette
|
|
81
83
|
|
|
@@ -101,16 +103,16 @@ This skill generates **StyleGuide.md** through an interactive interview. It prev
|
|
|
101
103
|
- Body font family
|
|
102
104
|
- Font sizes for H1, H2, H3, H4, body, caption
|
|
103
105
|
- Font weights (bold, semibold, medium, regular)
|
|
104
|
-
-
|
|
106
|
+
- Existing/system fonts first; custom font source only if required
|
|
105
107
|
|
|
106
108
|
### 4. Spacing System
|
|
107
109
|
|
|
108
|
-
**Ask:** _"What spacing
|
|
110
|
+
**Ask:** _"What spacing conventions already exist, and what spacing do the approved layouts need?"_
|
|
109
111
|
|
|
110
112
|
**Collect:**
|
|
111
113
|
|
|
112
|
-
-
|
|
113
|
-
-
|
|
114
|
+
- Existing base unit or content-driven spacing values
|
|
115
|
+
- Reuse existing/native spacing conventions or define only the needed values
|
|
114
116
|
- Padding/margin for containers, cards, buttons
|
|
115
117
|
- Spacing between page sections
|
|
116
118
|
|
|
@@ -133,17 +135,17 @@ This skill generates **StyleGuide.md** through an interactive interview. It prev
|
|
|
133
135
|
|
|
134
136
|
**Collect:**
|
|
135
137
|
|
|
136
|
-
-
|
|
137
|
-
-
|
|
138
|
+
- Layout approach based on actual target devices and content
|
|
139
|
+
- Breakpoints needed by the content or established project conventions
|
|
138
140
|
- Layout changes per breakpoint (for example sidebar collapses below md)
|
|
139
141
|
|
|
140
142
|
### 7. Iconography
|
|
141
143
|
|
|
142
|
-
**Ask:** _"
|
|
144
|
+
**Ask:** _"Do the approved screens need icons, and can existing assets or native controls provide them?"_
|
|
143
145
|
|
|
144
146
|
**Collect:**
|
|
145
147
|
|
|
146
|
-
-
|
|
148
|
+
- Existing icon source; new library only for a justified gap
|
|
147
149
|
- Default icon size (16px, 20px, 24px)
|
|
148
150
|
- Need custom SVG icons?
|
|
149
151
|
|
|
@@ -170,7 +172,6 @@ Adapt only sections that are applicable and preserve every required contract fro
|
|
|
170
172
|
|
|
171
173
|
After StyleGuide.md is complete:
|
|
172
174
|
|
|
173
|
-
|
|
174
|
-
2. Then: `brainstorm-task` to create Task.md
|
|
175
|
+
Recommend one next step using the applicability-aware priority in `brainstorm-session.md`. Complete any missing applicable schema/API input before rules, then derive tasks. For bounded updates, return approved scope, IDs, changed sections, and evidence freshness to the caller.
|
|
175
176
|
|
|
176
177
|
---
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# StyleGuide
|
|
2
2
|
|
|
3
|
-
> **
|
|
3
|
+
> **Authoring note:** This is a placeholder menu, not a checklist to build. Keep only approved surfaces, components, and states; prune inapplicable sections or mark `N/A` with a reason. Unknown mandatory decisions remain open, not `N/A`. Reuse mature approved styles and native/existing controls. Do not automatically add a design system, dark mode, localization, or packages. Additions need a current requirement, why simpler options fail, cost within team/budget/operations constraints, and an escalation trigger. Critical depth deepens questions; accessibility and required security/recovery states remain obligations.
|
|
4
|
+
|
|
5
|
+
> **Styling:** [Existing/native approach; framework only if selected]
|
|
4
6
|
|
|
5
7
|
## Document Role
|
|
6
8
|
|
|
@@ -12,40 +14,28 @@
|
|
|
12
14
|
|
|
13
15
|
| Surface | Included? | Notes |
|
|
14
16
|
| -------------------- | --------- | ------- |
|
|
15
|
-
|
|
|
16
|
-
| Admin panel | Yes / No | [notes] |
|
|
17
|
-
| Marketing site | Yes / No | [notes] |
|
|
18
|
-
| Email / PDF / export | Yes / No | [notes] |
|
|
17
|
+
| [Approved surface] | Yes / No | [source requirement] |
|
|
19
18
|
|
|
20
19
|
---
|
|
21
20
|
|
|
22
|
-
## 1.
|
|
21
|
+
## 1. Styling Approach
|
|
23
22
|
|
|
24
|
-
- **
|
|
23
|
+
- **Native / Existing Styles:** [selected approach; framework optional]
|
|
25
24
|
- **Version:** [version]
|
|
26
25
|
- **Notes:** [Additional rules]
|
|
27
26
|
|
|
28
27
|
## 2. Color Palette
|
|
29
28
|
|
|
30
|
-
| Role |
|
|
31
|
-
| -------------- |
|
|
32
|
-
|
|
|
33
|
-
| Secondary | `#xxx` | `bg-gray-600` | Accent |
|
|
34
|
-
| Background | `#xxx` | `bg-gray-50` | Page background |
|
|
35
|
-
| Surface | `#xxx` | `bg-white` | Card/panel background |
|
|
36
|
-
| Primary Text | `#xxx` | `text-gray-900` | Main text |
|
|
37
|
-
| Secondary Text | `#xxx` | `text-gray-500` | Secondary text |
|
|
38
|
-
| Error | `#xxx` | `text-red-500` | Error message |
|
|
39
|
-
| Success | `#xxx` | `text-green-500` | Success message |
|
|
40
|
-
| Warning | `#xxx` | `text-yellow-500` | Warning message |
|
|
41
|
-
| Info | `#xxx` | `text-blue-500` | Info message |
|
|
29
|
+
| Role | Value | Existing Token / Style | Purpose / Contrast |
|
|
30
|
+
| -------------- | ------- | ---------------------- | ------------------ |
|
|
31
|
+
| [Needed role] | [value] | [token/style] | [usage/check] |
|
|
42
32
|
|
|
43
33
|
**Dark Mode:** [Supported / Not supported]
|
|
44
34
|
|
|
45
35
|
## 3. Typography
|
|
46
36
|
|
|
47
|
-
- **Heading Font:** [
|
|
48
|
-
- **Body Font:** [
|
|
37
|
+
- **Heading Font:** [existing/system font; custom source only if justified]
|
|
38
|
+
- **Body Font:** [existing/system font; custom source only if justified]
|
|
49
39
|
|
|
50
40
|
| Level | Size | Weight | Line Height |
|
|
51
41
|
| ------- | ------ | -------- | ------------- |
|
|
@@ -59,40 +49,29 @@
|
|
|
59
49
|
|
|
60
50
|
## 4. Spacing System
|
|
61
51
|
|
|
62
|
-
- **Base Unit:** [
|
|
63
|
-
- **Scale:** [
|
|
52
|
+
- **Base Unit:** [existing/approved unit if used]
|
|
53
|
+
- **Scale:** [existing/native conventions or needed values]
|
|
64
54
|
|
|
65
|
-
| Token | Value
|
|
66
|
-
|
|
|
67
|
-
|
|
|
68
|
-
| sm | [8px] | `p-2` |
|
|
69
|
-
| md | [16px] | `p-4` |
|
|
70
|
-
| lg | [24px] | `p-6` |
|
|
71
|
-
| xl | [32px] | `p-8` |
|
|
72
|
-
| 2xl | [48px] | `p-12` |
|
|
55
|
+
| Token / Usage | Value | Existing Style |
|
|
56
|
+
| ------------- | ------- | -------------- |
|
|
57
|
+
| [Needed gap] | [value] | [style] |
|
|
73
58
|
|
|
74
59
|
## 5. Component Style
|
|
75
60
|
|
|
76
|
-
- **Border Radius:** [
|
|
77
|
-
- **Shadow:** [
|
|
61
|
+
- **Border Radius:** [existing/approved value if needed]
|
|
62
|
+
- **Shadow:** [existing/approved value if needed]
|
|
78
63
|
|
|
79
64
|
## Component Inventory
|
|
80
65
|
|
|
81
66
|
| Component | Status | Notes |
|
|
82
67
|
| --------- | ------------------ | ------- |
|
|
83
|
-
|
|
|
84
|
-
| Card | Defined | [notes] |
|
|
85
|
-
| Input | Defined | [notes] |
|
|
86
|
-
| Modal | Defined / Deferred | [notes] |
|
|
87
|
-
| Table | Defined / Deferred | [notes] |
|
|
68
|
+
| [Required component] | Existing / Gap | [approved surface and requirement] |
|
|
88
69
|
|
|
89
70
|
### Button
|
|
90
71
|
|
|
91
72
|
| Variant | Style |
|
|
92
73
|
| --------- | -------------------------------------------- |
|
|
93
|
-
|
|
|
94
|
-
| Secondary | [outline / ghost] |
|
|
95
|
-
| Danger | [bg-error text-white] |
|
|
74
|
+
| [Needed variant] | [existing/native style and accessible states] |
|
|
96
75
|
|
|
97
76
|
### Card
|
|
98
77
|
|
|
@@ -109,9 +88,9 @@
|
|
|
109
88
|
|
|
110
89
|
### Transition & Animation
|
|
111
90
|
|
|
112
|
-
- **
|
|
113
|
-
- **Easing:** [
|
|
114
|
-
- **Pattern:**
|
|
91
|
+
- **Duration:** [value justified by needed feedback, if motion applies]
|
|
92
|
+
- **Easing:** [existing/approved behavior if motion applies]
|
|
93
|
+
- **Pattern:** [only needed motion; reduced-motion alternative]
|
|
115
94
|
|
|
116
95
|
## 6. Responsive & Breakpoints
|
|
117
96
|
|
|
@@ -119,10 +98,7 @@
|
|
|
119
98
|
|
|
120
99
|
| Breakpoint | Value | Description |
|
|
121
100
|
| ---------- | -------- | ------------- |
|
|
122
|
-
|
|
|
123
|
-
| md | [768px] | Tablet |
|
|
124
|
-
| lg | [1024px] | Desktop |
|
|
125
|
-
| xl | [1280px] | Large desktop |
|
|
101
|
+
| [Needed breakpoint] | [value] | [content/device constraint] |
|
|
126
102
|
|
|
127
103
|
**Layout Rules:**
|
|
128
104
|
|
|
@@ -130,9 +106,9 @@
|
|
|
130
106
|
|
|
131
107
|
## 7. Iconography
|
|
132
108
|
|
|
133
|
-
- **
|
|
134
|
-
- **
|
|
135
|
-
- **
|
|
109
|
+
- **Source:** [existing/native assets; new library only if justified]
|
|
110
|
+
- **Size:** [appropriate to actual usage and accessibility]
|
|
111
|
+
- **Usage Pattern:** [actual selected source, if needed]
|
|
136
112
|
- **Notes:** [Rules for icon usage]
|
|
137
113
|
|
|
138
114
|
## 8. Accessibility, Localization & Operational States
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: brainstorm-task
|
|
3
|
-
description: Generates or updates project-context/Task.md with phased, verifiable tasks derived
|
|
3
|
+
description: Generates or updates project-context/Task.md with phased, verifiable tasks derived from completed applicable specs. Use for sprint planning, targeted completion/update user intent, or an authorized owner handoff, including an approved add-feature phase or spec-init baseline planning. Do NOT use to invent new product scope or resolve another owner's Missing Decisions.
|
|
4
4
|
compatibility: Requires the complete MACCA-METHOD collection with sibling _shared resources and workspace file access.
|
|
5
5
|
metadata:
|
|
6
6
|
persona: "Galbi"
|
|
@@ -19,9 +19,9 @@ Before starting:
|
|
|
19
19
|
2. Read `../_shared/references/config-mutation.md`.
|
|
20
20
|
3. Read `../_shared/references/brainstorm-session.md`.
|
|
21
21
|
4. Read `../_shared/references/scope-rules.md`.
|
|
22
|
-
5. Use `
|
|
23
|
-
6. Use `
|
|
24
|
-
7. Apply `brainstormPreferences.recommendations
|
|
22
|
+
5. Use the resolved communication language from `language-config.md` for chat.
|
|
23
|
+
6. Use the resolved document language from `language-config.md` for the final `project-context/Task.md`.
|
|
24
|
+
7. Apply `brainstormPreferences.discussionMode`, `recommendations`, and `discoveryDepth` using the shared session policy.
|
|
25
25
|
|
|
26
26
|
## Character
|
|
27
27
|
|
|
@@ -51,15 +51,36 @@ This skill generates **Task.md**: a work plan derived from existing spec documen
|
|
|
51
51
|
|
|
52
52
|
## Important Approach
|
|
53
53
|
|
|
54
|
-
`Task.md` is **NOT brainstormed from scratch**. Tasks must be **derived from existing spec documents** (`PRD.md`, `architecture.md`, `schema.md`, `api.md`, `rules.md`). AI generates the tasks; the user does not restart the planning process.
|
|
54
|
+
`Task.md` is **NOT brainstormed from scratch**. Tasks must be **derived from existing applicable spec documents** (`PRD.md`, `architecture.md`, `schema.md`, `api.md`, `rules.md`). AI generates the tasks; the user does not restart the planning process.
|
|
55
|
+
|
|
56
|
+
## Domain Applicability: Smallest Sufficient Plan
|
|
57
|
+
|
|
58
|
+
Apply the shared planning principles loaded by `brainstorm-session.md`. Derive tasks only for approved current gaps and required verification, security, or recovery obligations. Reuse the actual approved architecture and existing implementation; do not create tasks to simplify mature components without an approved need. Expected scale, team capacity, budget, and operational constraints determine the smallest useful work breakdown.
|
|
59
|
+
|
|
60
|
+
Do not infer controller/service/repository layers, libraries, auth, CRUD, or infrastructure from template examples. No empty phases or tasks for “maybe later” features. A proposed component lacking a current requirement, evidence that simpler options fail, cost, and an escalation trigger returns to the owning spec decision rather than becoming a task. Critical depth means deeper dependency/risk analysis, not more phases. Unknown mandatory decisions remain open rather than `N/A`.
|
|
55
61
|
|
|
56
62
|
## Usage Steps
|
|
57
63
|
|
|
58
|
-
**Detect mode before
|
|
59
|
-
|
|
64
|
+
**Detect mode before startup questions:**
|
|
65
|
+
First follow `../_shared/references/brainstorm-session.md` for baseline-completion, targeted update, or approved technical sync intent. Route unresolved upstream `Missing Decisions` to their owners; task planning does not settle product policy. Then check whether `project-context/Task.md` contains a usable plan.
|
|
60
66
|
|
|
61
67
|
- **Does not exist yet** → follow the steps below (New Generate Mode).
|
|
62
|
-
- **Already exists** (usually called from `add-feature`) → enter **Add Phase Mode**:
|
|
68
|
+
- **Already exists, approved additional phase** (usually called from `add-feature`) → enter **Add Phase Mode**: reuse established priority, execution rules, and granularity; ask topic 2 only if granularity is unresolved. Append the approved phases/tasks and update header counts/date, Progress Overview, dependencies, and Traceability Matrix. Preserve unrelated existing phases and IDs.
|
|
69
|
+
- **Existing plan, targeted completion/update** → edit only the approved tasks/sections and affected counts, dependencies, or traceability. Do not append a new phase merely because the file exists; preserve evidence, confidence, IDs, unrelated unknowns, and unrelated text. Never overwrite/regenerate unless explicitly requested and approved.
|
|
70
|
+
|
|
71
|
+
For an owner handoff, require approved scope, IDs, changed sections, input evidence and freshness, unresolved decisions, and the authorization boundary. Reuse unchanged current evidence; refresh affected sections and material dependencies before task derivation. An add-feature approval can authorize the named Task.md addition; ask again only for a materially new decision or changed scope.
|
|
72
|
+
|
|
73
|
+
### Brownfield Classification (Existing Code or spec-init Handoff)
|
|
74
|
+
|
|
75
|
+
Before deriving implementation tasks, classify each requirement using current code, tests, input evidence, confidence, and existing Task.md:
|
|
76
|
+
|
|
77
|
+
- **Existing verified:** acceptance criteria are evidenced; preserve completed work and IDs, or record verified baseline completion with its evidence. Do not recreate setup/auth/features already satisfied.
|
|
78
|
+
- **Existing unverified:** behavior exists but evidence is incomplete; create verification or decision tasks, not duplicate implementation tasks. Do not mark completion merely from high confidence or a feature's presence.
|
|
79
|
+
- **Gaps:** demonstrated differences from approved requirements; only approved gaps become implementation tasks. Keep unapproved gaps and missing decisions separate for the owning skill/user.
|
|
80
|
+
|
|
81
|
+
This classification applies in both New Generate and Add Phase modes and takes precedence over the generic greenfield decomposition below. Preserve IDs, `[x]` history, and completion evidence; never reset completed work during generation. If evidence contradicts a completed item, report the discrepancy and obtain a decision rather than silently reopening it. Recompute counts without renumbering prior tasks.
|
|
82
|
+
|
|
83
|
+
Show these three categories in the scope summary and traceability matrix. Existing verified work can satisfy traceability without a new task. Offer only the first pending approved task; if no approved work remains, report that outcome without inventing a phase or offering Task 1.1.
|
|
63
84
|
|
|
64
85
|
**Scope rules:**
|
|
65
86
|
|
|
@@ -67,30 +88,26 @@ Check whether `project-context/Task.md` already exists.
|
|
|
67
88
|
- `backend` → generate backend tasks only
|
|
68
89
|
- `fullstack` → generate the full task set
|
|
69
90
|
|
|
70
|
-
**Session setup
|
|
71
|
-
|
|
72
|
-
Run the shared runtime setup first. Announce how many clarification topics apply in the current mode, then apply the stored pacing and recommendation preferences. If they are not stored yet, ask both before starting:
|
|
91
|
+
**Session setup:**
|
|
73
92
|
|
|
74
|
-
|
|
75
|
-
This session has [N] clarification topics.
|
|
76
|
-
1. Pacing: (A) one by one (B) three at once (C) all at once
|
|
77
|
-
2. Answer recommendations: Should AI suggest answers for each question? (Y/N)
|
|
78
|
-
```
|
|
93
|
+
Use shared mode selection and setup only. Reuse saved preferences and current answers; ask only missing preferences when an interview needs them. Count only unanswered applicable clarification topics. An approved handoff with settled planning decisions proceeds without onboarding.
|
|
79
94
|
|
|
80
|
-
1. **
|
|
95
|
+
1. **Read fresh applicable spec sections** in `project-context/` and their material dependencies; reuse cached reads only when unchanged and backed by current evidence:
|
|
81
96
|
- `project-context/PRD.md` — features, business rules, acceptance criteria
|
|
82
97
|
- `project-context/StyleGuide.md` — CSS framework, components, spacing (for styling/UI setup tasks)
|
|
83
|
-
- `project-context/architecture.md` — tech stack, folder structure
|
|
84
|
-
- `project-context/schema.md` — database
|
|
85
|
-
- `project-context/api.md` —
|
|
98
|
+
- `project-context/architecture.md` — required tech stack, folder structure
|
|
99
|
+
- `project-context/schema.md` — database/persistence contract when applicable
|
|
100
|
+
- `project-context/api.md` — API/event contract when applicable
|
|
86
101
|
- `project-context/rules.md` — coding standards
|
|
87
|
-
-
|
|
102
|
+
- Read the configured scope value from the safe preference summary under `language-config.md`
|
|
103
|
+
|
|
104
|
+
Documents outside the declared scope are `N/A` and do not block task generation. A document required by the scope must be created or explicitly approved for continuation before `Task.md` is generated.
|
|
88
105
|
|
|
89
106
|
2. **Analyze deeply** and identify all required work.
|
|
90
107
|
|
|
91
|
-
3. **Ask
|
|
108
|
+
3. **Ask only unresolved applicable clarifications** (topics below), then create or update `project-context/Task.md` within the approved scope.
|
|
92
109
|
|
|
93
|
-
4. After `Task.md` is ready, offer
|
|
110
|
+
4. After `Task.md` is ready, offer the first pending approved task only if one exists. Generation itself does not start implementation.
|
|
94
111
|
|
|
95
112
|
## Clarification Topics (4 Short)
|
|
96
113
|
|
|
@@ -98,7 +115,7 @@ _This is not a fresh brainstorm. It is only clarification before task generation
|
|
|
98
115
|
|
|
99
116
|
### 1. Phase Priority Order
|
|
100
117
|
|
|
101
|
-
**Ask:** _"
|
|
118
|
+
**Ask:** _"Which approved gaps should come first given their actual dependencies, value, and deadlines?"_
|
|
102
119
|
|
|
103
120
|
**Collect:**
|
|
104
121
|
|
|
@@ -145,16 +162,16 @@ If another document required by the declared scope is missing, inform the user a
|
|
|
145
162
|
|
|
146
163
|
Before writing `Task.md`, analyze internally:
|
|
147
164
|
|
|
148
|
-
1. Read `project-context/PRD.md` → list
|
|
149
|
-
2. Read `project-context/StyleGuide.md`
|
|
150
|
-
3. Read `project-context/architecture.md` →
|
|
151
|
-
4. Read `project-context/schema.md` → map each datastore-native entity/collection/aggregate/stream to the migrations, validation, model, projection, or infrastructure tasks its architecture actually requires
|
|
152
|
-
5. Read `project-context/api.md` → map each REST endpoint, GraphQL operation, RPC procedure, or event contract to protocol-native implementation and contract-test tasks
|
|
153
|
-
6. Read `project-context/rules.md` →
|
|
154
|
-
7. Identify
|
|
165
|
+
1. Read `project-context/PRD.md` → list approved MVP requirements → apply Brownfield Classification when code exists; only approved gaps need implementation
|
|
166
|
+
2. Read `project-context/StyleGuide.md` when frontend/UI is in scope → identify styling/component gaps only for approved surfaces; reuse satisfied conventions
|
|
167
|
+
3. Read `project-context/architecture.md` → existing approved structure and actual gaps → determine which files need changes
|
|
168
|
+
4. Read `project-context/schema.md` when backend/fullstack persistence is in scope → map each datastore-native entity/collection/aggregate/stream to the migrations, validation, model, projection, or infrastructure tasks its architecture actually requires
|
|
169
|
+
5. Read `project-context/api.md` when an API or event contract is in scope → map each REST endpoint, GraphQL operation, RPC procedure, or event contract to protocol-native implementation and contract-test tasks
|
|
170
|
+
6. Read `project-context/rules.md` → include tooling/configuration tasks only for approved unsatisfied requirements
|
|
171
|
+
7. Identify dependencies from actual architecture and data flow; do not presume model/service/controller layers
|
|
155
172
|
8. **Testing workflow:** Follow the policy in `rules.md`. If it requires test-first/TDD, precede implementation with a test task. Otherwise pair each behavior change with the test/verification task required by the approved rules. Do not force TDD against project policy.
|
|
156
|
-
9.
|
|
157
|
-
10. Create a **traceability matrix**: every main requirement (`FEAT-*`, `BR-*`, `NFR-*`, `API-*`, `DATA-*`)
|
|
173
|
+
9. For required security controls, explicitly track unsatisfied implementation or verification work; retain evidence for controls already verified rather than recreating them.
|
|
174
|
+
10. Create a **traceability matrix**: every main requirement (`FEAT-*`, `BR-*`, `NFR-*`, `API-*`, `DATA-*`) maps to a task or evidenced existing verified baseline; distinguish verification work and unapproved gaps.
|
|
158
175
|
11. Derive a phase Definition of Done from applicable specs. Do not ask another question: include tests/checks, security, migration/backfill, observability, documentation, rollout/rollback evidence, spec-compliance, and code-review only when relevant.
|
|
159
176
|
|
|
160
177
|
After analysis, **show the scope summary to the user**:
|
|
@@ -177,7 +194,7 @@ Security controls to implement:
|
|
|
177
194
|
Is this scope correct? Anything to add or remove?
|
|
178
195
|
```
|
|
179
196
|
|
|
180
|
-
|
|
197
|
+
Obtain scope confirmation before creating or updating Task.md unless the current explicit approval or authorized handoff already covers the exact bounded change. Do not ask for the same approval again; ask only if scope changes or a material conflict appears.
|
|
181
198
|
|
|
182
199
|
## Task.md Output
|
|
183
200
|
|
|
@@ -191,8 +208,7 @@ Adapt only sections that are applicable and preserve every required contract fro
|
|
|
191
208
|
|
|
192
209
|
1. Confirm `project-context/Task.md` was created.
|
|
193
210
|
2. Show the progress overview (phases + task counts).
|
|
194
|
-
3.
|
|
195
|
-
> "All spec documents are ready! Task.md has been created. Start Task 1.1?"
|
|
211
|
+
3. If pending approved work exists, offer its actual ID and purpose (verification or implementation). If none remains, report completion of planning without offering coding. Preserve the user's execution authorization boundary.
|
|
196
212
|
|
|
197
213
|
## Critical Notes
|
|
198
214
|
|
|
@@ -200,7 +216,7 @@ Adapt only sections that are applicable and preserve every required contract fro
|
|
|
200
216
|
- Every task must have **testable acceptance criteria**, not just a description.
|
|
201
217
|
- Mark **task dependencies** clearly. AI cannot skip tasks.
|
|
202
218
|
- **Testing:** Task order follows the approved testing workflow in `rules.md`; test-first is required only when that policy requires it.
|
|
203
|
-
-
|
|
219
|
+
- Explicitly cover required security controls through gap/verification tasks or evidenced existing completion. Do not assume they "happen automatically."
|
|
204
220
|
- Every task must have **Traceability IDs** that reference real upstream requirements or artifacts.
|
|
205
221
|
- A **Traceability Matrix** is required for auditability.
|
|
206
222
|
- Task granularity must be **atomic**: completable and verifiable in one session.
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# Task: [Project Name]
|
|
2
2
|
|
|
3
|
+
> **Authoring note:** This is a placeholder menu, not a checklist to build. Derive tasks only from approved current gaps and required verification/security/recovery work in the actual architecture. Prune inapplicable sections or mark `N/A` with a reason; unknown mandatory decisions remain open, not `N/A`. Reuse verified existing work and preserve IDs/history. No presumed setup/auth/layers, empty phases, copied example tasks, or “maybe later” features. Critical depth deepens analysis, not the task count. Return unjustified new components to their spec owner for requirement, simpler-option evidence, cost, and escalation-trigger decisions within scale/team/budget/operations constraints.
|
|
4
|
+
|
|
3
5
|
> **Total Phases:** [X] | **Total Tasks:** [Y] | **Last Updated:** [date]
|
|
4
6
|
|
|
5
7
|
## Document Role
|
|
@@ -32,9 +34,9 @@
|
|
|
32
34
|
|
|
33
35
|
| Phase | Name | Status | Progress |
|
|
34
36
|
| ----- | ----------------------- | ------ | -------- |
|
|
35
|
-
|
|
|
36
|
-
|
|
37
|
-
|
|
37
|
+
| [ID] | [Actual approved phase] | [status] | [verified/total] |
|
|
38
|
+
|
|
39
|
+
Generate only phases with real approved work. If none remains, report that outcome with no placeholder phase.
|
|
38
40
|
|
|
39
41
|
## AI Read Order
|
|
40
42
|
|
|
@@ -74,7 +76,7 @@
|
|
|
74
76
|
- **Files:** `[path/file]`
|
|
75
77
|
- **Description:** [Briefly what is done]
|
|
76
78
|
- **Dependencies:** Task 1.1 must be complete first
|
|
77
|
-
- **References:** [`project-context/
|
|
79
|
+
- **References:** [`project-context/[applicable-document].md#actual-section`]
|
|
78
80
|
- **Traceability IDs:** [`FEAT-01` / `DATA-01`]
|
|
79
81
|
- **Acceptance Criteria:**
|
|
80
82
|
- [ ] [Testable condition]
|
|
@@ -100,7 +102,7 @@
|
|
|
100
102
|
- [ ] **Task 2.1: [Task Name]**
|
|
101
103
|
- **Files:** `[path/file]`
|
|
102
104
|
- **Description:** [Brief]
|
|
103
|
-
- **References:** [`project-context/
|
|
105
|
+
- **References:** [`project-context/[applicable-document].md#actual-section`]
|
|
104
106
|
- **Traceability IDs:** [`FEAT-01` / `API-01` / `NFR-02`]
|
|
105
107
|
- **Acceptance Criteria:**
|
|
106
108
|
- [ ] [Testable condition]
|
|
@@ -109,16 +111,13 @@
|
|
|
109
111
|
|
|
110
112
|
## Traceability Matrix
|
|
111
113
|
|
|
112
|
-
| Requirement ID | Source
|
|
113
|
-
| -------------- |
|
|
114
|
-
|
|
|
115
|
-
| BR-01 | `project-context/PRD.md` | `Task 1.1` |
|
|
116
|
-
| API-01 | `project-context/api.md` | `Task 2.1` |
|
|
117
|
-
| DATA-01 | `project-context/schema.md` | `Task 1.2` |
|
|
114
|
+
| Requirement ID | Source | Classification | Covering Task or Verified Evidence |
|
|
115
|
+
| -------------- | ------ | -------------- | ---------------------------------- |
|
|
116
|
+
| [Existing ID] | [actual source/section] | Existing verified / Existing unverified / Gap | [evidence or approved task ID; unapproved gaps remain separate] |
|
|
118
117
|
|
|
119
118
|
## Assumptions & Open Questions
|
|
120
119
|
|
|
121
120
|
- [Assumption that affects planning granularity or order]
|
|
122
121
|
- [Open question that may change future phases]
|
|
123
122
|
|
|
124
|
-
|
|
123
|
+
Use the phase/task blocks only as formatting examples for actual approved work. Repeat `Phase Definition of Done` only for generated non-empty phases, adapting items to scope and preserving required safeguards.
|