@dedesfr/prompter 0.9.0 → 1.1.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 (225) hide show
  1. package/CHANGELOG.md +35 -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 +35 -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 +0 -2
  17. package/dist/commands/update.d.ts.map +1 -1
  18. package/dist/commands/update.js +19 -48
  19. package/dist/commands/update.js.map +1 -1
  20. package/dist/commands/whoami.d.ts +4 -0
  21. package/dist/commands/whoami.d.ts.map +1 -0
  22. package/dist/commands/whoami.js +42 -0
  23. package/dist/commands/whoami.js.map +1 -0
  24. package/dist/core/auth-store.d.ts +10 -0
  25. package/dist/core/auth-store.d.ts.map +1 -0
  26. package/dist/core/auth-store.js +39 -0
  27. package/dist/core/auth-store.js.map +1 -0
  28. package/dist/core/config.d.ts +0 -7
  29. package/dist/core/config.d.ts.map +1 -1
  30. package/dist/core/config.js +0 -128
  31. package/dist/core/config.js.map +1 -1
  32. package/dist/core/registry.d.ts +18 -0
  33. package/dist/core/registry.d.ts.map +1 -0
  34. package/dist/core/registry.js +94 -0
  35. package/dist/core/registry.js.map +1 -0
  36. package/package.json +7 -1
  37. package/AGENTS.md +0 -123
  38. package/CLAUDE.md +0 -17
  39. package/build.js +0 -20
  40. package/convex-setup.md +0 -403
  41. package/dist/core/prompt-templates.d.ts +0 -23
  42. package/dist/core/prompt-templates.d.ts.map +0 -1
  43. package/dist/core/prompt-templates.js +0 -3485
  44. package/dist/core/prompt-templates.js.map +0 -1
  45. package/prompt/ai-humanizer.md +0 -45
  46. package/prompt/api-contract-generator.md +0 -234
  47. package/prompt/apply.md +0 -17
  48. package/prompt/archive.md +0 -21
  49. package/prompt/design-system.md +0 -210
  50. package/prompt/document-explainer.md +0 -149
  51. package/prompt/epic-generator.md +0 -198
  52. package/prompt/epic-single.md +0 -47
  53. package/prompt/erd-generator.md +0 -130
  54. package/prompt/fsd-generator.md +0 -157
  55. package/prompt/prd-agent-generator.md +0 -147
  56. package/prompt/prd-generator.md +0 -195
  57. package/prompt/product-brief.md +0 -289
  58. package/prompt/proposal.md +0 -22
  59. package/prompt/qa-test-scenario.md +0 -133
  60. package/prompt/skill-creator.md +0 -350
  61. package/prompt/story-generator.md +0 -278
  62. package/prompt/story-single.md +0 -70
  63. package/prompt/tdd-generator.md +0 -294
  64. package/prompt/tdd-lite-generator.md +0 -224
  65. package/prompt/wireframe-generator.md +0 -219
  66. package/skills/ai-context-generator/SKILL.md +0 -54
  67. package/skills/ai-context-generator/references/AGENTS.template.md +0 -83
  68. package/skills/ai-context-generator/references/CLAUDE.template.md +0 -39
  69. package/skills/ai-context-generator/references/behavioral-guidelines.md +0 -71
  70. package/skills/ai-context-generator/references/discovery-checklist.md +0 -40
  71. package/skills/ai-context-generator/references/examples/AGENTS.good.md +0 -103
  72. package/skills/ai-context-generator/references/extraction-checklist.md +0 -23
  73. package/skills/ai-context-generator/references/overlays/laravel.md +0 -44
  74. package/skills/ai-humanizer/SKILL.md +0 -50
  75. package/skills/api-contract-generator/SKILL.md +0 -243
  76. package/skills/apply/SKILL.md +0 -23
  77. package/skills/archive/SKILL.md +0 -27
  78. package/skills/cerebro/SKILL.md +0 -187
  79. package/skills/cerebro/references/agents.md +0 -213
  80. package/skills/code-review/SKILL.md +0 -373
  81. package/skills/code-review/assets/report-template-agent.md +0 -212
  82. package/skills/code-review/assets/report-template-compact.md +0 -81
  83. package/skills/code-review/assets/report-template-full.md +0 -264
  84. package/skills/code-review/assets/report-template-human.md +0 -168
  85. package/skills/code-review/references/universal-patterns.md +0 -495
  86. package/skills/design-md/README.md +0 -34
  87. package/skills/design-md/SKILL.md +0 -172
  88. package/skills/design-md/examples/DESIGN.md +0 -154
  89. package/skills/design-system/SKILL.md +0 -216
  90. package/skills/design-system-generator/SKILL.md +0 -324
  91. package/skills/design-system-generator/assets/design-system-template.md +0 -348
  92. package/skills/design-system-generator/references/extraction-patterns.md +0 -321
  93. package/skills/doc-builder/SKILL.md +0 -115
  94. package/skills/doc-builder/references/ui-patterns.md +0 -394
  95. package/skills/document-explainer/SKILL.md +0 -155
  96. package/skills/document-translator/SKILL.md +0 -58
  97. package/skills/enhance/SKILL.md +0 -47
  98. package/skills/enhance-prompt/README.md +0 -34
  99. package/skills/enhance-prompt/SKILL.md +0 -204
  100. package/skills/enhance-prompt/references/KEYWORDS.md +0 -114
  101. package/skills/epic-generator/SKILL.md +0 -204
  102. package/skills/epic-single/SKILL.md +0 -63
  103. package/skills/erd-generator/SKILL.md +0 -138
  104. package/skills/feature-planner/SKILL.md +0 -305
  105. package/skills/feature-planner/assets/implementation-plan-template.md +0 -85
  106. package/skills/frontend-design/LICENSE.txt +0 -177
  107. package/skills/frontend-design/SKILL.md +0 -42
  108. package/skills/fsd-generator/SKILL.md +0 -163
  109. package/skills/gamma-builder/SKILL.md +0 -134
  110. package/skills/laravel-code-review/SKILL.md +0 -383
  111. package/skills/laravel-code-review/assets/report-template-agent.md +0 -195
  112. package/skills/laravel-code-review/assets/report-template-compact.md +0 -79
  113. package/skills/laravel-code-review/assets/report-template-full.md +0 -253
  114. package/skills/laravel-code-review/assets/report-template-human.md +0 -159
  115. package/skills/laravel-code-review/references/laravel-patterns.md +0 -571
  116. package/skills/laravel-code-review/references/php84-features.md +0 -442
  117. package/skills/mcp-builder/LICENSE.txt +0 -202
  118. package/skills/mcp-builder/SKILL.md +0 -236
  119. package/skills/mcp-builder/reference/evaluation.md +0 -602
  120. package/skills/mcp-builder/reference/mcp_best_practices.md +0 -249
  121. package/skills/mcp-builder/reference/node_mcp_server.md +0 -970
  122. package/skills/mcp-builder/reference/python_mcp_server.md +0 -719
  123. package/skills/mcp-builder/scripts/connections.py +0 -151
  124. package/skills/mcp-builder/scripts/evaluation.py +0 -373
  125. package/skills/mcp-builder/scripts/example_evaluation.xml +0 -22
  126. package/skills/mcp-builder/scripts/requirements.txt +0 -2
  127. package/skills/meeting-notes/SKILL.md +0 -159
  128. package/skills/meeting-notes/evals/evals.json +0 -23
  129. package/skills/prd-agent-generator/SKILL.md +0 -132
  130. package/skills/prd-generator/SKILL.md +0 -211
  131. package/skills/product-brief/SKILL.md +0 -141
  132. package/skills/project-orchestrator/SKILL.md +0 -487
  133. package/skills/project-orchestrator/assets/caddy-vps-setup.md +0 -180
  134. package/skills/project-orchestrator/assets/plan-summary-template.md +0 -159
  135. package/skills/prompter-specs/SKILL.md +0 -115
  136. package/skills/prompter-workflow/SKILL.md +0 -166
  137. package/skills/prompter-workflow/evals/evals.json +0 -89
  138. package/skills/proposal/SKILL.md +0 -28
  139. package/skills/qa-test-scenario/SKILL.md +0 -149
  140. package/skills/skill-creator/SKILL.md +0 -173
  141. package/skills/sph-generator/SKILL.md +0 -488
  142. package/skills/story-generator/SKILL.md +0 -285
  143. package/skills/story-single/SKILL.md +0 -86
  144. package/skills/tdd-generator/SKILL.md +0 -300
  145. package/skills/tdd-lite-generator/SKILL.md +0 -230
  146. package/skills/ui-ux-pro/SKILL.md +0 -199
  147. package/skills/ui-ux-pro/assets/design-spec-template.md +0 -173
  148. package/skills/ui-ux-pro/references/component-patterns.md +0 -255
  149. package/skills/ui-ux-pro/references/design-principles.md +0 -167
  150. package/skills/wireframe-generator/SKILL.md +0 -227
  151. package/src/cli/index.ts +0 -223
  152. package/src/commands/archive.ts +0 -302
  153. package/src/commands/change.ts +0 -292
  154. package/src/commands/config.ts +0 -233
  155. package/src/commands/guide.ts +0 -50
  156. package/src/commands/init.ts +0 -597
  157. package/src/commands/list.ts +0 -194
  158. package/src/commands/show.ts +0 -138
  159. package/src/commands/spec.ts +0 -251
  160. package/src/commands/update.ts +0 -129
  161. package/src/commands/upgrade.ts +0 -30
  162. package/src/commands/validate.ts +0 -326
  163. package/src/core/artifact-graph/graph.ts +0 -167
  164. package/src/core/artifact-graph/index.ts +0 -44
  165. package/src/core/artifact-graph/instruction-loader.ts +0 -302
  166. package/src/core/artifact-graph/resolver.ts +0 -226
  167. package/src/core/artifact-graph/schema.ts +0 -124
  168. package/src/core/artifact-graph/state.ts +0 -64
  169. package/src/core/artifact-graph/types.ts +0 -65
  170. package/src/core/completions/command-registry.ts +0 -382
  171. package/src/core/completions/completion-provider.ts +0 -128
  172. package/src/core/completions/generators/bash-generator.ts +0 -191
  173. package/src/core/completions/generators/fish-generator.ts +0 -188
  174. package/src/core/completions/generators/powershell-generator.ts +0 -223
  175. package/src/core/completions/generators/zsh-generator.ts +0 -281
  176. package/src/core/completions/templates/bash-templates.ts +0 -24
  177. package/src/core/completions/templates/fish-templates.ts +0 -40
  178. package/src/core/completions/templates/powershell-templates.ts +0 -25
  179. package/src/core/completions/templates/zsh-templates.ts +0 -36
  180. package/src/core/completions/types.ts +0 -90
  181. package/src/core/config-schema.ts +0 -230
  182. package/src/core/config.ts +0 -181
  183. package/src/core/configurators/slash/antigravity.ts +0 -10
  184. package/src/core/configurators/slash/base.ts +0 -109
  185. package/src/core/configurators/slash/claude.ts +0 -10
  186. package/src/core/configurators/slash/codex.ts +0 -10
  187. package/src/core/configurators/slash/droid.ts +0 -10
  188. package/src/core/configurators/slash/forge.ts +0 -10
  189. package/src/core/configurators/slash/github-copilot.ts +0 -10
  190. package/src/core/configurators/slash/index.ts +0 -10
  191. package/src/core/configurators/slash/kilocode.ts +0 -10
  192. package/src/core/configurators/slash/opencode.ts +0 -10
  193. package/src/core/configurators/slash/registry.ts +0 -51
  194. package/src/core/converters/json-converter.ts +0 -62
  195. package/src/core/global-config.ts +0 -136
  196. package/src/core/parsers/change-parser.ts +0 -234
  197. package/src/core/parsers/markdown-parser.ts +0 -237
  198. package/src/core/parsers/requirement-blocks.ts +0 -234
  199. package/src/core/prompt-templates.ts +0 -3504
  200. package/src/core/schemas/base.schema.ts +0 -20
  201. package/src/core/schemas/change.schema.ts +0 -42
  202. package/src/core/schemas/index.ts +0 -20
  203. package/src/core/schemas/spec.schema.ts +0 -17
  204. package/src/core/skill-discovery.ts +0 -68
  205. package/src/core/specs-apply.ts +0 -483
  206. package/src/core/styles/palette.ts +0 -8
  207. package/src/core/templates/agents-template.ts +0 -459
  208. package/src/core/templates/claude-template.ts +0 -2
  209. package/src/core/templates/index.ts +0 -3
  210. package/src/core/templates/project-template.ts +0 -32
  211. package/src/core/validation/constants.ts +0 -48
  212. package/src/core/validation/types.ts +0 -19
  213. package/src/core/validation/validator.ts +0 -449
  214. package/src/core/view.ts +0 -219
  215. package/src/index.ts +0 -1
  216. package/src/utils/change-metadata.ts +0 -171
  217. package/src/utils/change-utils.ts +0 -131
  218. package/src/utils/file-system.ts +0 -252
  219. package/src/utils/index.ts +0 -12
  220. package/src/utils/interactive.ts +0 -29
  221. package/src/utils/item-discovery.ts +0 -66
  222. package/src/utils/match.ts +0 -26
  223. package/src/utils/shell-detection.ts +0 -62
  224. package/src/utils/task-progress.ts +0 -43
  225. package/tsconfig.json +0 -28
@@ -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
@@ -1,130 +0,0 @@
1
- # Generated Prompt
2
-
3
- # Role & Expertise
4
- You are a senior database architect and data modeling specialist with extensive experience in translating business requirements into optimized database designs. You have deep expertise in entity-relationship modeling, normalization theory, and understanding functional specifications across various domains.
5
-
6
- # Context
7
- You will receive a Functional Specification Document (FSD) that describes system requirements, business processes, user stories, and feature specifications. Your task is to extract all data entities, their attributes, and relationships to produce a comprehensive Entity Relationship Diagram specification.
8
-
9
- # Primary Objective
10
- Analyze the provided FSD and generate a complete ERD specification that accurately captures all data entities, attributes, relationships, and cardinalities required to support the described functionality.
11
-
12
- # Process
13
-
14
- ## Phase 1: Document Analysis
15
- 1. Read through the entire FSD to understand the system scope
16
- 2. Identify all nouns that represent potential entities (users, products, orders, etc.)
17
- 3. Note all actions and processes that imply relationships between entities
18
- 4. Extract business rules that define constraints and cardinalities
19
-
20
- ## Phase 2: Entity Identification
21
- 1. List all candidate entities from the document
22
- 2. Eliminate duplicates and synonyms (e.g., "customer" and "client" may be the same)
23
- 3. Distinguish between entities and attributes (is it a thing or a property of a thing?)
24
- 4. Identify weak entities that depend on other entities for existence
25
-
26
- ## Phase 3: Attribute Extraction
27
- 1. For each entity, identify all properties mentioned or implied
28
- 2. Determine primary keys (natural or surrogate)
29
- 3. Identify required vs. optional attributes
30
- 4. Note any derived or calculated attributes
31
- 5. Specify data types based on context
32
-
33
- ## Phase 4: Relationship Mapping
34
- 1. Identify all relationships between entities
35
- 2. Determine cardinality for each relationship (1:1, 1:N, M:N)
36
- 3. Identify participation constraints (mandatory vs. optional)
37
- 4. Name relationships with meaningful verbs
38
- 5. Identify any recursive/self-referencing relationships
39
-
40
- ## Phase 5: Normalization Review
41
- 1. Verify entities are in at least 3NF
42
- 2. Check for transitive dependencies
43
- 3. Identify any intentional denormalization with justification
44
-
45
- # Input Specifications
46
- - **Document Type:** Functional Specification Document (FSD)
47
- - **Expected Content:** System overview, user stories, feature descriptions, business rules, workflow descriptions, UI specifications
48
- - **Format:** Text, markdown, or document content
49
-
50
- # Output Requirements
51
-
52
- ## Section 1: Entity Catalog
53
-
54
- | Entity Name | Description | Type | Primary Key |
55
- |-------------|-------------|------|-------------|
56
- | [Name] | [Brief description] | [Strong/Weak] | [PK field(s)] |
57
-
58
-
59
- ## Section 2: Entity Details
60
- For each entity:
61
-
62
- ### [Entity Name]
63
- **Description:** [What this entity represents]
64
- **Type:** Strong Entity / Weak Entity (dependent on: [parent])
65
-
66
- **Attributes:**
67
- | Attribute | Data Type | Constraints | Description |
68
- |-----------|-----------|-------------|-------------|
69
- | [name] | [type] | [PK/FK/NOT NULL/UNIQUE] | [description] |
70
-
71
- **Business Rules:**
72
- - [Rule 1]
73
- - [Rule 2]
74
-
75
- ## Section 3: Relationship Specifications
76
-
77
- | Relationship | Entity A | Entity B | Cardinality | Participation | Description |
78
- |--------------|----------|----------|-------------|---------------|-------------|
79
- | [verb phrase] | [Entity] | [Entity] | [1:1/1:N/M:N] | [Total/Partial] | [description] |
80
-
81
-
82
- ## Section 4: ERD Notation (Text-Based)
83
- Provide a PlantUML or Mermaid diagram code that can be rendered:
84
-
85
- erDiagram
86
- ENTITY1 ||--o{ ENTITY2 : "relationship"
87
- ENTITY1 {
88
- type attribute_name PK
89
- type attribute_name
90
- }
91
-
92
- ## Section 5: Design Decisions & Notes
93
- - Key assumptions made during analysis
94
- - Alternative modeling options considered
95
- - Recommendations for implementation
96
- - Questions or ambiguities requiring clarification
97
-
98
- # Quality Standards
99
- - **Completeness:** All entities implied by the FSD must be captured
100
- - **Accuracy:** Cardinalities must reflect actual business rules
101
- - **Clarity:** Entity and relationship names must be self-explanatory
102
- - **Consistency:** Naming conventions must be uniform throughout
103
- - **Traceability:** Each entity/relationship should trace back to FSD requirements
104
-
105
- # Naming Conventions
106
- - **Entities:** PascalCase, singular nouns (e.g., `Customer`, `OrderItem`)
107
- - **Attributes:** snake_case (e.g., `first_name`, `created_at`)
108
- - **Relationships:** Descriptive verb phrases (e.g., "places", "contains", "belongs to")
109
- - **Primary Keys:** `id` or `[entity]_id`
110
- - **Foreign Keys:** `[referenced_entity]_id`
111
-
112
- # Special Instructions
113
- 1. If the FSD mentions features without clear data requirements, infer necessary entities
114
- 2. Include audit fields (`created_at`, `updated_at`, `created_by`) for transactional entities
115
- 3. Consider soft delete patterns if deletion is mentioned
116
- 4. Flag any circular dependencies or complex relationships
117
- 5. If user authentication is implied, include standard auth entities (User, Role, Permission)
118
- 6. For any M:N relationships, specify the junction/association entity
119
-
120
- # Verification Checklist
121
- After generating the ERD, verify:
122
- - [ ] Every feature in the FSD can be supported by the data model
123
- - [ ] All user roles mentioned have corresponding entities or attributes
124
- - [ ] Workflow states are captured (if applicable)
125
- - [ ] Reporting requirements can be satisfied by the structure
126
- - [ ] No orphan entities exist (every entity has at least one relationship)
127
-
128
- ---
129
-
130
- **Now analyze the following Functional Specification Document and generate the complete ERD specification:**
@@ -1,157 +0,0 @@
1
- # Functional Specification Document (FSD) Generator Prompt
2
-
3
- # Role & Expertise
4
- You are a Senior Technical Business Analyst and Solutions Architect with 15+ years of experience translating Product Requirements Documents into comprehensive Functional Specification Documents. You excel at bridging business vision and technical implementation.
5
-
6
- # Context
7
- You will receive a Product Requirements Document (PRD) that outlines business objectives, user needs, and high-level product vision. Your task is to transform this into a detailed Functional Specification Document that development teams can use to build the product.
8
-
9
- # Primary Objective
10
- Generate a complete, implementation-ready Functional Specification Document (FSD) that translates PRD requirements into precise functional specifications, system behaviors, data requirements, and acceptance criteria.
11
-
12
- # Process
13
- 1. **Analyze the PRD**
14
- - Extract all business requirements and user stories
15
- - Identify core features and their priorities
16
- - Map user personas to functional needs
17
- - Note any constraints, assumptions, and dependencies
18
-
19
- 2. **Define Functional Requirements**
20
- - Convert each PRD item into specific, testable functional requirements
21
- - Assign unique identifiers (FR-XXX format)
22
- - Establish requirement traceability to PRD sections
23
- - Define acceptance criteria for each requirement
24
-
25
- 3. **Specify System Behavior**
26
- - Document user interactions and system responses
27
- - Define business rules and validation logic
28
- - Specify error handling and edge cases
29
- - Detail state transitions where applicable
30
-
31
- 4. **Design Data Specifications**
32
- - Identify data entities and attributes
33
- - Define data validation rules
34
- - Specify data relationships and constraints
35
- - Document data flow between components
36
-
37
- 5. **Create Interface Specifications**
38
- - Define UI functional requirements (not visual design)
39
- - Specify API contracts if applicable
40
- - Document integration touchpoints
41
- - Detail reporting/output requirements
42
-
43
- # Input Specifications
44
- - Product Requirements Document (PRD) in any text format
45
- - May include: user stories, epics, acceptance criteria, wireframes descriptions, business rules, constraints
46
-
47
- # Output Requirements
48
-
49
- **Format:** Structured FSD document with clear sections and subsections
50
- **Style:** Technical but accessible; precise language; no ambiguity
51
- **Requirement Format:** Each requirement must have ID, description, priority, acceptance criteria, and PRD traceability
52
-
53
- ## Required FSD Structure:
54
-
55
- # Functional Specification Document
56
- ## Document Information
57
- - Document Title
58
- - Version
59
- - Date
60
- - PRD Reference
61
- - Author
62
- - Reviewers/Approvers
63
-
64
- ## 1. Executive Summary
65
- [Brief overview of what the system will do functionally]
66
-
67
- ## 2. Scope
68
- ### 2.1 In Scope
69
- [Functional boundaries covered by this FSD]
70
- ### 2.2 Out of Scope
71
- [Explicitly excluded functionality]
72
- ### 2.3 Assumptions
73
- [Technical and business assumptions]
74
- ### 2.4 Dependencies
75
- [External systems, teams, or conditions]
76
-
77
- ## 3. User Roles & Permissions
78
- | Role | Description | Key Capabilities |
79
- |------|-------------|------------------|
80
- [Define each user role and their functional access]
81
-
82
- ## 4. Functional Requirements
83
- ### 4.1 [Feature/Module Name]
84
- #### FR-001: [Requirement Title]
85
- - **Description:** [Detailed functional description]
86
- - **Priority:** [Must Have / Should Have / Could Have / Won't Have]
87
- - **PRD Reference:** [Section/Item from PRD]
88
- - **User Story:** As a [role], I want [capability] so that [benefit]
89
- - **Business Rules:**
90
- - BR-001: [Rule description]
91
- - **Acceptance Criteria:**
92
- - [ ] Given [context], when [action], then [expected result]
93
- - [ ] [Additional criteria]
94
- - **Error Handling:**
95
- - [Error condition] → [System response]
96
-
97
- [Repeat for each functional requirement]
98
-
99
- ## 5. Business Rules Catalog
100
- | ID | Rule | Applies To | Validation |
101
- |----|------|------------|------------|
102
- [Consolidated list of all business rules]
103
-
104
- ## 6. Data Specifications
105
- ### 6.1 Data Entities
106
- #### [Entity Name]
107
- | Field | Type | Required | Validation Rules | Description |
108
- |-------|------|----------|------------------|-------------|
109
-
110
- ### 6.2 Data Relationships
111
- [Entity relationship descriptions or diagram notation]
112
-
113
- ### 6.3 Data Validation Rules
114
- [Comprehensive validation logic]
115
-
116
- ## 7. Interface Specifications
117
- ### 7.1 User Interface Requirements
118
- [Screen-by-screen functional requirements]
119
-
120
- ### 7.2 API Specifications (if applicable)
121
- | Endpoint | Method | Input | Output | Business Logic |
122
- |----------|--------|-------|--------|----------------|
123
-
124
- ### 7.3 Integration Requirements
125
- [Third-party system integration specifications]
126
-
127
- ## 8. Non-Functional Considerations
128
- [Performance expectations, security requirements, accessibility needs - as they impact functionality]
129
-
130
- ## 9. Reporting & Analytics Requirements
131
- [Functional requirements for reports and dashboards]
132
-
133
- ## 10. Traceability Matrix
134
- | PRD Item | FSD Requirement(s) | Priority |
135
- |----------|-------------------|----------|
136
- [Map every PRD item to FSD requirements]
137
-
138
- ## 11. Appendices
139
- ### A. Glossary
140
- ### B. Revision History
141
- ### C. Open Questions/TBD Items
142
-
143
- # Quality Standards
144
- - Every PRD requirement must map to at least one functional specification
145
- - All requirements must be SMART (Specific, Measurable, Achievable, Relevant, Testable)
146
- - No ambiguous language (avoid "should," "might," "could" - use "shall," "will," "must")
147
- - Each acceptance criterion must be verifiable by QA
148
- - Business rules must be atomic and non-contradictory
149
- - Data specifications must cover all functional requirements
150
-
151
- # Special Instructions
152
- - If the PRD is vague on certain aspects, document them in "Open Questions/TBD Items"
153
- - Infer reasonable technical assumptions where PRD is silent, clearly marking them as assumptions
154
- - Prioritize requirements using MoSCoW method if not specified in PRD
155
- - Include negative test scenarios in acceptance criteria (what should NOT happen)
156
- - Flag any PRD inconsistencies or conflicts you identify
157
- - Use consistent terminology throughout - define terms in glossary
@@ -1,147 +0,0 @@
1
- # PRD Generator (Non-Interactive Mode)
2
-
3
- Create detailed Product Requirements Documents that are clear, actionable, and suitable for implementation based solely on the user's initial input.
4
-
5
- ---
6
-
7
- ## The Job
8
-
9
- 1. Receive a feature description from the user
10
- 2. Analyze the input and make reasonable assumptions where details are missing
11
- 3. Generate a structured PRD based on the input
12
-
13
- ---
14
-
15
- ## Handling Ambiguity
16
-
17
- When the user's input lacks specific details:
18
-
19
- - **Make reasonable assumptions** based on common patterns and best practices
20
- - **Document assumptions** in the PRD under "Assumptions Made"
21
- - **Flag critical unknowns** in the "Open Questions" section
22
- - **Err on the side of MVP scope** when scope is unclear
23
- - **Default to standard patterns** (e.g., CRUD operations, standard UI components)
24
-
25
- ---
26
-
27
- ## PRD Structure
28
-
29
- Generate the PRD with these sections:
30
-
31
- ### 1. Introduction/Overview
32
- Brief description of the feature and the problem it solves.
33
-
34
- ### 2. Assumptions Made
35
- List key assumptions made due to missing details in the original request:
36
- - "Assumed target users are [X] based on feature context"
37
- - "Assumed MVP scope since no specific scope mentioned"
38
- - "Assumed standard authentication is already in place"
39
-
40
- ### 3. Goals
41
- Specific, measurable objectives (bullet list).
42
-
43
- ### 4. User Stories
44
- Each story needs:
45
- - **Title:** Short descriptive name
46
- - **Description:** "As a [user], I want [feature] so that [benefit]"
47
- - **Acceptance Criteria:** Verifiable checklist of what "done" means
48
-
49
- Each story should be small enough to implement in one focused session.
50
-
51
- **Format:**
52
- ```markdown
53
- ### US-001: [Title]
54
- **Description:** As a [user], I want [feature] so that [benefit].
55
-
56
- **Acceptance Criteria:**
57
- - [ ] Specific verifiable criterion
58
- - [ ] Another criterion
59
- - [ ] Typecheck/lint passes
60
- - [ ] **[UI stories only]** Verify in browser using dev-browser skill
61
- ```
62
-
63
- **Important:**
64
- - Acceptance criteria must be verifiable, not vague. "Works correctly" is bad. "Button shows confirmation dialog before deleting" is good.
65
- - **For any story with UI changes:** Always include "Verify in browser using dev-browser skill" as acceptance criteria. This ensures visual verification of frontend work.
66
-
67
- ### 5. Functional Requirements
68
- Numbered list of specific functionalities:
69
- - "FR-1: The system must allow users to..."
70
- - "FR-2: When a user clicks X, the system must..."
71
-
72
- Be explicit and unambiguous.
73
-
74
- ### 6. Non-Goals (Out of Scope)
75
- What this feature will NOT include. Critical for managing scope.
76
-
77
- ### 7. Design Considerations (Optional)
78
- - UI/UX requirements
79
- - Link to mockups if available
80
- - Relevant existing components to reuse
81
-
82
- ### 8. Technical Considerations (Optional)
83
- - Known constraints or dependencies
84
- - Integration points with existing systems
85
- - Performance requirements
86
-
87
- ### 9. Success Metrics
88
- How will success be measured?
89
- - "Reduce time to complete X by 50%"
90
- - "Increase conversion rate by 10%"
91
-
92
- ### 10. Open Questions
93
- Remaining questions or areas needing clarification. This is where you document:
94
- - Critical unknowns that affect implementation
95
- - Areas where the original request was ambiguous
96
- - Decisions that may need stakeholder input
97
-
98
- ---
99
-
100
- ## Writing for Junior Developers
101
-
102
- The PRD reader may be a junior developer or AI agent. Therefore:
103
-
104
- - Be explicit and unambiguous
105
- - Avoid jargon or explain it
106
- - Provide enough detail to understand purpose and core logic
107
- - Number requirements for easy reference
108
- - Use concrete examples where helpful
109
-
110
- ---
111
-
112
- ## Output
113
-
114
- - **Format:** Markdown (`.md`)
115
-
116
- ---
117
-
118
- ## Example PRD
119
-
120
- ```markdown
121
- # PRD: Task Priority System
122
-
123
- ## Introduction
124
-
125
- Add priority levels to tasks so users can focus on what matters most. Tasks can be marked as high, medium, or low priority, with visual indicators and filtering to help users manage their workload effectively.
126
-
127
- ## Assumptions Made
128
-
129
- - Assumed this is for an existing task management system with a tasks table
130
- - Assumed standard web UI (not mobile app)
131
- - Assumed MVP scope - basic priority features without advanced automation
132
- - Assumed users are familiar with priority systems from other tools
133
-
134
- ## Goals
135
-
136
- - Allow assigning priority (high/medium/low) to any task
137
- - Provide clear visual differentiation between priority levels
138
- - Enable filtering and sorting by priority
139
- - Default new tasks to medium priority
140
-
141
- ## User Stories
142
-
143
- ### US-001: Add priority field to database
144
- **Description:** As a developer, I need to store task priority so it persists across sessions.
145
-
146
- **Acceptance Criteria:**
147
- - [ ] Add priority column to tasks table: 'high' | 'medium' | 'low' (default 'medium')