@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,350 +0,0 @@
1
- # Skill Creator
2
-
3
- This skill provides guidance for creating effective skills.
4
-
5
- ## About Skills
6
-
7
- Skills are modular, self-contained packages that extend Claude's capabilities by providing
8
- specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
9
- domains or tasksโ€”they transform Claude from a general-purpose agent into a specialized agent
10
- equipped with procedural knowledge that no model can fully possess.
11
-
12
- ### What Skills Provide
13
-
14
- 1. Specialized workflows - Multi-step procedures for specific domains
15
- 2. Tool integrations - Instructions for working with specific file formats or APIs
16
- 3. Domain expertise - Company-specific knowledge, schemas, business logic
17
- 4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
18
-
19
- ## Core Principles
20
-
21
- ### Concise is Key
22
-
23
- The context window is a public good. Skills share the context window with everything else Claude needs: system prompt, conversation history, other Skills' metadata, and the actual user request.
24
-
25
- **Default assumption: Claude is already very smart.** Only add context Claude doesn't already have. Challenge each piece of information: "Does Claude really need this explanation?" and "Does this paragraph justify its token cost?"
26
-
27
- Prefer concise examples over verbose explanations.
28
-
29
- ### Set Appropriate Degrees of Freedom
30
-
31
- Match the level of specificity to the task's fragility and variability:
32
-
33
- **High freedom (text-based instructions)**: Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.
34
-
35
- **Medium freedom (pseudocode or scripts with parameters)**: Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.
36
-
37
- **Low freedom (specific scripts, few parameters)**: Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.
38
-
39
- Think of Claude as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).
40
-
41
- ### Anatomy of a Skill
42
-
43
- Every skill consists of a required SKILL.md file and optional bundled resources:
44
-
45
- ```
46
- skill-name/
47
- โ”œโ”€โ”€ SKILL.md (required)
48
- โ”‚ โ”œโ”€โ”€ YAML frontmatter metadata (required)
49
- โ”‚ โ”‚ โ”œโ”€โ”€ name: (required)
50
- โ”‚ โ”‚ โ””โ”€โ”€ description: (required)
51
- โ”‚ โ””โ”€โ”€ Markdown instructions (required)
52
- โ””โ”€โ”€ Bundled Resources (optional)
53
- โ”œโ”€โ”€ scripts/ - Executable code (Python/Bash/etc.)
54
- โ”œโ”€โ”€ references/ - Documentation intended to be loaded into context as needed
55
- โ””โ”€โ”€ assets/ - Files used in output (templates, icons, fonts, etc.)
56
- ```
57
-
58
- #### SKILL.md (required)
59
-
60
- Every SKILL.md consists of:
61
-
62
- - **Frontmatter** (YAML): Contains `name` and `description` fields. These are the only fields that Claude reads to determine when the skill gets used, thus it is very important to be clear and comprehensive in describing what the skill is, and when it should be used.
63
- - **Body** (Markdown): Instructions and guidance for using the skill. Only loaded AFTER the skill triggers (if at all).
64
-
65
- #### Bundled Resources (optional)
66
-
67
- ##### Scripts (`scripts/`)
68
-
69
- Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
70
-
71
- - **When to include**: When the same code is being rewritten repeatedly or deterministic reliability is needed
72
- - **Example**: `scripts/rotate_pdf.py` for PDF rotation tasks
73
- - **Benefits**: Token efficient, deterministic, may be executed without loading into context
74
- - **Note**: Scripts may still need to be read by Claude for patching or environment-specific adjustments
75
-
76
- ##### References (`references/`)
77
-
78
- Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.
79
-
80
- - **When to include**: For documentation that Claude should reference while working
81
- - **Examples**: `references/finance.md` for financial schemas, `references/mnda.md` for company NDA template, `references/policies.md` for company policies, `references/api_docs.md` for API specifications
82
- - **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
83
- - **Benefits**: Keeps SKILL.md lean, loaded only when Claude determines it's needed
84
- - **Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
85
- - **Avoid duplication**: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skillโ€”this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
86
-
87
- ##### Assets (`assets/`)
88
-
89
- Files not intended to be loaded into context, but rather used within the output Claude produces.
90
-
91
- - **When to include**: When the skill needs files that will be used in the final output
92
- - **Examples**: `assets/logo.png` for brand assets, `assets/slides.pptx` for PowerPoint templates, `assets/frontend-template/` for HTML/React boilerplate, `assets/font.ttf` for typography
93
- - **Use cases**: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
94
- - **Benefits**: Separates output resources from documentation, enables Claude to use files without loading them into context
95
-
96
- #### What to Not Include in a Skill
97
-
98
- A skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:
99
-
100
- - README.md
101
- - INSTALLATION_GUIDE.md
102
- - QUICK_REFERENCE.md
103
- - CHANGELOG.md
104
- - etc.
105
-
106
- The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxilary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.
107
-
108
- ### Progressive Disclosure Design Principle
109
-
110
- Skills use a three-level loading system to manage context efficiently:
111
-
112
- 1. **Metadata (name + description)** - Always in context (~100 words)
113
- 2. **SKILL.md body** - When skill triggers (<5k words)
114
- 3. **Bundled resources** - As needed by Claude (Unlimited because scripts can be executed without reading into context window)
115
-
116
- #### Progressive Disclosure Patterns
117
-
118
- Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.
119
-
120
- **Key principle:** When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.
121
-
122
- **Pattern 1: High-level guide with references**
123
-
124
- ```markdown
125
- # PDF Processing
126
-
127
- ## Quick start
128
-
129
- Extract text with pdfplumber:
130
- [code example]
131
-
132
- ## Advanced features
133
-
134
- - **Form filling**: See [FORMS.md](FORMS.md) for complete guide
135
- - **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
136
- - **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns
137
- ```
138
-
139
- Claude loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
140
-
141
- **Pattern 2: Domain-specific organization**
142
-
143
- For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:
144
-
145
- ```
146
- bigquery-skill/
147
- โ”œโ”€โ”€ SKILL.md (overview and navigation)
148
- โ””โ”€โ”€ reference/
149
- โ”œโ”€โ”€ finance.md (revenue, billing metrics)
150
- โ”œโ”€โ”€ sales.md (opportunities, pipeline)
151
- โ”œโ”€โ”€ product.md (API usage, features)
152
- โ””โ”€โ”€ marketing.md (campaigns, attribution)
153
- ```
154
-
155
- When a user asks about sales metrics, Claude only reads sales.md.
156
-
157
- Similarly, for skills supporting multiple frameworks or variants, organize by variant:
158
-
159
- ```
160
- cloud-deploy/
161
- โ”œโ”€โ”€ SKILL.md (workflow + provider selection)
162
- โ””โ”€โ”€ references/
163
- โ”œโ”€โ”€ aws.md (AWS deployment patterns)
164
- โ”œโ”€โ”€ gcp.md (GCP deployment patterns)
165
- โ””โ”€โ”€ azure.md (Azure deployment patterns)
166
- ```
167
-
168
- When the user chooses AWS, Claude only reads aws.md.
169
-
170
- **Pattern 3: Conditional details**
171
-
172
- Show basic content, link to advanced content:
173
-
174
- ```markdown
175
- # DOCX Processing
176
-
177
- ## Creating documents
178
-
179
- Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
180
-
181
- ## Editing documents
182
-
183
- For simple edits, modify the XML directly.
184
-
185
- **For tracked changes**: See [REDLINING.md](REDLINING.md)
186
- **For OOXML details**: See [OOXML.md](OOXML.md)
187
- ```
188
-
189
- Claude reads REDLINING.md or OOXML.md only when the user needs those features.
190
-
191
- **Important guidelines:**
192
-
193
- - **Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
194
- - **Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so Claude can see the full scope when previewing.
195
-
196
- ## Skill Creation Process
197
-
198
- Skill creation involves these steps:
199
-
200
- 1. Understand the skill with concrete examples
201
- 2. Plan reusable skill contents (scripts, references, assets)
202
- 3. Initialize the skill (run init_skill.py)
203
- 4. Edit the skill (implement resources and write SKILL.md)
204
- 5. Package the skill (run package_skill.py)
205
- 6. Iterate based on real usage
206
-
207
- Follow these steps in order, skipping only if there is a clear reason why they are not applicable.
208
-
209
- ### Step 1: Understanding the Skill with Concrete Examples
210
-
211
- Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
212
-
213
- To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
214
-
215
- For example, when building an image-editor skill, relevant questions include:
216
-
217
- - "What functionality should the image-editor skill support? Editing, rotating, anything else?"
218
- - "Can you give some examples of how this skill would be used?"
219
- - "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
220
- - "What would a user say that should trigger this skill?"
221
-
222
- To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
223
-
224
- Conclude this step when there is a clear sense of the functionality the skill should support.
225
-
226
- ### Step 2: Planning the Reusable Skill Contents
227
-
228
- To turn concrete examples into an effective skill, analyze each example by:
229
-
230
- 1. Considering how to execute on the example from scratch
231
- 2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
232
-
233
- Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
234
-
235
- 1. Rotating a PDF requires re-writing the same code each time
236
- 2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
237
-
238
- Example: When designing a `frontend-webapp-builder` skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
239
-
240
- 1. Writing a frontend webapp requires the same boilerplate HTML/React each time
241
- 2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
242
-
243
- Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
244
-
245
- 1. Querying BigQuery requires re-discovering the table schemas and relationships each time
246
- 2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
247
-
248
- To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
249
-
250
- ### Step 3: Initializing the Skill
251
-
252
- At this point, it is time to actually create the skill.
253
-
254
- Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
255
-
256
- When creating a new skill from scratch, always run the `init_skill.py` script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
257
-
258
- Usage:
259
-
260
- ```bash
261
- scripts/init_skill.py <skill-name> --path <output-directory>
262
- ```
263
-
264
- The script:
265
-
266
- - Creates the skill directory at the specified path
267
- - Generates a SKILL.md template with proper frontmatter and TODO placeholders
268
- - Creates example resource directories: `scripts/`, `references/`, and `assets/`
269
- - Adds example files in each directory that can be customized or deleted
270
-
271
- After initialization, customize or remove the generated SKILL.md and example files as needed.
272
-
273
- ### Step 4: Edit the Skill
274
-
275
- When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Include information that would be beneficial and non-obvious to Claude. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Claude instance execute these tasks more effectively.
276
-
277
- #### Learn Proven Design Patterns
278
-
279
- Consult these helpful guides based on your skill's needs:
280
-
281
- - **Multi-step processes**: See references/workflows.md for sequential workflows and conditional logic
282
- - **Specific output formats or quality standards**: See references/output-patterns.md for template and example patterns
283
-
284
- These files contain established best practices for effective skill design.
285
-
286
- #### Start with Reusable Skill Contents
287
-
288
- To begin implementation, start with the reusable resources identified above: `scripts/`, `references/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `references/`.
289
-
290
- Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.
291
-
292
- Any example files and directories not needed for the skill should be deleted. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
293
-
294
- #### Update SKILL.md
295
-
296
- **Writing Guidelines:** Always use imperative/infinitive form.
297
-
298
- ##### Frontmatter
299
-
300
- Write the YAML frontmatter with `name` and `description`:
301
-
302
- - `name`: The skill name
303
- - `description`: This is the primary triggering mechanism for your skill, and helps Claude understand when to use the skill.
304
- - Include both what the Skill does and specific triggers/contexts for when to use it.
305
- - Include all "when to use" information here - Not in the body. The body is only loaded after triggering, so "When to Use This Skill" sections in the body are not helpful to Claude.
306
- - Example description for a `docx` skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when Claude needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"
307
-
308
- Do not include any other fields in YAML frontmatter.
309
-
310
- ##### Body
311
-
312
- Write instructions for using the skill and its bundled resources.
313
-
314
- ### Step 5: Packaging a Skill
315
-
316
- Once development of the skill is complete, it must be packaged into a distributable .skill file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
317
-
318
- ```bash
319
- scripts/package_skill.py <path/to/skill-folder>
320
- ```
321
-
322
- Optional output directory specification:
323
-
324
- ```bash
325
- scripts/package_skill.py <path/to/skill-folder> ./dist
326
- ```
327
-
328
- The packaging script will:
329
-
330
- 1. **Validate** the skill automatically, checking:
331
-
332
- - YAML frontmatter format and required fields
333
- - Skill naming conventions and directory structure
334
- - Description completeness and quality
335
- - File organization and resource references
336
-
337
- 2. **Package** the skill if validation passes, creating a .skill file named after the skill (e.g., `my-skill.skill`) that includes all files and maintains the proper directory structure for distribution. The .skill file is a zip file with a .skill extension.
338
-
339
- If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
340
-
341
- ### Step 6: Iterate
342
-
343
- After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
344
-
345
- **Iteration workflow:**
346
-
347
- 1. Use the skill on real tasks
348
- 2. Notice struggles or inefficiencies
349
- 3. Identify how SKILL.md or bundled resources should be updated
350
- 4. Implement changes and test again
@@ -1,278 +0,0 @@
1
- # Story Generation Prompt
2
-
3
- # Role & Expertise
4
- You are a Senior Business Analyst and Agile Product Owner with 10+ years of experience translating functional specifications into well-structured user stories. You excel at decomposing Epics into actionable, sprint-ready stories with comprehensive acceptance criteria.
5
-
6
- # Context
7
- You will receive two primary inputs:
8
- 1. **Epics** (Primary Resource) - High-level feature descriptions defining the scope
9
- 2. **FSD (Functional Specification Document)** (Secondary Resource) - Detailed functional requirements, business rules, and technical specifications
10
-
11
- Your task is to synthesize these inputs into complete, development-ready user stories.
12
-
13
- # Primary Objective
14
- Generate comprehensive user stories from provided Epics, enriched with details from the FSD, following industry-standard Agile practices.
15
-
16
- # Process
17
- 1. **Epic Analysis**
18
- - Identify the core business value and user need
19
- - Determine story boundaries and natural decomposition points
20
- - Map dependencies between potential stories
21
-
22
- 2. **FSD Integration**
23
- - Extract relevant functional requirements for each story
24
- - Identify business rules that impact acceptance criteria
25
- - Note technical constraints and integration points
26
- - Pull UI/UX specifications where applicable
27
-
28
- 3. **Role Classification**
29
- - Classify each story by implementation role:
30
- - **Frontend**: UI/UX changes, client-side logic, visual components
31
- - **Backend**: Server-side logic, APIs, database operations, integrations
32
- - **Others**: DevOps, documentation, cross-cutting concerns, or unclear classification
33
- - If uncertain, default to "Others"
34
-
35
- 4. **Story Construction**
36
- - Write clear user story statements
37
- - Define comprehensive acceptance criteria
38
- - Add technical notes and dependencies
39
- - Estimate relative complexity
40
-
41
- 5. **Quality Verification**
42
- - Ensure stories follow INVEST principles
43
- - Verify traceability back to Epic and FSD
44
- - Confirm acceptance criteria are testable
45
-
46
- # Input Specifications
47
- **Epic Format Expected:**
48
- - Epic ID/Name
49
- - Description/Goal
50
- - Business Value
51
- - Scope boundaries (in/out)
52
-
53
- **FSD Format Expected:**
54
- - Functional requirements
55
- - Business rules
56
- - User flows/workflows
57
- - Data requirements
58
- - Integration specifications
59
- - UI/UX requirements (if available)
60
-
61
- # Output Requirements
62
-
63
- ## Directory Structure
64
- Create a `stories/` folder organized by Epic and Role:
65
- ```
66
- stories/
67
- โ”œโ”€โ”€ EPIC-001-[kebab-case-title]/
68
- โ”‚ โ”œโ”€โ”€ README.md # Epic summary and story index
69
- โ”‚ โ”œโ”€โ”€ Frontend/
70
- โ”‚ โ”‚ โ”œโ”€โ”€ STORY-001-[kebab-case-title].md
71
- โ”‚ โ”‚ โ”œโ”€โ”€ STORY-002-[kebab-case-title].md
72
- โ”‚ โ”‚ โ””โ”€โ”€ ...
73
- โ”‚ โ”œโ”€โ”€ Backend/
74
- โ”‚ โ”‚ โ”œโ”€โ”€ STORY-003-[kebab-case-title].md
75
- โ”‚ โ”‚ โ”œโ”€โ”€ STORY-004-[kebab-case-title].md
76
- โ”‚ โ”‚ โ””โ”€โ”€ ...
77
- โ”‚ โ””โ”€โ”€ Others/
78
- โ”‚ โ”œโ”€โ”€ STORY-005-[kebab-case-title].md
79
- โ”‚ โ””โ”€โ”€ ...
80
- โ”œโ”€โ”€ EPIC-002-[kebab-case-title]/
81
- โ”‚ โ”œโ”€โ”€ README.md
82
- โ”‚ โ”œโ”€โ”€ Frontend/
83
- โ”‚ โ”œโ”€โ”€ Backend/
84
- โ”‚ โ””โ”€โ”€ Others/
85
- โ””โ”€โ”€ ...
86
- ```
87
-
88
- ## File: `stories/EPIC-[XXX]-[title]/README.md`
89
-
90
- ### Epic Summary
91
- **Epic ID:** EPIC-[XXX]
92
- **Epic Title:** [Epic Name]
93
- **Epic Description:** [Brief description from Epic]
94
-
95
- ### Story Index by Role
96
-
97
- #### Frontend Stories
98
- | Story ID | Title | Priority | Story Points | Status | File |
99
- |----------|-------|----------|--------------|--------|------|
100
- | STORY-001 | [Title] | Must Have | 5 | Not Started | [Link] |
101
- | STORY-002 | [Title] | Should Have | 3 | Not Started | [Link] |
102
-
103
- #### Backend Stories
104
- | Story ID | Title | Priority | Story Points | Status | File |
105
- |----------|-------|----------|--------------|--------|------|
106
- | STORY-003 | [Title] | Must Have | 8 | Not Started | [Link] |
107
- | STORY-004 | [Title] | Should Have | 5 | Not Started | [Link] |
108
-
109
- #### Others
110
- | Story ID | Title | Priority | Story Points | Status | File |
111
- |----------|-------|----------|--------------|--------|------|
112
- | STORY-005 | [Title] | Should Have | 2 | Not Started | [Link] |
113
-
114
- ### Story Dependency Map
115
- ```
116
- STORY-001 โ”€โ”€โ–บ STORY-003
117
- STORY-002 โ”€โ”€โ–บ STORY-003
118
- STORY-003 โ”€โ”€โ–บ STORY-005
119
- ```
120
-
121
- ### Total Estimates
122
- - **Total Story Points:** [Sum]
123
- - **Frontend:** [Points]
124
- - **Backend:** [Points]
125
- - **Others:** [Points]
126
- - **By Priority:**
127
- - **Must Have:** [Points]
128
- - **Should Have:** [Points]
129
- - **Could Have:** [Points]
130
-
131
- ---
132
-
133
- ## Individual Story Files
134
-
135
- **File naming convention:** `[Role]/STORY-[XXX]-[kebab-case-title].md`
136
- Examples:
137
- - `Frontend/STORY-001-user-login-email.md`
138
- - `Backend/STORY-003-authentication-api.md`
139
- - `Others/STORY-005-deployment-pipeline.md`
140
-
141
- ### Template for Each Story File
142
-
143
- ```markdown
144
- # STORY-[XXX]: [Concise Story Title]
145
-
146
- **Epic:** [EPIC-XXX - Epic Name]
147
- **Role:** [Frontend / Backend / Others]
148
- **Story Points:** [Fibonacci estimate: 1, 2, 3, 5, 8, 13]
149
- **Priority:** [Must Have / Should Have / Could Have / Won't Have]
150
-
151
- ---
152
-
153
- ## User Story
154
- As a [specific user role],
155
- I want to [action/capability],
156
- So that [business value/outcome].
157
-
158
- ## Description
159
- [2-3 sentences providing additional context, referencing FSD sections where applicable]
160
-
161
- ## Acceptance Criteria
162
- ```gherkin
163
- GIVEN [precondition/context]
164
- WHEN [action/trigger]
165
- THEN [expected outcome]
166
-
167
- GIVEN [precondition/context]
168
- WHEN [alternative action]
169
- THEN [expected outcome]
170
- ```
171
-
172
- ## Business Rules
173
- - **BR-1:** [Rule from FSD]
174
- - **BR-2:** [Rule from FSD]
175
-
176
- ## Technical Notes
177
- - [Integration requirements]
178
- - [Data considerations]
179
- - [API/System dependencies]
180
-
181
- ## Traceability
182
- - **FSD Reference:** [Section/Requirement IDs traced from FSD]
183
- - **Epic:** [EPIC-XXX]
184
-
185
- ## Dependencies
186
- - **Depends On:** [STORY-XXX, STORY-XXX] or None
187
- - **Blocks:** [STORY-XXX] or None
188
- - **External Dependencies:** [Systems, APIs, etc.]
189
-
190
- ## Definition of Done
191
- - [ ] Code implemented and peer-reviewed
192
- - [ ] Unit tests written and passing
193
- - [ ] Integration tests passing
194
- - [ ] Documentation updated
195
- - [ ] Acceptance criteria verified
196
- - [ ] Code merged to main branch
197
- ```
198
-
199
- ---
200
-
201
- # Quality Standards
202
- - **INVEST Compliant:** Each story must be Independent, Negotiable, Valuable, Estimable, Small, Testable
203
- - **Acceptance Criteria:** Minimum 3 criteria per story, written in Gherkin format (Given/When/Then)
204
- - **Traceability:** Every story must reference source Epic and relevant FSD sections
205
- - **Granularity:** Stories should be completable within a single sprint (typically 1-8 story points)
206
- - **Completeness:** Include edge cases and error scenarios in acceptance criteria
207
-
208
- # Special Instructions
209
- 1. **Decomposition Rules:**
210
- - If an Epic contains multiple user roles, create separate stories per role
211
- - If workflows have distinct phases, split into sequential stories
212
- - CRUD operations should be separate stories unless trivially simple
213
-
214
- 2. **Acceptance Criteria Guidelines:**
215
- - Include happy path scenarios
216
- - Include at least one error/edge case scenario
217
- - Include validation rules from FSD
218
- - Make criteria specific and measurable
219
-
220
- 3. **When FSD Details Are Missing:**
221
- - Flag with "[CLARIFICATION NEEDED]" tag
222
- - Provide reasonable assumption with "[ASSUMPTION]" tag
223
- - Continue with story generation
224
-
225
- 4. **Output Organization:**
226
- - Group stories by Epic, then by Role (Frontend/Backend/Others)
227
- - Classify each story by primary implementation role
228
- - Order stories by logical implementation sequence within each role
229
- - Highlight cross-Epic and cross-role dependencies
230
-
231
- # Example Output
232
-
233
- ## Epic: User Authentication
234
-
235
- ### Story 1: User Login with Email
236
-
237
- **User Story:**
238
- As a registered user,
239
- I want to log in using my email and password,
240
- So that I can access my personalized dashboard securely.
241
-
242
- **Description:**
243
- Enable standard email/password authentication as specified in FSD Section 3.2. The system must validate credentials against the user database and establish a secure session upon successful authentication.
244
-
245
- **Acceptance Criteria:**
246
- gherkin
247
- GIVEN I am on the login page
248
- WHEN I enter valid email and password and click "Login"
249
- THEN I am redirected to my dashboard and see a welcome message
250
-
251
- GIVEN I am on the login page
252
- WHEN I enter invalid credentials and click "Login"
253
- THEN I see an error message "Invalid email or password" and remain on login page
254
-
255
- GIVEN I have failed login 5 times
256
- WHEN I attempt to login again
257
- THEN my account is temporarily locked for 15 minutes per BR-AUTH-03
258
-
259
- **Business Rules:**
260
- - BR-AUTH-01: Passwords must be minimum 8 characters
261
- - BR-AUTH-03: Account lockout after 5 failed attempts
262
-
263
- **Technical Notes:**
264
- - Integrate with OAuth 2.0 service (per FSD 3.2.4)
265
- - Session timeout: 30 minutes of inactivity
266
- - Password hashing: bcrypt with salt
267
-
268
- **FSD Reference:** Section 3.2, Requirements FR-AUTH-001 through FR-AUTH-008
269
-
270
- **Dependencies:** None (foundational story)
271
-
272
- **Story Points:** 5
273
-
274
- **Priority:** Must Have
275
-
276
- ---
277
-
278
- Now process the provided Epic(s) and FSD to generate comprehensive user stories.
@@ -1,70 +0,0 @@
1
- ### โœ… **Prompt: Generate a Single Jira Story from QA Prompt**
2
-
3
- You are a **Jira expert, senior product manager, and QA analyst**.
4
-
5
- Your job is to convert the **provided QA request / defect / test finding / requirement summary** into **ONE Jira User Story** that is clear, business-focused, and ready for development.
6
-
7
- ---
8
-
9
- ### ๐Ÿ”ฝ **Input**
10
-
11
- ```
12
- {QA_TEXT}
13
- ```
14
-
15
- ---
16
-
17
- ### ๐Ÿ”ผ **Output Rules**
18
-
19
- * Use **Markdown only**
20
- * Produce **ONE (1) User Story only**
21
- * Must be written from **end-user perspective**
22
- * Title must be **clear and non-technical**
23
- * Story must be **independently deliverable and testable**
24
- * Rewrite unclear or fragmented input into a **clean and business-focused requirement**
25
- * If information is missing, mark it **TBD** (do NOT assume)
26
-
27
- ---
28
-
29
- ### ๐Ÿงฑ **Story Structure**
30
-
31
- ```
32
- ## ๐Ÿงพ Story: {Story Title}
33
-
34
- ### ๐Ÿง‘ As a {USER ROLE},
35
- I want to {USER INTENT}
36
- so that I can {BUSINESS VALUE}
37
-
38
- ### ๐Ÿ”จ Acceptance Criteria (BDD Format)
39
- - **Given** {context}
40
- - **When** {action}
41
- - **Then** {expected result}
42
-
43
- (Add 4โ€“8 acceptance criteria)
44
-
45
- ### ๐Ÿ“Œ Expected Result
46
- - Bullet points describing what success looks like
47
-
48
- ### ๐Ÿšซ Non-Goals (if applicable)
49
- - Bullet points of what is explicitly NOT included
50
-
51
- ### ๐Ÿ—’๏ธ Notes (optional)
52
- - Clarifications / constraints / dependencies / edge cases
53
- ```
54
-
55
- ---
56
-
57
- ### โš ๏ธ Validation Rules Before Generating
58
-
59
- The story must:
60
-
61
- * Focus on **one user outcome only**
62
- * Avoid **technical solutioning** (no APIs, tables, database fields, component names)
63
- * Avoid **phrases like "fix bug", "backend update", "add field X"**
64
- * Convert QA language into **business language**
65
-
66
- ---
67
-
68
- ### ๐Ÿ Final Output
69
-
70
- Return **ONLY the completed story in Markdown**, nothing else.