@dedesfr/prompter 0.6.7 → 0.6.8
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/cli/index.js +1 -1
- package/package.json +1 -1
- package/prompt/epic-generator.md +67 -32
- package/prompt/story-generator.md +82 -20
- package/src/cli/index.ts +1 -1
package/dist/cli/index.js
CHANGED
package/package.json
CHANGED
package/prompt/epic-generator.md
CHANGED
|
@@ -66,76 +66,111 @@ For each identified EPIC, define:
|
|
|
66
66
|
|
|
67
67
|
# Output Format
|
|
68
68
|
|
|
69
|
-
##
|
|
69
|
+
## Directory Structure
|
|
70
|
+
Create an `epics/` folder with the following structure:
|
|
71
|
+
```
|
|
72
|
+
epics/
|
|
73
|
+
├── README.md # Executive summary and index
|
|
74
|
+
├── EPIC-001-[kebab-case-title].md
|
|
75
|
+
├── EPIC-002-[kebab-case-title].md
|
|
76
|
+
├── EPIC-003-[kebab-case-title].md
|
|
77
|
+
└── ...
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## File: `epics/README.md`
|
|
81
|
+
|
|
82
|
+
### Executive Summary
|
|
70
83
|
- Total EPICs identified: [number]
|
|
71
84
|
- Complexity distribution: [High/Medium/Low counts]
|
|
72
85
|
- Key dependencies identified: [summary]
|
|
73
86
|
- Coverage gaps or conflicts: [if any]
|
|
74
87
|
|
|
75
|
-
|
|
88
|
+
### EPIC Index
|
|
89
|
+
| EPIC ID | Title | Complexity | Dependencies | File |
|
|
90
|
+
|---------|-------|------------|--------------|------|
|
|
91
|
+
| EPIC-001 | [Title] | [S/M/L/XL] | [EPIC-XXX] | [Link to file] |
|
|
92
|
+
| EPIC-002 | [Title] | [S/M/L/XL] | [EPIC-XXX] | [Link to file] |
|
|
76
93
|
|
|
77
|
-
###
|
|
94
|
+
### Dependency Map
|
|
95
|
+
[Visual or text representation of EPIC dependencies]
|
|
96
|
+
```
|
|
97
|
+
EPIC-001 ──► EPIC-003
|
|
98
|
+
EPIC-002 ──► EPIC-003
|
|
99
|
+
EPIC-003 ──► EPIC-005
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Traceability Matrix
|
|
103
|
+
| Requirement ID | FSD Section | TDD Component | Wireframe | EPIC |
|
|
104
|
+
|----------------|-------------|---------------|-----------|------|
|
|
105
|
+
| [REQ-001] | [Section] | [Component] | [Screen] | [EPIC-XXX] |
|
|
106
|
+
|
|
107
|
+
### Gaps & Recommendations
|
|
108
|
+
1. **Identified Gaps:** [Requirements not fully covered]
|
|
109
|
+
2. **Conflicts Found:** [Contradictions between documents]
|
|
110
|
+
3. **Recommendations:** [Suggested clarifications needed]
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Individual EPIC Files
|
|
115
|
+
|
|
116
|
+
**File naming convention:** `EPIC-[XXX]-[kebab-case-title].md`
|
|
117
|
+
Example: `EPIC-001-user-authentication.md`
|
|
118
|
+
|
|
119
|
+
### Template for Each EPIC File
|
|
78
120
|
|
|
79
|
-
|
|
121
|
+
```markdown
|
|
122
|
+
# EPIC-[XXX]: [EPIC Title]
|
|
123
|
+
|
|
124
|
+
## Business Value Statement
|
|
80
125
|
[2-3 sentences describing the business outcome and user benefit]
|
|
81
126
|
|
|
82
|
-
|
|
127
|
+
## Description
|
|
83
128
|
[Detailed description of what this EPIC delivers]
|
|
84
129
|
|
|
85
|
-
|
|
130
|
+
## Source Traceability
|
|
86
131
|
| Document | Reference | Section/Page |
|
|
87
132
|
|----------|-----------|--------------|
|
|
88
133
|
| FSD | [Requirement ID] | [Location] |
|
|
89
134
|
| TDD | [Component/Section] | [Location] |
|
|
90
135
|
| Wireframe | [Screen Name] | [If applicable] |
|
|
91
136
|
|
|
92
|
-
|
|
137
|
+
## Scope Definition
|
|
93
138
|
| In Scope | Out of Scope |
|
|
94
139
|
|----------|--------------|
|
|
95
140
|
| [Item 1] | [Item 1] |
|
|
96
141
|
| [Item 2] | [Item 2] |
|
|
97
142
|
|
|
98
|
-
|
|
143
|
+
## High-Level Acceptance Criteria
|
|
99
144
|
- [ ] [Criterion 1]
|
|
100
145
|
- [ ] [Criterion 2]
|
|
101
146
|
- [ ] [Criterion 3]
|
|
102
147
|
- [ ] [Criterion 4]
|
|
103
148
|
|
|
104
|
-
|
|
149
|
+
## Dependencies
|
|
105
150
|
- **Prerequisite EPICs:** [EPIC-XXX, EPIC-XXX] or None
|
|
106
151
|
- **External Dependencies:** [Systems, teams, data]
|
|
107
152
|
- **Technical Prerequisites:** [Infrastructure, APIs, etc.]
|
|
108
153
|
|
|
109
|
-
|
|
154
|
+
## Complexity Assessment
|
|
110
155
|
- **Size:** [S / M / L / XL]
|
|
111
156
|
- **Technical Complexity:** [Low / Medium / High]
|
|
112
157
|
- **Integration Complexity:** [Low / Medium / High]
|
|
113
158
|
- **Estimated Story Count:** [Range]
|
|
114
159
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
-
|
|
118
|
-
|
|
119
|
-
---
|
|
120
|
-
|
|
121
|
-
[Repeat for each EPIC]
|
|
122
|
-
|
|
123
|
-
## Dependency Map
|
|
124
|
-
|
|
125
|
-
[Visual or text representation of EPIC dependencies]
|
|
126
|
-
EPIC-001 ──► EPIC-003
|
|
127
|
-
EPIC-002 ──► EPIC-003
|
|
128
|
-
EPIC-003 ──► EPIC-005
|
|
160
|
+
## Risks & Assumptions
|
|
161
|
+
**Assumptions:**
|
|
162
|
+
- [Assumption 1]
|
|
163
|
+
- [Assumption 2]
|
|
129
164
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
| [REQ-001] | [Section] | [Component] | [Screen] | [EPIC-XXX] |
|
|
165
|
+
**Risks:**
|
|
166
|
+
- [Risk 1]
|
|
167
|
+
- [Risk 2]
|
|
134
168
|
|
|
135
|
-
##
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
169
|
+
## Related EPICs
|
|
170
|
+
- **Depends On:** [EPIC-XXX]
|
|
171
|
+
- **Blocks:** [EPIC-XXX]
|
|
172
|
+
- **Related:** [EPIC-XXX]
|
|
173
|
+
```
|
|
139
174
|
|
|
140
175
|
# Quality Standards
|
|
141
176
|
- Every functional requirement must map to at least one EPIC
|
|
@@ -53,24 +53,75 @@ Generate comprehensive user stories from provided Epics, enriched with details f
|
|
|
53
53
|
|
|
54
54
|
# Output Requirements
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
## Directory Structure
|
|
57
|
+
Create a `stories/` folder organized by Epic:
|
|
58
|
+
```
|
|
59
|
+
stories/
|
|
60
|
+
├── EPIC-001-[kebab-case-title]/
|
|
61
|
+
│ ├── README.md # Epic summary and story index
|
|
62
|
+
│ ├── STORY-001-[kebab-case-title].md
|
|
63
|
+
│ ├── STORY-002-[kebab-case-title].md
|
|
64
|
+
│ └── ...
|
|
65
|
+
├── EPIC-002-[kebab-case-title]/
|
|
66
|
+
│ ├── README.md
|
|
67
|
+
│ ├── STORY-001-[kebab-case-title].md
|
|
68
|
+
│ └── ...
|
|
69
|
+
└── ...
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## File: `stories/EPIC-[XXX]-[title]/README.md`
|
|
73
|
+
|
|
74
|
+
### Epic Summary
|
|
75
|
+
**Epic ID:** EPIC-[XXX]
|
|
76
|
+
**Epic Title:** [Epic Name]
|
|
77
|
+
**Epic Description:** [Brief description from Epic]
|
|
78
|
+
|
|
79
|
+
### Story Index
|
|
80
|
+
| Story ID | Title | Priority | Story Points | Status | File |
|
|
81
|
+
|----------|-------|----------|--------------|--------|------|
|
|
82
|
+
| STORY-001 | [Title] | Must Have | 5 | Not Started | [Link] |
|
|
83
|
+
| STORY-002 | [Title] | Should Have | 3 | Not Started | [Link] |
|
|
84
|
+
|
|
85
|
+
### Story Dependency Map
|
|
86
|
+
```
|
|
87
|
+
STORY-001 ──► STORY-003
|
|
88
|
+
STORY-002 ──► STORY-003
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Total Estimates
|
|
92
|
+
- **Total Story Points:** [Sum]
|
|
93
|
+
- **Must Have:** [Points]
|
|
94
|
+
- **Should Have:** [Points]
|
|
95
|
+
- **Could Have:** [Points]
|
|
57
96
|
|
|
58
97
|
---
|
|
59
98
|
|
|
60
|
-
##
|
|
99
|
+
## Individual Story Files
|
|
61
100
|
|
|
62
|
-
|
|
101
|
+
**File naming convention:** `STORY-[XXX]-[kebab-case-title].md`
|
|
102
|
+
Example: `STORY-001-user-login-email.md`
|
|
63
103
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
104
|
+
### Template for Each Story File
|
|
105
|
+
|
|
106
|
+
```markdown
|
|
107
|
+
# STORY-[XXX]: [Concise Story Title]
|
|
108
|
+
|
|
109
|
+
**Epic:** [EPIC-XXX - Epic Name]
|
|
110
|
+
**Story Points:** [Fibonacci estimate: 1, 2, 3, 5, 8, 13]
|
|
111
|
+
**Priority:** [Must Have / Should Have / Could Have / Won't Have]
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## User Story
|
|
116
|
+
As a [specific user role],
|
|
117
|
+
I want to [action/capability],
|
|
67
118
|
So that [business value/outcome].
|
|
68
119
|
|
|
69
|
-
|
|
120
|
+
## Description
|
|
70
121
|
[2-3 sentences providing additional context, referencing FSD sections where applicable]
|
|
71
122
|
|
|
72
|
-
|
|
73
|
-
gherkin
|
|
123
|
+
## Acceptance Criteria
|
|
124
|
+
```gherkin
|
|
74
125
|
GIVEN [precondition/context]
|
|
75
126
|
WHEN [action/trigger]
|
|
76
127
|
THEN [expected outcome]
|
|
@@ -78,23 +129,34 @@ THEN [expected outcome]
|
|
|
78
129
|
GIVEN [precondition/context]
|
|
79
130
|
WHEN [alternative action]
|
|
80
131
|
THEN [expected outcome]
|
|
132
|
+
```
|
|
81
133
|
|
|
82
|
-
|
|
83
|
-
- BR-1
|
|
84
|
-
- BR-2
|
|
134
|
+
## Business Rules
|
|
135
|
+
- **BR-1:** [Rule from FSD]
|
|
136
|
+
- **BR-2:** [Rule from FSD]
|
|
85
137
|
|
|
86
|
-
|
|
138
|
+
## Technical Notes
|
|
87
139
|
- [Integration requirements]
|
|
88
140
|
- [Data considerations]
|
|
89
141
|
- [API/System dependencies]
|
|
90
142
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
**
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
**
|
|
143
|
+
## Traceability
|
|
144
|
+
- **FSD Reference:** [Section/Requirement IDs traced from FSD]
|
|
145
|
+
- **Epic:** [EPIC-XXX]
|
|
146
|
+
|
|
147
|
+
## Dependencies
|
|
148
|
+
- **Depends On:** [STORY-XXX, STORY-XXX] or None
|
|
149
|
+
- **Blocks:** [STORY-XXX] or None
|
|
150
|
+
- **External Dependencies:** [Systems, APIs, etc.]
|
|
151
|
+
|
|
152
|
+
## Definition of Done
|
|
153
|
+
- [ ] Code implemented and peer-reviewed
|
|
154
|
+
- [ ] Unit tests written and passing
|
|
155
|
+
- [ ] Integration tests passing
|
|
156
|
+
- [ ] Documentation updated
|
|
157
|
+
- [ ] Acceptance criteria verified
|
|
158
|
+
- [ ] Code merged to main branch
|
|
159
|
+
```
|
|
98
160
|
|
|
99
161
|
---
|
|
100
162
|
|