@dedesfr/prompter 0.9.0 → 1.0.0

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.
Files changed (216) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/README.md +105 -77
  3. package/dist/cli/index.js +25 -1
  4. package/dist/cli/index.js.map +1 -1
  5. package/dist/commands/init.d.ts.map +1 -1
  6. package/dist/commands/init.js +32 -9
  7. package/dist/commands/init.js.map +1 -1
  8. package/dist/commands/login.d.ts +4 -0
  9. package/dist/commands/login.d.ts.map +1 -0
  10. package/dist/commands/login.js +56 -0
  11. package/dist/commands/login.js.map +1 -0
  12. package/dist/commands/logout.d.ts +4 -0
  13. package/dist/commands/logout.d.ts.map +1 -0
  14. package/dist/commands/logout.js +14 -0
  15. package/dist/commands/logout.js.map +1 -0
  16. package/dist/commands/update.d.ts.map +1 -1
  17. package/dist/commands/update.js +18 -5
  18. package/dist/commands/update.js.map +1 -1
  19. package/dist/commands/whoami.d.ts +4 -0
  20. package/dist/commands/whoami.d.ts.map +1 -0
  21. package/dist/commands/whoami.js +42 -0
  22. package/dist/commands/whoami.js.map +1 -0
  23. package/dist/core/auth-store.d.ts +10 -0
  24. package/dist/core/auth-store.d.ts.map +1 -0
  25. package/dist/core/auth-store.js +39 -0
  26. package/dist/core/auth-store.js.map +1 -0
  27. package/dist/core/registry.d.ts +18 -0
  28. package/dist/core/registry.d.ts.map +1 -0
  29. package/dist/core/registry.js +94 -0
  30. package/dist/core/registry.js.map +1 -0
  31. package/package.json +7 -1
  32. package/AGENTS.md +0 -123
  33. package/CLAUDE.md +0 -17
  34. package/build.js +0 -20
  35. package/convex-setup.md +0 -403
  36. package/prompt/ai-humanizer.md +0 -45
  37. package/prompt/api-contract-generator.md +0 -234
  38. package/prompt/apply.md +0 -17
  39. package/prompt/archive.md +0 -21
  40. package/prompt/design-system.md +0 -210
  41. package/prompt/document-explainer.md +0 -149
  42. package/prompt/epic-generator.md +0 -198
  43. package/prompt/epic-single.md +0 -47
  44. package/prompt/erd-generator.md +0 -130
  45. package/prompt/fsd-generator.md +0 -157
  46. package/prompt/prd-agent-generator.md +0 -147
  47. package/prompt/prd-generator.md +0 -195
  48. package/prompt/product-brief.md +0 -289
  49. package/prompt/proposal.md +0 -22
  50. package/prompt/qa-test-scenario.md +0 -133
  51. package/prompt/skill-creator.md +0 -350
  52. package/prompt/story-generator.md +0 -278
  53. package/prompt/story-single.md +0 -70
  54. package/prompt/tdd-generator.md +0 -294
  55. package/prompt/tdd-lite-generator.md +0 -224
  56. package/prompt/wireframe-generator.md +0 -219
  57. package/skills/ai-context-generator/SKILL.md +0 -54
  58. package/skills/ai-context-generator/references/AGENTS.template.md +0 -83
  59. package/skills/ai-context-generator/references/CLAUDE.template.md +0 -39
  60. package/skills/ai-context-generator/references/behavioral-guidelines.md +0 -71
  61. package/skills/ai-context-generator/references/discovery-checklist.md +0 -40
  62. package/skills/ai-context-generator/references/examples/AGENTS.good.md +0 -103
  63. package/skills/ai-context-generator/references/extraction-checklist.md +0 -23
  64. package/skills/ai-context-generator/references/overlays/laravel.md +0 -44
  65. package/skills/ai-humanizer/SKILL.md +0 -50
  66. package/skills/api-contract-generator/SKILL.md +0 -243
  67. package/skills/apply/SKILL.md +0 -23
  68. package/skills/archive/SKILL.md +0 -27
  69. package/skills/cerebro/SKILL.md +0 -187
  70. package/skills/cerebro/references/agents.md +0 -213
  71. package/skills/code-review/SKILL.md +0 -373
  72. package/skills/code-review/assets/report-template-agent.md +0 -212
  73. package/skills/code-review/assets/report-template-compact.md +0 -81
  74. package/skills/code-review/assets/report-template-full.md +0 -264
  75. package/skills/code-review/assets/report-template-human.md +0 -168
  76. package/skills/code-review/references/universal-patterns.md +0 -495
  77. package/skills/design-md/README.md +0 -34
  78. package/skills/design-md/SKILL.md +0 -172
  79. package/skills/design-md/examples/DESIGN.md +0 -154
  80. package/skills/design-system/SKILL.md +0 -216
  81. package/skills/design-system-generator/SKILL.md +0 -324
  82. package/skills/design-system-generator/assets/design-system-template.md +0 -348
  83. package/skills/design-system-generator/references/extraction-patterns.md +0 -321
  84. package/skills/doc-builder/SKILL.md +0 -115
  85. package/skills/doc-builder/references/ui-patterns.md +0 -394
  86. package/skills/document-explainer/SKILL.md +0 -155
  87. package/skills/document-translator/SKILL.md +0 -58
  88. package/skills/enhance/SKILL.md +0 -47
  89. package/skills/enhance-prompt/README.md +0 -34
  90. package/skills/enhance-prompt/SKILL.md +0 -204
  91. package/skills/enhance-prompt/references/KEYWORDS.md +0 -114
  92. package/skills/epic-generator/SKILL.md +0 -204
  93. package/skills/epic-single/SKILL.md +0 -63
  94. package/skills/erd-generator/SKILL.md +0 -138
  95. package/skills/feature-planner/SKILL.md +0 -305
  96. package/skills/feature-planner/assets/implementation-plan-template.md +0 -85
  97. package/skills/frontend-design/LICENSE.txt +0 -177
  98. package/skills/frontend-design/SKILL.md +0 -42
  99. package/skills/fsd-generator/SKILL.md +0 -163
  100. package/skills/gamma-builder/SKILL.md +0 -134
  101. package/skills/laravel-code-review/SKILL.md +0 -383
  102. package/skills/laravel-code-review/assets/report-template-agent.md +0 -195
  103. package/skills/laravel-code-review/assets/report-template-compact.md +0 -79
  104. package/skills/laravel-code-review/assets/report-template-full.md +0 -253
  105. package/skills/laravel-code-review/assets/report-template-human.md +0 -159
  106. package/skills/laravel-code-review/references/laravel-patterns.md +0 -571
  107. package/skills/laravel-code-review/references/php84-features.md +0 -442
  108. package/skills/mcp-builder/LICENSE.txt +0 -202
  109. package/skills/mcp-builder/SKILL.md +0 -236
  110. package/skills/mcp-builder/reference/evaluation.md +0 -602
  111. package/skills/mcp-builder/reference/mcp_best_practices.md +0 -249
  112. package/skills/mcp-builder/reference/node_mcp_server.md +0 -970
  113. package/skills/mcp-builder/reference/python_mcp_server.md +0 -719
  114. package/skills/mcp-builder/scripts/connections.py +0 -151
  115. package/skills/mcp-builder/scripts/evaluation.py +0 -373
  116. package/skills/mcp-builder/scripts/example_evaluation.xml +0 -22
  117. package/skills/mcp-builder/scripts/requirements.txt +0 -2
  118. package/skills/meeting-notes/SKILL.md +0 -159
  119. package/skills/meeting-notes/evals/evals.json +0 -23
  120. package/skills/prd-agent-generator/SKILL.md +0 -132
  121. package/skills/prd-generator/SKILL.md +0 -211
  122. package/skills/product-brief/SKILL.md +0 -141
  123. package/skills/project-orchestrator/SKILL.md +0 -487
  124. package/skills/project-orchestrator/assets/caddy-vps-setup.md +0 -180
  125. package/skills/project-orchestrator/assets/plan-summary-template.md +0 -159
  126. package/skills/prompter-specs/SKILL.md +0 -115
  127. package/skills/prompter-workflow/SKILL.md +0 -166
  128. package/skills/prompter-workflow/evals/evals.json +0 -89
  129. package/skills/proposal/SKILL.md +0 -28
  130. package/skills/qa-test-scenario/SKILL.md +0 -149
  131. package/skills/skill-creator/SKILL.md +0 -173
  132. package/skills/sph-generator/SKILL.md +0 -488
  133. package/skills/story-generator/SKILL.md +0 -285
  134. package/skills/story-single/SKILL.md +0 -86
  135. package/skills/tdd-generator/SKILL.md +0 -300
  136. package/skills/tdd-lite-generator/SKILL.md +0 -230
  137. package/skills/ui-ux-pro/SKILL.md +0 -199
  138. package/skills/ui-ux-pro/assets/design-spec-template.md +0 -173
  139. package/skills/ui-ux-pro/references/component-patterns.md +0 -255
  140. package/skills/ui-ux-pro/references/design-principles.md +0 -167
  141. package/skills/wireframe-generator/SKILL.md +0 -227
  142. package/src/cli/index.ts +0 -223
  143. package/src/commands/archive.ts +0 -302
  144. package/src/commands/change.ts +0 -292
  145. package/src/commands/config.ts +0 -233
  146. package/src/commands/guide.ts +0 -50
  147. package/src/commands/init.ts +0 -597
  148. package/src/commands/list.ts +0 -194
  149. package/src/commands/show.ts +0 -138
  150. package/src/commands/spec.ts +0 -251
  151. package/src/commands/update.ts +0 -129
  152. package/src/commands/upgrade.ts +0 -30
  153. package/src/commands/validate.ts +0 -326
  154. package/src/core/artifact-graph/graph.ts +0 -167
  155. package/src/core/artifact-graph/index.ts +0 -44
  156. package/src/core/artifact-graph/instruction-loader.ts +0 -302
  157. package/src/core/artifact-graph/resolver.ts +0 -226
  158. package/src/core/artifact-graph/schema.ts +0 -124
  159. package/src/core/artifact-graph/state.ts +0 -64
  160. package/src/core/artifact-graph/types.ts +0 -65
  161. package/src/core/completions/command-registry.ts +0 -382
  162. package/src/core/completions/completion-provider.ts +0 -128
  163. package/src/core/completions/generators/bash-generator.ts +0 -191
  164. package/src/core/completions/generators/fish-generator.ts +0 -188
  165. package/src/core/completions/generators/powershell-generator.ts +0 -223
  166. package/src/core/completions/generators/zsh-generator.ts +0 -281
  167. package/src/core/completions/templates/bash-templates.ts +0 -24
  168. package/src/core/completions/templates/fish-templates.ts +0 -40
  169. package/src/core/completions/templates/powershell-templates.ts +0 -25
  170. package/src/core/completions/templates/zsh-templates.ts +0 -36
  171. package/src/core/completions/types.ts +0 -90
  172. package/src/core/config-schema.ts +0 -230
  173. package/src/core/config.ts +0 -181
  174. package/src/core/configurators/slash/antigravity.ts +0 -10
  175. package/src/core/configurators/slash/base.ts +0 -109
  176. package/src/core/configurators/slash/claude.ts +0 -10
  177. package/src/core/configurators/slash/codex.ts +0 -10
  178. package/src/core/configurators/slash/droid.ts +0 -10
  179. package/src/core/configurators/slash/forge.ts +0 -10
  180. package/src/core/configurators/slash/github-copilot.ts +0 -10
  181. package/src/core/configurators/slash/index.ts +0 -10
  182. package/src/core/configurators/slash/kilocode.ts +0 -10
  183. package/src/core/configurators/slash/opencode.ts +0 -10
  184. package/src/core/configurators/slash/registry.ts +0 -51
  185. package/src/core/converters/json-converter.ts +0 -62
  186. package/src/core/global-config.ts +0 -136
  187. package/src/core/parsers/change-parser.ts +0 -234
  188. package/src/core/parsers/markdown-parser.ts +0 -237
  189. package/src/core/parsers/requirement-blocks.ts +0 -234
  190. package/src/core/prompt-templates.ts +0 -3504
  191. package/src/core/schemas/base.schema.ts +0 -20
  192. package/src/core/schemas/change.schema.ts +0 -42
  193. package/src/core/schemas/index.ts +0 -20
  194. package/src/core/schemas/spec.schema.ts +0 -17
  195. package/src/core/skill-discovery.ts +0 -68
  196. package/src/core/specs-apply.ts +0 -483
  197. package/src/core/styles/palette.ts +0 -8
  198. package/src/core/templates/agents-template.ts +0 -459
  199. package/src/core/templates/claude-template.ts +0 -2
  200. package/src/core/templates/index.ts +0 -3
  201. package/src/core/templates/project-template.ts +0 -32
  202. package/src/core/validation/constants.ts +0 -48
  203. package/src/core/validation/types.ts +0 -19
  204. package/src/core/validation/validator.ts +0 -449
  205. package/src/core/view.ts +0 -219
  206. package/src/index.ts +0 -1
  207. package/src/utils/change-metadata.ts +0 -171
  208. package/src/utils/change-utils.ts +0 -131
  209. package/src/utils/file-system.ts +0 -252
  210. package/src/utils/index.ts +0 -12
  211. package/src/utils/interactive.ts +0 -29
  212. package/src/utils/item-discovery.ts +0 -66
  213. package/src/utils/match.ts +0 -26
  214. package/src/utils/shell-detection.ts +0 -62
  215. package/src/utils/task-progress.ts +0 -43
  216. package/tsconfig.json +0 -28
package/prompt/archive.md DELETED
@@ -1,21 +0,0 @@
1
- <!-- PROMPTER:START -->
2
- **Guardrails**
3
- - Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
4
- - Keep changes tightly scoped to the requested outcome.
5
- - Refer to `prompter/AGENTS.md` (located inside the `prompter/` directory—run `ls prompter` if you don't see it) if you need additional Prompter conventions or clarifications.
6
-
7
- **Steps**
8
- 1. Determine the change ID to archive:
9
- - If this prompt already includes a specific change ID (for example inside a `<ChangeId>` block populated by slash-command arguments), use that value after trimming whitespace.
10
- - If the conversation references a change loosely (for example by title or summary), run `prompter list` to surface likely IDs, share the relevant candidates, and confirm which one the user intends.
11
- - Otherwise, review the conversation, run `prompter list`, and ask the user which change to archive; wait for a confirmed change ID before proceeding.
12
- - If you still cannot identify a single change ID, stop and tell the user you cannot archive anything yet.
13
- 2. Validate the change ID by running `prompter list` (or `prompter show <id>`) and stop if the change is missing, already archived, or otherwise not ready to archive.
14
- 3. Run `prompter archive <id> --yes` so the CLI moves the change and applies spec updates without prompts (use `--skip-specs` only for tooling-only work).
15
- 4. Review the command output to confirm the target specs were updated and the change landed in `changes/archive/`.
16
- 5. Validate with `prompter validate --strict` and inspect with `prompter show <id>` if anything looks off.
17
-
18
- **Reference**
19
- - Use `prompter list` to confirm change IDs before archiving.
20
- - Inspect refreshed specs with `prompter list --specs` and address any validation issues before handing off.
21
- <!-- PROMPTER:END -->
@@ -1,210 +0,0 @@
1
- # Design System Documentation Generator
2
-
3
- You are a senior design systems architect and technical writer with expertise in creating comprehensive, developer-friendly design system documentation. You combine deep knowledge of UI/UX principles, component architecture, and documentation best practices.
4
-
5
- ## Context
6
-
7
- Design system documentation serves as the single source of truth for designers, developers, and stakeholders. It must be technically precise yet accessible, with clear examples and implementation guidance. Your documentation will enable consistent implementation across teams and platforms.
8
-
9
- ## Primary Objective
10
-
11
- Generate complete, professional design system documentation that covers all aspects of a component, token set, pattern, or system element—from design rationale to implementation code.
12
-
13
- ## Documentation Process
14
-
15
- 1. **Analyze the Design Element**
16
- - Identify the element type (component, token, pattern, layout)
17
- - Determine its purpose and use cases
18
- - Map relationships to other system elements
19
-
20
- 2. **Structure the Documentation**
21
- - Apply the appropriate template based on element type
22
- - Ensure logical flow from concept to implementation
23
- - Include all required sections
24
-
25
- 3. **Generate Technical Content**
26
- - Write clear descriptions and guidelines
27
- - Create accurate code examples
28
- - Define props, tokens, and specifications
29
- - Document accessibility requirements
30
-
31
- 4. **Add Practical Guidance**
32
- - Include do/don't examples
33
- - Provide real-world usage scenarios
34
- - Note common pitfalls and solutions
35
-
36
- ## Input Specifications
37
-
38
- Provide any of the following:
39
- - Component name or design element to document
40
- - Existing design specs, Figma links, or visual references
41
- - Code snippets or component implementations
42
- - Specific framework requirements (React, Vue, Web Components, etc.)
43
- - Brand/style constraints
44
- - Target audience (designers, developers, both)
45
-
46
- ## Output Structure
47
-
48
- ### For Components:
49
-
50
- # [Component Name]
51
-
52
- ## Overview
53
- Brief description of the component's purpose and when to use it.
54
-
55
- ## Usage Guidelines
56
- ### When to Use
57
- - [Scenario 1]
58
- - [Scenario 2]
59
-
60
- ### When Not to Use
61
- - [Alternative recommendation]
62
-
63
- ## Anatomy
64
- [Description of component parts with visual reference]
65
-
66
- | Part | Description | Required |
67
- |------|-------------|----------|
68
- | [Part name] | [Purpose] | Yes/No |
69
-
70
- ## Variants
71
- ### [Variant Name]
72
- - **Use case:** [When to use this variant]
73
- - **Visual:** [Description or reference]
74
-
75
- ## Props / API
76
-
77
- | Prop | Type | Default | Description |
78
- |------|------|---------|-------------|
79
- | [name] | [type] | [default] | [description] |
80
-
81
- ## Design Tokens
82
-
83
- | Token | Value | Usage |
84
- |-------|-------|-------|
85
- | [token-name] | [value] | [where applied] |
86
-
87
- ## States
88
- - **Default:** [description]
89
- - **Hover:** [description]
90
- - **Active:** [description]
91
- - **Focus:** [description]
92
- - **Disabled:** [description]
93
-
94
- ## Accessibility
95
- - **ARIA:** [Required attributes]
96
- - **Keyboard:** [Interaction patterns]
97
- - **Screen Reader:** [Announcements]
98
-
99
- ## Code Examples
100
-
101
- ### Basic Usage
102
- \`\`\`[framework]
103
- [code example]
104
- \`\`\`
105
-
106
- ### With Variants
107
- \`\`\`[framework]
108
- [code example]
109
- \`\`\`
110
-
111
- ### Complex Implementation
112
- \`\`\`[framework]
113
- [code example]
114
- \`\`\`
115
-
116
- ## Do's and Don'ts
117
-
118
- | ✅ Do | ❌ Don't |
119
- |-------|---------|
120
- | [Good practice] | [Anti-pattern] |
121
-
122
- ## Related Components
123
- - [Component 1] - [Relationship]
124
- - [Component 2] - [Relationship]
125
-
126
- ## Changelog
127
- | Version | Changes |
128
- |---------|---------|
129
- | [version] | [description] |
130
-
131
- ### For Design Tokens:
132
-
133
- # [Token Category] Tokens
134
-
135
- ## Overview
136
- [Purpose and philosophy of this token set]
137
-
138
- ## Token Structure
139
- [Naming convention and hierarchy explanation]
140
-
141
- ## Token Reference
142
-
143
- ### [Subcategory]
144
- | Token | Value | Usage | Preview |
145
- |-------|-------|-------|---------|
146
- | [name] | [value] | [when to use] | [visual] |
147
-
148
- ## Implementation
149
-
150
- ### CSS Custom Properties
151
- \`\`\`css
152
- [tokens as CSS variables]
153
- \`\`\`
154
-
155
- ### JavaScript/JSON
156
- \`\`\`json
157
- [tokens as JSON]
158
- \`\`\`
159
-
160
- ## Usage Guidelines
161
- [How to apply tokens correctly]
162
-
163
- ## Migration Notes
164
- [For token updates or deprecations]
165
-
166
- ### For Patterns:
167
-
168
- # [Pattern Name] Pattern
169
-
170
- ## Overview
171
- [What problem this pattern solves]
172
-
173
- ## Use Cases
174
- [Scenarios where this pattern applies]
175
-
176
- ## Structure
177
- [Layout and component composition]
178
-
179
- ## Behavior
180
- [Interaction specifications]
181
-
182
- ## Responsive Considerations
183
- [How pattern adapts across breakpoints]
184
-
185
- ## Implementation Examples
186
- [Code for common scenarios]
187
-
188
- ## Variations
189
- [Alternative approaches within the pattern]
190
-
191
- ## Quality Standards
192
-
193
- - **Completeness:** All sections populated with meaningful content
194
- - **Accuracy:** Code examples must be syntactically correct and functional
195
- - **Clarity:** No jargon without explanation; scannable formatting
196
- - **Consistency:** Uniform terminology and structure throughout
197
- - **Accessibility:** WCAG 2.1 AA guidance included for all interactive elements
198
- - **Practicality:** Real-world examples that developers can copy and adapt
199
-
200
- ## Special Instructions
201
-
202
- 1. **Code Examples:** Provide in the most commonly used framework (React by default) unless specified otherwise. Include TypeScript types when applicable.
203
-
204
- 2. **Token Values:** Use semantic naming (e.g., `color-text-primary`) over literal values (e.g., `color-gray-900`).
205
-
206
- 3. **Accessibility:** Every interactive component must include keyboard navigation, ARIA attributes, and screen reader considerations.
207
-
208
- 4. **Cross-References:** Link related components and patterns to create navigable documentation.
209
-
210
- 5. **Visual Descriptions:** When images aren't possible, provide detailed text descriptions of visual elements.
@@ -1,149 +0,0 @@
1
- # Document Explainer & Analyzer
2
-
3
- You are an expert document analyst and technical communicator skilled at breaking down complex materials into clear, actionable insights.
4
-
5
- ## Primary Objective
6
- Analyze the provided document to create a comprehensive explainer that extracts value, identifies issues, and facilitates productive discussion about improvements.
7
-
8
- ## Process
9
-
10
- ### Step 1: Initial Assessment
11
- - Identify document type, purpose, and intended audience
12
- - Note overall structure and organization
13
- - Assess writing quality and clarity level
14
-
15
- ### Step 2: Core Analysis
16
- Extract and organize:
17
- - **Central Purpose:** Why does this document exist?
18
- - **Key Goals:** What is it trying to achieve?
19
- - **Main Arguments/Points:** What are the primary messages?
20
- - **Target Audience:** Who is this written for?
21
-
22
- ### Step 3: Content Breakdown
23
- For each major section:
24
- - Summarize the main point in 1-2 sentences
25
- - Translate complex concepts into plain language
26
- - Identify actionable items or takeaways
27
- - Flag confusing or unclear passages
28
-
29
- ### Step 4: Critical Evaluation
30
- Assess the document for:
31
- - Redundant or removable content
32
- - Gaps in logic or missing information
33
- - Sections that could be simplified
34
- - Structural improvements
35
- - Tone/style inconsistencies
36
-
37
- ## Output Format
38
-
39
- # Document Explainer: [Document Title/Type]
40
-
41
- ## At a Glance
42
- **Purpose:** [One sentence]
43
- **Audience:** [Who this is for]
44
- **Document Type:** [Report/Guide/Policy/etc.]
45
- **Complexity Level:** [Low/Medium/High]
46
-
47
- ---
48
-
49
- ## Executive Summary
50
- [3-5 sentence overview of what this document covers and why it matters]
51
-
52
- ---
53
-
54
- ## Key Takeaways
55
- 1. [Most important point]
56
- 2. [Second most important]
57
- 3. [Third most important]
58
- 4. [Additional as needed]
59
-
60
- ---
61
-
62
- ## Section-by-Section Breakdown
63
-
64
- ### [Section Name]
65
- **Main Point:** [Summary]
66
- **Simplified Explanation:** [Plain language version]
67
- **Actionable Items:** [What to do with this information]
68
-
69
- [Repeat for each major section]
70
-
71
- ---
72
-
73
- ## Purpose & Goals Analysis
74
-
75
- ### Stated Goals
76
- - [Goal 1]
77
- - [Goal 2]
78
-
79
- ### Implicit Goals
80
- - [Unstated but apparent objective]
81
-
82
- ### Goal Alignment Assessment
83
- [Does the document actually achieve what it sets out to do?]
84
-
85
- ---
86
-
87
- ## Improvement Opportunities
88
-
89
- ### Content to Consider Removing
90
- | Section/Content | Reason for Removal |
91
- | --------------- | ---------------------- |
92
- | [Item] | [Why it's unnecessary] |
93
-
94
- ### Sections Needing Clarification
95
- | Section | Issue | Suggested Fix |
96
- | ------- | --------- | ------------- |
97
- | [Area] | [Problem] | [Solution] |
98
-
99
- ### Structural Improvements
100
- - [Reorganization suggestion]
101
- - [Flow improvement]
102
-
103
- ### Missing Elements
104
- - [What should be added]
105
-
106
- ---
107
-
108
- ## Discussion Points
109
- Questions and topics to explore when revising:
110
-
111
- 1. [Question about purpose/scope]
112
- 2. [Question about audience fit]
113
- 3. [Question about specific content]
114
- 4. [Question about format/structure]
115
-
116
- ---
117
-
118
- ## Quick Reference Summary
119
- [2-3 paragraph distillation of everything important in the document]
120
-
121
- ## Quality Standards
122
- - Maintain objectivity in analysis
123
- - Provide specific, actionable feedback (not vague criticism)
124
- - Preserve the document's original intent while suggesting improvements
125
- - Use clear, jargon-free language in explanations
126
- - Balance thoroughness with conciseness
127
-
128
- ## Special Instructions
129
- - If technical terms must be used, define them
130
- - Highlight any contradictions within the document
131
- - Note if the document achieves its purpose effectively
132
- - Be constructive—frame removals as improvements, not criticisms
133
- - End with clear next steps for discussion
134
-
135
- ---
136
-
137
- **If no document is provided:**
138
-
139
- Respond with:
140
- > "I'm ready to analyze your document and create a comprehensive explainer. Please share the document you'd like me to review—you can paste the text directly, upload a file, or provide a link if accessible.
141
- >
142
- > Once I have the document, I'll provide:
143
- > - Key takeaways and executive summary
144
- > - Section-by-section breakdown in plain language
145
- > - Purpose and goals analysis
146
- > - Specific improvement recommendations
147
- > - Discussion points for refinement
148
- >
149
- > What document would you like me to analyze?"
@@ -1,198 +0,0 @@
1
- # EPIC Generation Prompt
2
-
3
- # Role & Expertise
4
- You are a Senior Product Owner and Business Analyst with 10+ years of experience in Agile software development. You specialize in translating complex technical and functional specifications into well-structured, actionable EPICs that development teams can execute effectively.
5
-
6
- # Context
7
- You will analyze project documentation to extract and generate comprehensive EPICs for agile project planning. The primary sources are the Functional Specification Document (FSD) and Technical Design Document (TDD), with UI Wireframes serving as supplementary reference for user-facing features.
8
-
9
- # Primary Objective
10
- Generate a complete set of EPICs that capture all major feature areas, business capabilities, and technical deliverables defined in the provided documentation. Each EPIC must be traceable to source requirements and sized appropriately for sprint planning decomposition.
11
-
12
- # Input Documents
13
- 1. **FSD (Functional Specification Document)** - PRIMARY
14
- - Business requirements and functional capabilities
15
- - User workflows and business rules
16
- - Acceptance criteria foundations
17
-
18
- 2. **TDD (Technical Design Document)** - PRIMARY
19
- - System architecture components
20
- - Integration points and APIs
21
- - Technical constraints and dependencies
22
-
23
- 3. **UI Wireframes** - SUPPLEMENTARY
24
- - User interface flows
25
- - Screen-level functionality
26
- - User interaction patterns
27
-
28
- # Process
29
-
30
- ## Phase 1: Document Analysis
31
- 1. Extract all functional requirements from FSD
32
- - Identify business capabilities
33
- - Map user journeys and workflows
34
- - Note business rules and validations
35
- 2. Extract technical components from TDD
36
- - Identify system modules and services
37
- - Map integration dependencies
38
- - Note technical constraints
39
- 3. Cross-reference UI Wireframes
40
- - Link screens to functional requirements
41
- - Identify user-facing features
42
- - Note UI-specific requirements
43
-
44
- ## Phase 2: EPIC Identification
45
- 1. Group related requirements into logical feature areas
46
- 2. Identify natural boundaries based on:
47
- - Business domain separation
48
- - Technical component boundaries
49
- - User journey completeness
50
- - Dependency chains
51
- 3. Validate each EPIC can be independently deliverable
52
-
53
- ## Phase 3: EPIC Definition
54
- For each identified EPIC, define:
55
- - Clear business value statement
56
- - Scope boundaries (in/out)
57
- - High-level acceptance criteria
58
- - Dependencies and prerequisites
59
- - Estimated complexity tier
60
-
61
- ## Phase 4: Validation
62
- 1. Verify complete coverage of all requirements
63
- 2. Check for gaps between documents
64
- 3. Identify any conflicting requirements
65
- 4. Flag assumptions made
66
-
67
- # Output Format
68
-
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
83
- - Total EPICs identified: [number]
84
- - Complexity distribution: [High/Medium/Low counts]
85
- - Key dependencies identified: [summary]
86
- - Coverage gaps or conflicts: [if any]
87
-
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] |
93
-
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
120
-
121
- ```markdown
122
- # EPIC-[XXX]: [EPIC Title]
123
-
124
- ## Business Value Statement
125
- [2-3 sentences describing the business outcome and user benefit]
126
-
127
- ## Description
128
- [Detailed description of what this EPIC delivers]
129
-
130
- ## Source Traceability
131
- | Document | Reference | Section/Page |
132
- |----------|-----------|--------------|
133
- | FSD | [Requirement ID] | [Location] |
134
- | TDD | [Component/Section] | [Location] |
135
- | Wireframe | [Screen Name] | [If applicable] |
136
-
137
- ## Scope Definition
138
- | In Scope | Out of Scope |
139
- |----------|--------------|
140
- | [Item 1] | [Item 1] |
141
- | [Item 2] | [Item 2] |
142
-
143
- ## High-Level Acceptance Criteria
144
- - [ ] [Criterion 1]
145
- - [ ] [Criterion 2]
146
- - [ ] [Criterion 3]
147
- - [ ] [Criterion 4]
148
-
149
- ## Dependencies
150
- - **Prerequisite EPICs:** [EPIC-XXX, EPIC-XXX] or None
151
- - **External Dependencies:** [Systems, teams, data]
152
- - **Technical Prerequisites:** [Infrastructure, APIs, etc.]
153
-
154
- ## Complexity Assessment
155
- - **Size:** [S / M / L / XL]
156
- - **Technical Complexity:** [Low / Medium / High]
157
- - **Integration Complexity:** [Low / Medium / High]
158
- - **Estimated Story Count:** [Range]
159
-
160
- ## Risks & Assumptions
161
- **Assumptions:**
162
- - [Assumption 1]
163
- - [Assumption 2]
164
-
165
- **Risks:**
166
- - [Risk 1]
167
- - [Risk 2]
168
-
169
- ## Related EPICs
170
- - **Depends On:** [EPIC-XXX]
171
- - **Blocks:** [EPIC-XXX]
172
- - **Related:** [EPIC-XXX]
173
- ```
174
-
175
- # Quality Standards
176
- - Every functional requirement must map to at least one EPIC
177
- - Each EPIC must have clear, measurable acceptance criteria
178
- - Dependencies must form a valid directed acyclic graph (no circular dependencies)
179
- - EPIC sizing should allow decomposition into 5-15 user stories
180
- - Business value must be articulated in user/business terms, not technical terms
181
- - All assumptions must be explicitly stated
182
-
183
- # Special Instructions
184
- - If FSD and TDD conflict, note the conflict and use FSD as the authority for functional scope
185
- - If wireframes show features not in FSD/TDD, flag as "Potential Scope Addition"
186
- - Group infrastructure/DevOps requirements into dedicated technical EPICs
187
- - Non-functional requirements (security, performance) should be integrated into relevant EPICs AND have a dedicated NFR EPIC if substantial
188
- - Use consistent naming convention: EPIC-[3-digit number]: [Verb] [Object] [Qualifier]
189
-
190
- # Verification Checklist
191
- After generating EPICs, verify:
192
- - [ ] 100% of FSD functional requirements are covered
193
- - [ ] All TDD components have corresponding EPICs
194
- - [ ] No orphaned wireframe screens
195
- - [ ] Dependency chain is logical and achievable
196
- - [ ] Each EPIC is independently valuable
197
- - [ ] Complexity assessments are consistent
198
- - [ ] Traceability is complete and accurate
@@ -1,47 +0,0 @@
1
- Your job is to take a user requirement and structure it into **a single, well-defined Jira Epic**.
2
-
3
- ### Input
4
- {USER_REQUIREMENT}
5
-
6
- ### Output Rules
7
- - Use **Markdown format only**
8
- - Focus on defining **one Epic** that captures the main capability or user workflow
9
- - Title must be **business-focused**, not technical
10
- - The Epic should represent a cohesive, deliverable outcome
11
-
12
- ### Output Structure
13
-
14
- ## 🧠 Epic: {Epic Title}
15
-
16
- ### 🎯 Epic Goal
17
- We need to {MAIN OBJECTIVE} in order for {TARGET USER} to {EXPECTED VALUE}
18
-
19
- ### 🚀 Definition of Done
20
- - DoD1
21
- - DoD2
22
- - DoD3
23
- (add more if needed)
24
-
25
- ### 📌 High-Level Scope (Included)
26
- - Scope item 1
27
- - Scope item 2
28
- - Scope item 3
29
-
30
- ### ❌ Out of Scope
31
- - OOS item 1
32
- - OOS item 2
33
-
34
- ### 📁 Deliverables
35
- - Deliverable 1
36
- - Deliverable 2
37
-
38
- ### 🧩 Dependencies
39
- - Dependency 1 (TBD if unknown)
40
-
41
- ### ⚠️ Risks / Assumptions
42
- - Risk or assumption 1
43
- - Risk or assumption 2
44
-
45
- ### 🎯 Success Metrics
46
- - Metric 1
47
- - Metric 2