context-first-cli 2.1.6 → 2.2.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/dist/commands/feature.d.ts.map +1 -1
- package/dist/commands/feature.js +21 -2
- package/dist/commands/feature.js.map +1 -1
- package/dist/templates/commands/en/engineer/plan.md +48 -10
- package/dist/templates/commands/en/engineer/pr.md +46 -8
- package/dist/templates/commands/en/engineer/pre-pr.md +49 -11
- package/dist/templates/commands/en/engineer/start.md +60 -23
- package/dist/templates/commands/en/engineer/work.md +45 -7
- package/dist/templates/commands/en/products/check.md +48 -11
- package/dist/templates/commands/en/products/collect.md +51 -14
- package/dist/templates/commands/en/products/refine.md +64 -26
- package/dist/templates/commands/en/products/spec.md +42 -5
- package/dist/templates/commands/en/quality/metrics.md +51 -14
- package/dist/templates/commands/en/quality/observe.md +44 -6
- package/dist/templates/commands/en/warm-up.md +56 -19
- package/dist/templates/commands/es/engineer/plan.md +60 -22
- package/dist/templates/commands/es/engineer/pr.md +47 -9
- package/dist/templates/commands/es/engineer/pre-pr.md +59 -21
- package/dist/templates/commands/es/engineer/start.md +52 -15
- package/dist/templates/commands/es/engineer/work.md +91 -53
- package/dist/templates/commands/es/products/check.md +48 -10
- package/dist/templates/commands/es/products/collect.md +55 -18
- package/dist/templates/commands/es/products/refine.md +100 -62
- package/dist/templates/commands/es/products/spec.md +63 -26
- package/dist/templates/commands/es/quality/metrics.md +43 -5
- package/dist/templates/commands/es/quality/observe.md +42 -5
- package/dist/templates/commands/es/warm-up.md +45 -7
- package/dist/templates/commands/pt-BR/engineer/plan.md +38 -0
- package/dist/templates/commands/pt-BR/engineer/pr.md +38 -0
- package/dist/templates/commands/pt-BR/engineer/pre-pr.md +38 -0
- package/dist/templates/commands/pt-BR/engineer/start.md +38 -0
- package/dist/templates/commands/pt-BR/engineer/work.md +38 -0
- package/dist/templates/commands/pt-BR/products/check.md +38 -0
- package/dist/templates/commands/pt-BR/products/collect.md +38 -0
- package/dist/templates/commands/pt-BR/products/refine.md +38 -0
- package/dist/templates/commands/pt-BR/products/spec.md +38 -0
- package/dist/templates/commands/pt-BR/quality/metrics.md +38 -0
- package/dist/templates/commands/pt-BR/quality/observe.md +38 -0
- package/dist/templates/commands/pt-BR/warm-up.md +38 -0
- package/package.json +1 -1
- package/templates/commands/en/engineer/plan.md +48 -10
- package/templates/commands/en/engineer/pr.md +46 -8
- package/templates/commands/en/engineer/pre-pr.md +49 -11
- package/templates/commands/en/engineer/start.md +60 -23
- package/templates/commands/en/engineer/work.md +45 -7
- package/templates/commands/en/products/check.md +48 -11
- package/templates/commands/en/products/collect.md +51 -14
- package/templates/commands/en/products/refine.md +64 -26
- package/templates/commands/en/products/spec.md +42 -5
- package/templates/commands/en/quality/metrics.md +51 -14
- package/templates/commands/en/quality/observe.md +44 -6
- package/templates/commands/en/warm-up.md +56 -19
- package/templates/commands/es/engineer/plan.md +60 -22
- package/templates/commands/es/engineer/pr.md +47 -9
- package/templates/commands/es/engineer/pre-pr.md +59 -21
- package/templates/commands/es/engineer/start.md +52 -15
- package/templates/commands/es/engineer/work.md +91 -53
- package/templates/commands/es/products/check.md +48 -10
- package/templates/commands/es/products/collect.md +55 -18
- package/templates/commands/es/products/refine.md +100 -62
- package/templates/commands/es/products/spec.md +63 -26
- package/templates/commands/es/quality/metrics.md +43 -5
- package/templates/commands/es/quality/observe.md +42 -5
- package/templates/commands/es/warm-up.md +45 -7
- package/templates/commands/pt-BR/engineer/plan.md +38 -0
- package/templates/commands/pt-BR/engineer/pr.md +38 -0
- package/templates/commands/pt-BR/engineer/pre-pr.md +38 -0
- package/templates/commands/pt-BR/engineer/start.md +38 -0
- package/templates/commands/pt-BR/engineer/work.md +38 -0
- package/templates/commands/pt-BR/products/check.md +38 -0
- package/templates/commands/pt-BR/products/collect.md +38 -0
- package/templates/commands/pt-BR/products/refine.md +38 -0
- package/templates/commands/pt-BR/products/spec.md +38 -0
- package/templates/commands/pt-BR/quality/metrics.md +38 -0
- package/templates/commands/pt-BR/quality/observe.md +38 -0
- package/templates/commands/pt-BR/warm-up.md +38 -0
|
@@ -7,11 +7,49 @@ This command executes a unit of work in the current workspace, implementing part
|
|
|
7
7
|
Before executing, make sure that:
|
|
8
8
|
- You have run `/start` and `/plan` to have the technical plan
|
|
9
9
|
- You are in the correct workspace: `<orchestrator>/.sessions/<ISSUE-ID>/`
|
|
10
|
-
- You have the `.sessions/<ISSUE-ID>/`
|
|
10
|
+
- You have the files `.sessions/<ISSUE-ID>/` available:
|
|
11
11
|
- `context.md` (immutable)
|
|
12
12
|
- `architecture.md` (immutable)
|
|
13
13
|
- `plan.md` (mutable)
|
|
14
14
|
|
|
15
|
+
## 📋 Project Configuration
|
|
16
|
+
|
|
17
|
+
**⚠️ IMPORTANT: Always read the project configuration files BEFORE running this command!**
|
|
18
|
+
|
|
19
|
+
### Required Files
|
|
20
|
+
|
|
21
|
+
1. **`context-manifest.json`** (orchestrator root)
|
|
22
|
+
- List of project repositories
|
|
23
|
+
- Roles of each repository (metaspecs, application, etc.)
|
|
24
|
+
- URLs and dependencies between repositories
|
|
25
|
+
|
|
26
|
+
2. **`ai.properties.md`** (orchestrator root)
|
|
27
|
+
- Project settings (`project_name`, `base_path`)
|
|
28
|
+
- Task management system (`task_management_system`)
|
|
29
|
+
- Credentials and specific configurations
|
|
30
|
+
|
|
31
|
+
### How to Read
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# 1. Read context-manifest.json
|
|
35
|
+
cat context-manifest.json
|
|
36
|
+
|
|
37
|
+
# 2. Read ai.properties.md
|
|
38
|
+
cat ai.properties.md
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Essential Information
|
|
42
|
+
|
|
43
|
+
After reading the files, you will have:
|
|
44
|
+
- ✅ Complete list of project repositories
|
|
45
|
+
- ✅ Location of the metaspecs repository
|
|
46
|
+
- ✅ Base path to locate repositories
|
|
47
|
+
- ✅ Configured task management system
|
|
48
|
+
- ✅ Project-specific configurations
|
|
49
|
+
|
|
50
|
+
**🛑 DO NOT proceed without reading these files!** They contain critical information for the correct execution of the command.
|
|
51
|
+
|
|
52
|
+
|
|
15
53
|
## 📍 IMPORTANT: Understand the Structure
|
|
16
54
|
|
|
17
55
|
**Workspace** (where you work):
|
|
@@ -32,7 +70,7 @@ Before executing, make sure that:
|
|
|
32
70
|
|
|
33
71
|
**GOLDEN RULE**:
|
|
34
72
|
- ✅ Work ONLY inside `<orchestrator>/.sessions/<ISSUE-ID>/`
|
|
35
|
-
- ✅
|
|
73
|
+
- ✅ Commit in the worktrees inside the workspace
|
|
36
74
|
- ❌ NEVER checkout branches in the main repositories
|
|
37
75
|
- ❌ NEVER navigate to `{base_path}/{repo-id}/`
|
|
38
76
|
|
|
@@ -57,7 +95,7 @@ Before executing, make sure that:
|
|
|
57
95
|
**ABSOLUTE RULE**:
|
|
58
96
|
- 🛑 **EVERY code file** (`.ts`, `.js`, `.py`, `.java`, etc.) **MUST be inside** `<orchestrator>/.sessions/<ISSUE-ID>/<repo-name>/`
|
|
59
97
|
- 🛑 **NEVER create code** directly in `<orchestrator>/.sessions/` or `<orchestrator>/.sessions/<ISSUE-ID>/`
|
|
60
|
-
- ✅ **Only valid place**: Inside the
|
|
98
|
+
- ✅ **Only valid place**: Inside the repository’s worktree
|
|
61
99
|
|
|
62
100
|
## ⚠️ IMPORTANT: Immutable Files
|
|
63
101
|
|
|
@@ -67,8 +105,8 @@ Before executing, make sure that:
|
|
|
67
105
|
- ✅ **UPDATE** `.sessions/<ISSUE-ID>/plan.md` (mark progress)
|
|
68
106
|
- ✅ **IMPLEMENT** code **INSIDE THE WORKTREE**: `.sessions/<ISSUE-ID>/<repo-name>/`
|
|
69
107
|
- ✅ **MAKE COMMITS** in the worktrees: `.sessions/<ISSUE-ID>/<repo-name>/`
|
|
70
|
-
- ❌ **
|
|
71
|
-
- ❌ **
|
|
108
|
+
- ❌ **Do NOT modify `context.md` or `architecture.md`**
|
|
109
|
+
- ❌ **Do NOT checkout branches in the main repositories (outside workspace)**
|
|
72
110
|
- 🛑 **NEVER create code directly in `.sessions/` or `.sessions/<ISSUE-ID>/`**
|
|
73
111
|
|
|
74
112
|
## 📚 Load MetaSpecs
|
|
@@ -83,7 +121,7 @@ Before executing, make sure that:
|
|
|
83
121
|
- Respect defined architecture
|
|
84
122
|
- Use correct conventions
|
|
85
123
|
|
|
86
|
-
## 🎯
|
|
124
|
+
## 🎯 Objective
|
|
87
125
|
|
|
88
126
|
Implement a specific unit of work from the plan, which may involve:
|
|
89
127
|
- Creating new files/components
|
|
@@ -124,7 +162,7 @@ Based on the technical plan (`./.sessions/<ISSUE-ID>/plan.md`), identify:
|
|
|
124
162
|
|
|
125
163
|
|
|
126
164
|
|
|
127
|
-
**IMPORTANT**: Work ONLY inside the workspace
|
|
165
|
+
**IMPORTANT**: Work ONLY inside the workspace `.sessions/<ISSUE-ID>/`
|
|
128
166
|
|
|
129
167
|
For each repository in the workspace:
|
|
130
168
|
|
|
@@ -12,6 +12,43 @@ This command validates requirements, decisions, or implementations against the p
|
|
|
12
12
|
- ❌ **DO NOT modify code**
|
|
13
13
|
- ❌ **DO NOT modify `context.md` or `architecture.md`**
|
|
14
14
|
|
|
15
|
+
## 📋 Project Configuration
|
|
16
|
+
|
|
17
|
+
**⚠️ IMPORTANT: Always read the project configuration files BEFORE running this command!**
|
|
18
|
+
|
|
19
|
+
### Required Files
|
|
20
|
+
|
|
21
|
+
1. **`context-manifest.json`** (root of the orchestrator)
|
|
22
|
+
- List of project repositories
|
|
23
|
+
- Roles of each repository (metaspecs, application, etc.)
|
|
24
|
+
- URLs and dependencies between repositories
|
|
25
|
+
|
|
26
|
+
2. **`ai.properties.md`** (root of the orchestrator)
|
|
27
|
+
- Project settings (`project_name`, `base_path`)
|
|
28
|
+
- Task management system
|
|
29
|
+
- Credentials and specific configurations
|
|
30
|
+
|
|
31
|
+
### How to Read
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# 1. Read context-manifest.json
|
|
35
|
+
cat context-manifest.json
|
|
36
|
+
|
|
37
|
+
# 2. Read ai.properties.md
|
|
38
|
+
cat ai.properties.md
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Essential Information
|
|
42
|
+
|
|
43
|
+
After reading the files, you will have:
|
|
44
|
+
- ✅ Complete list of project repositories
|
|
45
|
+
- ✅ Location of the metaspecs repository
|
|
46
|
+
- ✅ Base path to locate repositories
|
|
47
|
+
- ✅ Configured task management system
|
|
48
|
+
- ✅ Specific project configurations
|
|
49
|
+
|
|
50
|
+
**🛑 DO NOT proceed without reading these files!** They contain critical information for the correct execution of the command.
|
|
51
|
+
|
|
15
52
|
## 🎯 Objective
|
|
16
53
|
|
|
17
54
|
Ensure alignment with:
|
|
@@ -34,7 +71,7 @@ Run this command:
|
|
|
34
71
|
1. Read `context-manifest.json` from the orchestrator
|
|
35
72
|
2. Find the repository with `"role": "metaspecs"`
|
|
36
73
|
3. Read `ai.properties.md` to get the `base_path`
|
|
37
|
-
4. The metaspecs are located at: `{base_path}/{metaspecs-repo-id}
|
|
74
|
+
4. The metaspecs are located at: `{base_path}/{metaspecs-repo-id}/`
|
|
38
75
|
|
|
39
76
|
## 🔍 Validation Process
|
|
40
77
|
|
|
@@ -48,7 +85,7 @@ ls -la {base_path}/{metaspecs-repo-id}/
|
|
|
48
85
|
|
|
49
86
|
### 2. Business Validation
|
|
50
87
|
|
|
51
|
-
If
|
|
88
|
+
If business metaspecs exist (`MetaSpecs repository (business section)`):
|
|
52
89
|
|
|
53
90
|
```markdown
|
|
54
91
|
## Business Validation
|
|
@@ -56,25 +93,25 @@ If there are business metaspecs (`MetaSpecs repository (business section)`):
|
|
|
56
93
|
### Product Strategy
|
|
57
94
|
- **File**: `MetaSpecs repository (business section)PRODUCT_STRATEGY.md`
|
|
58
95
|
- **Validation**: [Is this feature aligned with the strategy?]
|
|
59
|
-
- **Status**: ✅ Aligned / ⚠️
|
|
96
|
+
- **Status**: ✅ Aligned / ⚠️ Partial / ❌ Misaligned
|
|
60
97
|
- **Notes**: [Observations]
|
|
61
98
|
|
|
62
99
|
### Personas
|
|
63
100
|
- **File**: `MetaSpecs repository (business section)CUSTOMER_PERSONAS.md`
|
|
64
101
|
- **Validation**: [Does it meet the correct persona?]
|
|
65
|
-
- **Status**: ✅ Aligned / ⚠️
|
|
102
|
+
- **Status**: ✅ Aligned / ⚠️ Partial / ❌ Misaligned
|
|
66
103
|
- **Notes**: [Observations]
|
|
67
104
|
|
|
68
105
|
### Metrics
|
|
69
106
|
- **File**: `MetaSpecs repository (business section)PRODUCT_METRICS.md`
|
|
70
107
|
- **Validation**: [Is the success metric documented?]
|
|
71
|
-
- **Status**: ✅ Aligned / ⚠️
|
|
108
|
+
- **Status**: ✅ Aligned / ⚠️ Partial / ❌ Misaligned
|
|
72
109
|
- **Notes**: [Observations]
|
|
73
110
|
```
|
|
74
111
|
|
|
75
112
|
### 3. Technical Validation
|
|
76
113
|
|
|
77
|
-
If
|
|
114
|
+
If technical metaspecs exist (`MetaSpecs repository (technical section)`):
|
|
78
115
|
|
|
79
116
|
```markdown
|
|
80
117
|
## Technical Validation
|
|
@@ -128,14 +165,14 @@ If there are technical metaspecs (`MetaSpecs repository (technical section)`):
|
|
|
128
165
|
|
|
129
166
|
### 5. Conflict Identification
|
|
130
167
|
|
|
131
|
-
If
|
|
168
|
+
If conflicts or misalignments exist:
|
|
132
169
|
|
|
133
170
|
```markdown
|
|
134
171
|
## Identified Conflicts
|
|
135
172
|
|
|
136
173
|
### Conflict 1: [Description]
|
|
137
174
|
- **Severity**: Critical / High / Medium / Low
|
|
138
|
-
- **Metaspec**: [
|
|
175
|
+
- **Metaspec**: [Violated file]
|
|
139
176
|
- **Description**: [Conflict details]
|
|
140
177
|
- **Recommendation**: [How to resolve]
|
|
141
178
|
|
|
@@ -151,7 +188,7 @@ If there are justified deviations:
|
|
|
151
188
|
## Justified Exceptions
|
|
152
189
|
|
|
153
190
|
### Exception 1: [Description]
|
|
154
|
-
- **Metaspec**: [
|
|
191
|
+
- **Metaspec**: [Deviated file]
|
|
155
192
|
- **Deviation**: [What is different]
|
|
156
193
|
- **Justification**: [Why it is necessary]
|
|
157
194
|
- **Approval**: [Who approved]
|
|
@@ -166,7 +203,7 @@ If there are justified deviations:
|
|
|
166
203
|
- Use the appropriate MCP to add the report to the issue:
|
|
167
204
|
- Add as a comment on the issue
|
|
168
205
|
- Update labels/tags according to the result (e.g., "validated", "needs-adjustment", "blocked")
|
|
169
|
-
- If
|
|
206
|
+
- If critical conflicts exist, update the issue status
|
|
170
207
|
- Inform the user: "✅ Validation report added to issue [ID]"
|
|
171
208
|
|
|
172
209
|
**FALLBACK: Create .md file only if MCP fails**
|
|
@@ -212,7 +249,7 @@ If critical conflicts are found:
|
|
|
212
249
|
2. 📝 **DOCUMENT** all conflicts
|
|
213
250
|
3. 💬 **ALERT** the user and stakeholders
|
|
214
251
|
4. **Via MCP**: Update issue status to "Blocked" or "Requires Adjustments"
|
|
215
|
-
5. 🔄 **ADJUST**
|
|
252
|
+
5. 🔄 **ADJUST** plan/implementation as needed
|
|
216
253
|
6. ✅ **REVALIDATE** after adjustments
|
|
217
254
|
|
|
218
255
|
---
|
|
@@ -18,20 +18,57 @@ You are a product specialist responsible for collecting and documenting new idea
|
|
|
18
18
|
|
|
19
19
|
---
|
|
20
20
|
|
|
21
|
+
## 📋 Project Setup
|
|
22
|
+
|
|
23
|
+
**⚠️ IMPORTANT: Always read the project configuration files BEFORE running this command!**
|
|
24
|
+
|
|
25
|
+
### Mandatory Files
|
|
26
|
+
|
|
27
|
+
1. **`context-manifest.json`** (orchestrator root)
|
|
28
|
+
- List of project repositories
|
|
29
|
+
- Roles of each repository (metaspecs, application, etc.)
|
|
30
|
+
- URLs and dependencies between repositories
|
|
31
|
+
|
|
32
|
+
2. **`ai.properties.md`** (orchestrator root)
|
|
33
|
+
- Project settings (`project_name`, `base_path`)
|
|
34
|
+
- Task management system (`task_management_system`)
|
|
35
|
+
- Credentials and specific configurations
|
|
36
|
+
|
|
37
|
+
### How to Read
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# 1. Read context-manifest.json
|
|
41
|
+
cat context-manifest.json
|
|
42
|
+
|
|
43
|
+
# 2. Read ai.properties.md
|
|
44
|
+
cat ai.properties.md
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Essential Information
|
|
48
|
+
|
|
49
|
+
After reading the files, you will have:
|
|
50
|
+
- ✅ Complete list of project repositories
|
|
51
|
+
- ✅ Location of the metaspecs repository
|
|
52
|
+
- ✅ Base path to locate repositories
|
|
53
|
+
- ✅ Configured task management system
|
|
54
|
+
- ✅ Project-specific configurations
|
|
55
|
+
|
|
56
|
+
**🛑 DO NOT proceed without reading these files!** They contain critical information for the correct execution of the command.
|
|
57
|
+
|
|
21
58
|
## Project Context
|
|
22
59
|
|
|
23
60
|
Before starting, load the context by consulting:
|
|
24
61
|
|
|
25
|
-
1. **Automatically
|
|
62
|
+
1. **Automatically locate MetaSpecs**:
|
|
26
63
|
- Read `context-manifest.json` from the orchestrator
|
|
27
64
|
- Find the repository with `"role": "metaspecs"`
|
|
28
65
|
- Read `ai.properties.md` to get the `base_path`
|
|
29
|
-
- The metaspecs are at: `{base_path}/{metaspecs-repo-id}/`
|
|
66
|
+
- The metaspecs are located at: `{base_path}/{metaspecs-repo-id}/`
|
|
30
67
|
- Read the `index.md` files as reference
|
|
31
68
|
|
|
32
|
-
2. **Project
|
|
69
|
+
2. **Project structure**:
|
|
33
70
|
- `context-manifest.json` - List of repositories and their roles
|
|
34
|
-
- `README.md` of
|
|
71
|
+
- `README.md` of involved repositories
|
|
35
72
|
|
|
36
73
|
## Your Goal
|
|
37
74
|
|
|
@@ -87,14 +124,14 @@ Just ensure the idea is **adequately understood**.
|
|
|
87
124
|
- Suggested priority
|
|
88
125
|
|
|
89
126
|
3. **Complexity Assessment and Suggestion to Split**
|
|
90
|
-
|
|
127
|
+
|
|
91
128
|
Before finalizing, assess the issue complexity:
|
|
92
|
-
|
|
129
|
+
|
|
93
130
|
**If the implementation seems large** (> 5 days estimated effort):
|
|
94
131
|
- 🚨 **Suggest splitting into multiple smaller issues**
|
|
95
|
-
- Explain the rationale for
|
|
132
|
+
- Explain the rationale for the split (e.g., "This feature involves 3 distinct areas: authentication, processing, and notification")
|
|
96
133
|
- Propose a **logical** split (by functionality, repository, layer, etc.)
|
|
97
|
-
- Example
|
|
134
|
+
- Example split:
|
|
98
135
|
```
|
|
99
136
|
Original Issue: "Complete payment system"
|
|
100
137
|
|
|
@@ -104,7 +141,7 @@ Just ensure the idea is **adequately understood**.
|
|
|
104
141
|
- FIN-103: Confirmation webhook and notifications (backend + jobs)
|
|
105
142
|
```
|
|
106
143
|
- **Important**: The final decision is the user's - they can accept the split or keep it as a single issue
|
|
107
|
-
|
|
144
|
+
|
|
108
145
|
**If the user accepts the split**:
|
|
109
146
|
- Create each issue separately using the same process
|
|
110
147
|
- Add cross-references between related issues
|
|
@@ -112,10 +149,10 @@ Just ensure the idea is **adequately understood**.
|
|
|
112
149
|
|
|
113
150
|
4. **User Approval**
|
|
114
151
|
- Present the draft (or drafts, if split)
|
|
115
|
-
- Make adjustments
|
|
152
|
+
- Make adjustments according to feedback
|
|
116
153
|
- Obtain final approval
|
|
117
154
|
|
|
118
|
-
5. **Saving
|
|
155
|
+
5. **Issue Saving**
|
|
119
156
|
|
|
120
157
|
**PRIORITY 1: Use MCP (Model Context Protocol)**
|
|
121
158
|
|
|
@@ -134,8 +171,8 @@ Just ensure the idea is **adequately understood**.
|
|
|
134
171
|
|
|
135
172
|
**FALLBACK: Create .md file only if MCP fails**
|
|
136
173
|
|
|
137
|
-
If MCP is
|
|
138
|
-
- Create a file
|
|
174
|
+
If MCP is not available or fails:
|
|
175
|
+
- Create a file in `./.sessions/<ISSUE-ID>/collect.md`
|
|
139
176
|
- Use manual ID format: `LOCAL-001`, `LOCAL-002`, etc.
|
|
140
177
|
- Include date, type, and full content
|
|
141
178
|
- Inform the user: "⚠️ Issue saved locally in .sessions/ (task manager not available)"
|
|
@@ -157,7 +194,7 @@ Just ensure the idea is **adequately understood**.
|
|
|
157
194
|
|
|
158
195
|
**For Improvements**:
|
|
159
196
|
- What is working but can be improved?
|
|
160
|
-
-
|
|
197
|
+
- Which metric do we want to impact?
|
|
161
198
|
- Is it a technical or business optimization?
|
|
162
199
|
|
|
163
200
|
---
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Requirements Refinement
|
|
2
2
|
|
|
3
|
-
You are a product expert
|
|
3
|
+
You are a product expert responsible for helping to refine requirements for the project.
|
|
4
4
|
|
|
5
5
|
## ⚠️ IMPORTANT: This Command DOES NOT Implement Code
|
|
6
6
|
|
|
@@ -17,6 +17,44 @@ You are a product expert tasked with helping to refine requirements for the proj
|
|
|
17
17
|
|
|
18
18
|
---
|
|
19
19
|
|
|
20
|
+
## 📋 Project Setup
|
|
21
|
+
|
|
22
|
+
**⚠️ IMPORTANT: Always read the project configuration files BEFORE running this command!**
|
|
23
|
+
|
|
24
|
+
### Mandatory Files
|
|
25
|
+
|
|
26
|
+
1. **`context-manifest.json`** (orchestrator root)
|
|
27
|
+
- List of project repositories
|
|
28
|
+
- Roles of each repository (metaspecs, application, etc.)
|
|
29
|
+
- URLs and dependencies between repositories
|
|
30
|
+
|
|
31
|
+
2. **`ai.properties.md`** (orchestrator root)
|
|
32
|
+
- Project settings (`project_name`, `base_path`)
|
|
33
|
+
- Task management system (`task_management_system`)
|
|
34
|
+
- Credentials and specific configurations
|
|
35
|
+
|
|
36
|
+
### How to Read
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
# 1. Read context-manifest.json
|
|
40
|
+
cat context-manifest.json
|
|
41
|
+
|
|
42
|
+
# 2. Read ai.properties.md
|
|
43
|
+
cat ai.properties.md
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Essential Information
|
|
47
|
+
|
|
48
|
+
After reading the files, you will have:
|
|
49
|
+
- ✅ Complete list of project repositories
|
|
50
|
+
- ✅ Location of the metaspecs repository
|
|
51
|
+
- ✅ Base path to locate repositories
|
|
52
|
+
- ✅ Configured task management system
|
|
53
|
+
- ✅ Project-specific configurations
|
|
54
|
+
|
|
55
|
+
**🛑 DO NOT proceed without reading these files!** They contain critical information for correct command execution.
|
|
56
|
+
|
|
57
|
+
|
|
20
58
|
## Objective
|
|
21
59
|
|
|
22
60
|
Transform an initial requirement into a refined and validated specification, ready to become a complete PRD.
|
|
@@ -26,7 +64,7 @@ Transform an initial requirement into a refined and validated specification, rea
|
|
|
26
64
|
### 1. Clarification Phase
|
|
27
65
|
|
|
28
66
|
Read the initial requirement and ask questions to achieve full clarity about:
|
|
29
|
-
- **
|
|
67
|
+
- **Goal**: Why build this?
|
|
30
68
|
- **Business Value**: Which metric/persona does it impact?
|
|
31
69
|
- **Scope**: What is included and what is NOT included?
|
|
32
70
|
- **Interactions**: Which existing features/components are affected?
|
|
@@ -35,7 +73,7 @@ Keep asking questions until you have complete understanding.
|
|
|
35
73
|
|
|
36
74
|
### 2. Validation Against Metaspecs
|
|
37
75
|
|
|
38
|
-
**IMPORTANT**: First read `ai.properties.md` to
|
|
76
|
+
**IMPORTANT**: First read `ai.properties.md` to get the `base_path`. The indexes should ALREADY be in context (you ran `/warm-up`). Consult the indexes and read ONLY relevant documents to validate the requirement.
|
|
39
77
|
|
|
40
78
|
**Validation Process**:
|
|
41
79
|
|
|
@@ -61,50 +99,50 @@ Keep asking questions until you have complete understanding.
|
|
|
61
99
|
- ✅ Follows existing business rules
|
|
62
100
|
- ⚠️ Identify conflicts or violations
|
|
63
101
|
|
|
64
|
-
**If
|
|
102
|
+
**If violations are identified**: 🛑 **STOP** and ask the user for clarification before proceeding (Jidoka Principle).
|
|
65
103
|
|
|
66
104
|
### 3. Summary and Approval Phase
|
|
67
105
|
|
|
68
106
|
Once you have gathered sufficient information and validated against metaspecs, present a structured summary with:
|
|
69
107
|
- **Feature**: Feature name
|
|
70
|
-
- **
|
|
108
|
+
- **Goal**: Why build it (1-2 sentences)
|
|
71
109
|
- **Business Value**: Metric, persona, roadmap phase (consult metaspecs)
|
|
72
|
-
- **Scope**: What
|
|
110
|
+
- **Scope**: What IS included and what IS NOT included
|
|
73
111
|
- **Affected Components**: List based on current architecture (consult technical metaspecs)
|
|
74
112
|
- **Validation against Metaspecs**: ✅ Approved / ⚠️ Attention needed
|
|
75
113
|
- **Effort Estimate**: Small (< 1 day) / Medium (1-3 days) / Large (3-5 days) / Very Large (> 5 days)
|
|
76
114
|
|
|
77
|
-
**Complexity Assessment and Suggestion to
|
|
115
|
+
**Complexity Assessment and Suggestion to Split**:
|
|
78
116
|
|
|
79
|
-
**If
|
|
80
|
-
- 🚨 **Suggest
|
|
81
|
-
- Explain the rationale for
|
|
82
|
-
- Propose a **logical**
|
|
117
|
+
**If implementation seems large** (> 5 days estimated effort):
|
|
118
|
+
- 🚨 **Suggest splitting into multiple smaller issues**
|
|
119
|
+
- Explain the rationale for splitting (e.g., "This feature involves 3 distinct areas that can be implemented independently")
|
|
120
|
+
- Propose a **logical** split based on:
|
|
83
121
|
- Independent functionalities
|
|
84
122
|
- Different repositories
|
|
85
123
|
- Application layers (backend, frontend, infra)
|
|
86
124
|
- Implementation phases (MVP, improvements, optimizations)
|
|
87
|
-
- Example
|
|
125
|
+
- Example split:
|
|
88
126
|
```
|
|
89
127
|
Original Issue: "Multi-channel notification system"
|
|
90
128
|
|
|
91
|
-
Suggested
|
|
129
|
+
Suggested Split:
|
|
92
130
|
- FIN-201: Queue and worker infrastructure (backend)
|
|
93
131
|
- FIN-202: Email notifications (backend + templates)
|
|
94
132
|
- FIN-203: Push notifications (backend + mobile)
|
|
95
133
|
- FIN-204: Notification preferences (frontend + backend)
|
|
96
134
|
```
|
|
97
|
-
- **Important**:
|
|
135
|
+
- **Important**: Final decision is the user's - they may accept the split or keep it as a single issue
|
|
98
136
|
|
|
99
|
-
**If the user accepts the
|
|
137
|
+
**If the user accepts the split**:
|
|
100
138
|
- Document each issue separately
|
|
101
139
|
- Add cross-references between related issues
|
|
102
140
|
- Suggest implementation order if dependencies exist
|
|
103
|
-
- Each
|
|
141
|
+
- Each split issue must go through the same refinement process
|
|
104
142
|
|
|
105
|
-
Request user approval and incorporate feedback if
|
|
143
|
+
Request user approval and incorporate feedback if needed.
|
|
106
144
|
|
|
107
|
-
**Tip**: You may search the codebase or internet before finalizing, if
|
|
145
|
+
**Tip**: You may search the codebase or internet before finalizing, if necessary.
|
|
108
146
|
|
|
109
147
|
### 4. Saving the Refined Requirements
|
|
110
148
|
|
|
@@ -131,23 +169,23 @@ Once the user approves, save the requirements:
|
|
|
131
169
|
- **ALWAYS overwrite** the existing body (do not append)
|
|
132
170
|
|
|
133
171
|
**Note**:
|
|
134
|
-
-
|
|
172
|
+
- Local backup is ALWAYS saved and complete
|
|
135
173
|
- If API error occurs, manually verify if the issue was updated in the task manager
|
|
136
174
|
|
|
137
175
|
**Output Template**:
|
|
138
176
|
|
|
139
|
-
**IMPORTANT**: The standard template for refined requirements may be documented in the metaspecs repository.
|
|
177
|
+
**IMPORTANT**: The standard template for refined requirements may be documented in the metaspecs repository. Consult `{base_path}/{metaspecs-id}/specs/refined/` or similar.
|
|
140
178
|
|
|
141
179
|
**FULL Template** (for local backup `.sessions/<ISSUE-ID>/refined.md`):
|
|
142
180
|
- **Metadata**: Issue, ID, Task Manager, Project, Date, Sprint, Priority
|
|
143
181
|
- **🎯 WHY**: Reasons, business value, metric, persona, strategic alignment
|
|
144
182
|
- **📦 WHAT**: Detailed features, affected components, integrations, full negative scope
|
|
145
|
-
- **🔧 HOW**: Stack, coding
|
|
183
|
+
- **🔧 HOW**: Stack, coding patterns, file structure, dependencies, implementation order, failure modes, performance/cost/UX considerations
|
|
146
184
|
- **✅ Validation against Metaspecs**: Consulted documents (business and technical), verified ADRs, validation result
|
|
147
185
|
- **📊 Success Metrics**: Technical, product/UX, acceptance criteria
|
|
148
186
|
- **🔄 Product Impact**: Alignment with objectives, enablers, mitigated risks
|
|
149
187
|
- **⚠️ Known Limitations**: MVP limitations
|
|
150
|
-
- **📝 Implementation Checklist**: Tasks by area (backend, frontend,
|
|
188
|
+
- **📝 Implementation Checklist**: Tasks by area (backend, frontend, tests, security, etc.)
|
|
151
189
|
|
|
152
190
|
**Task Manager Template**:
|
|
153
191
|
```markdown
|
|
@@ -155,7 +193,7 @@ Once the user approves, save the requirements:
|
|
|
155
193
|
|
|
156
194
|
**Sprint X** | **Y days** | **Priority**
|
|
157
195
|
|
|
158
|
-
##
|
|
196
|
+
## Goal
|
|
159
197
|
[1-2 paragraphs: what it is and why]
|
|
160
198
|
|
|
161
199
|
## Scope
|
|
@@ -176,12 +214,12 @@ Once the user approves, save the requirements:
|
|
|
176
214
|
❌ [item 1] ❌ [item 2] ❌ [item 3]
|
|
177
215
|
|
|
178
216
|
## Stack
|
|
179
|
-
[Tech stack
|
|
217
|
+
[Tech stack summarized by area]
|
|
180
218
|
|
|
181
219
|
## Structure
|
|
182
220
|
[SUMMARIZED file tree - main modules only]
|
|
183
221
|
|
|
184
|
-
## Failure Modes (
|
|
222
|
+
## Failure Modes (Avoid)
|
|
185
223
|
🔴 [critical 1] 🔴 [critical 2]
|
|
186
224
|
🟡 [medium 1] 🟡 [medium 2]
|
|
187
225
|
|
|
@@ -224,4 +262,4 @@ Once the user approves, save the requirements:
|
|
|
224
262
|
|
|
225
263
|
**Example**: `/spec FIN-3`
|
|
226
264
|
|
|
227
|
-
This command will create a
|
|
265
|
+
This command will create a PRD (Product Requirements Document) complete based on the refined requirements, detailing features, user stories, acceptance criteria, and final validations.
|
|
@@ -6,17 +6,54 @@ This command creates the complete specification (Product Requirements Document)
|
|
|
6
6
|
|
|
7
7
|
**This command is ONLY for requirements documentation:**
|
|
8
8
|
- ✅ Create PRD (Product Requirements Document)
|
|
9
|
-
- ✅ Update issue in task manager via MCP
|
|
9
|
+
- ✅ Update issue in the task manager via MCP
|
|
10
10
|
- ✅ **READ** files from main repositories (read-only)
|
|
11
11
|
- ❌ **DO NOT implement code**
|
|
12
12
|
- ❌ **DO NOT edit code files**
|
|
13
13
|
- ❌ **DO NOT checkout branches in main repositories**
|
|
14
|
-
- ❌ **DO NOT
|
|
14
|
+
- ❌ **DO NOT make commits**
|
|
15
15
|
|
|
16
16
|
**Next step**: `/start` to begin development.
|
|
17
17
|
|
|
18
18
|
---
|
|
19
19
|
|
|
20
|
+
## 📋 Project Configuration
|
|
21
|
+
|
|
22
|
+
**⚠️ IMPORTANT: Always read the project configuration files BEFORE running this command!**
|
|
23
|
+
|
|
24
|
+
### Mandatory Files
|
|
25
|
+
|
|
26
|
+
1. **`context-manifest.json`** (orchestrator root)
|
|
27
|
+
- List of project repositories
|
|
28
|
+
- Roles of each repository (metaspecs, application, etc.)
|
|
29
|
+
- URLs and dependencies between repositories
|
|
30
|
+
|
|
31
|
+
2. **`ai.properties.md`** (orchestrator root)
|
|
32
|
+
- Project settings (`project_name`, `base_path`)
|
|
33
|
+
- Task management system (`task_management_system`)
|
|
34
|
+
- Credentials and specific configurations
|
|
35
|
+
|
|
36
|
+
### How to Read
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
# 1. Read context-manifest.json
|
|
40
|
+
cat context-manifest.json
|
|
41
|
+
|
|
42
|
+
# 2. Read ai.properties.md
|
|
43
|
+
cat ai.properties.md
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Essential Information
|
|
47
|
+
|
|
48
|
+
After reading the files, you will have:
|
|
49
|
+
- ✅ Complete list of project repositories
|
|
50
|
+
- ✅ Location of the metaspecs repository
|
|
51
|
+
- ✅ Base path to locate repositories
|
|
52
|
+
- ✅ Configured task management system
|
|
53
|
+
- ✅ Project-specific configurations
|
|
54
|
+
|
|
55
|
+
**🛑 DO NOT proceed without reading these files!** They contain critical information for correct command execution.
|
|
56
|
+
|
|
20
57
|
## 📋 Prerequisites
|
|
21
58
|
|
|
22
59
|
- Issue refined via `/refine`
|
|
@@ -29,7 +66,7 @@ This command creates the complete specification (Product Requirements Document)
|
|
|
29
66
|
2. Find the repository with `"role": "metaspecs"`
|
|
30
67
|
3. Read `ai.properties.md` to get the `base_path`
|
|
31
68
|
4. The metaspecs are located at: `{base_path}/{metaspecs-repo-id}/`
|
|
32
|
-
5. Read
|
|
69
|
+
5. Read relevant `index.md` files to ensure compliance with:
|
|
33
70
|
- System architecture
|
|
34
71
|
- Design patterns
|
|
35
72
|
- Technical constraints
|
|
@@ -133,7 +170,7 @@ Create a complete PRD that will serve as the single source of truth for implemen
|
|
|
133
170
|
- **External**: [external APIs, if any]
|
|
134
171
|
|
|
135
172
|
### Data Model
|
|
136
|
-
[Describe changes to
|
|
173
|
+
[Describe changes to data model, if any]
|
|
137
174
|
```
|
|
138
175
|
|
|
139
176
|
### 6. Acceptance Criteria
|
|
@@ -162,7 +199,7 @@ Create a complete PRD that will serve as the single source of truth for implemen
|
|
|
162
199
|
```markdown
|
|
163
200
|
## Out of Scope
|
|
164
201
|
|
|
165
|
-
Features that
|
|
202
|
+
Features that will NOT be implemented in this version:
|
|
166
203
|
- [Item 1]
|
|
167
204
|
- [Item 2]
|
|
168
205
|
|