@ckelsoe/prompt-architect 3.0.2 → 3.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/.claude-plugin/marketplace.json +1 -1
  2. package/.claude-plugin/plugin.json +1 -1
  3. package/CHANGELOG.md +264 -264
  4. package/LICENSE +21 -21
  5. package/README.md +1064 -1184
  6. package/adapters/README.md +75 -267
  7. package/adapters/for-windsurf.md +136 -136
  8. package/adapters/system-prompt.md +243 -243
  9. package/package.json +139 -138
  10. package/scripts/build-skill.js +64 -0
  11. package/scripts/install.js +4 -54
  12. package/scripts/test.js +205 -213
  13. package/scripts/validate-skill.js +350 -350
  14. package/skills/prompt-architect/SKILL.md +331 -331
  15. package/skills/prompt-architect/assets/templates/ape_template.txt +5 -5
  16. package/skills/prompt-architect/assets/templates/bab_template.txt +15 -15
  17. package/skills/prompt-architect/assets/templates/broke_template.txt +15 -15
  18. package/skills/prompt-architect/assets/templates/cai-critique-revise_template.txt +18 -18
  19. package/skills/prompt-architect/assets/templates/care_template.txt +16 -16
  20. package/skills/prompt-architect/assets/templates/chain-of-density_template.txt +46 -46
  21. package/skills/prompt-architect/assets/templates/chain-of-thought_template.txt +49 -49
  22. package/skills/prompt-architect/assets/templates/co-star_template.txt +17 -17
  23. package/skills/prompt-architect/assets/templates/crispe_template.txt +14 -14
  24. package/skills/prompt-architect/assets/templates/ctf_template.txt +15 -15
  25. package/skills/prompt-architect/assets/templates/devils-advocate_template.txt +25 -25
  26. package/skills/prompt-architect/assets/templates/hybrid_template.txt +101 -101
  27. package/skills/prompt-architect/assets/templates/least-to-most_template.txt +16 -16
  28. package/skills/prompt-architect/assets/templates/plan-and-solve_template.txt +7 -7
  29. package/skills/prompt-architect/assets/templates/pre-mortem_template.txt +27 -27
  30. package/skills/prompt-architect/assets/templates/race_template.txt +19 -19
  31. package/skills/prompt-architect/assets/templates/rcot_template.txt +31 -31
  32. package/skills/prompt-architect/assets/templates/react_template.txt +27 -27
  33. package/skills/prompt-architect/assets/templates/reverse-role_template.txt +11 -11
  34. package/skills/prompt-architect/assets/templates/rise-ie_template.txt +23 -23
  35. package/skills/prompt-architect/assets/templates/rise-ix_template.txt +28 -28
  36. package/skills/prompt-architect/assets/templates/risen_template.txt +21 -21
  37. package/skills/prompt-architect/assets/templates/rpef_template.txt +26 -26
  38. package/skills/prompt-architect/assets/templates/rtf_template.txt +13 -13
  39. package/skills/prompt-architect/assets/templates/self-refine_template.txt +16 -16
  40. package/skills/prompt-architect/assets/templates/skeleton-of-thought_template.txt +15 -15
  41. package/skills/prompt-architect/assets/templates/step-back_template.txt +10 -10
  42. package/skills/prompt-architect/assets/templates/tidd-ec_template.txt +45 -45
  43. package/skills/prompt-architect/assets/templates/tree-of-thought_template.txt +30 -30
  44. package/skills/prompt-architect/references/frameworks/ape.md +200 -200
  45. package/skills/prompt-architect/references/frameworks/bab.md +242 -242
  46. package/skills/prompt-architect/references/frameworks/broke.md +242 -242
  47. package/skills/prompt-architect/references/frameworks/cai-critique-revise.md +230 -230
  48. package/skills/prompt-architect/references/frameworks/care.md +235 -235
  49. package/skills/prompt-architect/references/frameworks/chain-of-density.md +479 -479
  50. package/skills/prompt-architect/references/frameworks/chain-of-thought.md +424 -424
  51. package/skills/prompt-architect/references/frameworks/co-star.md +256 -256
  52. package/skills/prompt-architect/references/frameworks/crispe.md +253 -253
  53. package/skills/prompt-architect/references/frameworks/ctf.md +207 -207
  54. package/skills/prompt-architect/references/frameworks/devils-advocate.md +206 -206
  55. package/skills/prompt-architect/references/frameworks/least-to-most.md +226 -226
  56. package/skills/prompt-architect/references/frameworks/plan-and-solve.md +210 -210
  57. package/skills/prompt-architect/references/frameworks/pre-mortem.md +197 -197
  58. package/skills/prompt-architect/references/frameworks/race.md +243 -243
  59. package/skills/prompt-architect/references/frameworks/rcot.md +203 -203
  60. package/skills/prompt-architect/references/frameworks/react.md +304 -304
  61. package/skills/prompt-architect/references/frameworks/reverse-role.md +189 -189
  62. package/skills/prompt-architect/references/frameworks/rise.md +555 -555
  63. package/skills/prompt-architect/references/frameworks/risen.md +297 -297
  64. package/skills/prompt-architect/references/frameworks/rpef.md +195 -195
  65. package/skills/prompt-architect/references/frameworks/rtf.md +358 -358
  66. package/skills/prompt-architect/references/frameworks/self-refine.md +205 -205
  67. package/skills/prompt-architect/references/frameworks/skeleton-of-thought.md +186 -186
  68. package/skills/prompt-architect/references/frameworks/step-back.md +206 -206
  69. package/skills/prompt-architect/references/frameworks/tidd-ec.md +470 -470
  70. package/skills/prompt-architect/references/frameworks/tree-of-thought.md +260 -260
  71. package/skills/prompt-architect/scripts/framework_analyzer.py +807 -807
  72. package/skills/prompt-architect/scripts/prompt_evaluator.py +336 -336
  73. package/adapters/for-cursor.mdc +0 -138
  74. package/adapters/for-gemini-cli.md +0 -70
  75. package/adapters/for-github-copilot.md +0 -141
  76. package/adapters/for-openai-codex-cli.md +0 -158
@@ -1,256 +1,256 @@
1
- # CO-STAR Framework
2
-
3
- ## Overview
4
-
5
- CO-STAR is a comprehensive prompting framework that emphasizes context, audience, and communication style. It's particularly effective for content creation, writing tasks, and scenarios where tone and audience considerations significantly impact output quality.
6
-
7
- ## Components
8
-
9
- ### C - Context
10
- **Purpose:** Provide background information, situational details, and constraints.
11
-
12
- **Questions to Ask:**
13
- - What's the background situation?
14
- - What constraints exist?
15
- - What's happened previously?
16
- - What environment/platform is this for?
17
- - Are there any limitations or restrictions?
18
-
19
- **Examples:**
20
- - "You're working with a startup that has limited resources..."
21
- - "This is for a formal government report..."
22
- - "The user base is primarily non-technical..."
23
-
24
- ### O - Objective
25
- **Purpose:** Define the clear, specific goal to be achieved.
26
-
27
- **Questions to Ask:**
28
- - What exactly do you want accomplished?
29
- - What does success look like?
30
- - What's the primary outcome?
31
- - Are there secondary goals?
32
-
33
- **Examples:**
34
- - "Create a comprehensive product comparison..."
35
- - "Generate ideas for reducing customer churn..."
36
- - "Explain the concept in simple terms..."
37
-
38
- ### S - Style
39
- **Purpose:** Specify the writing style, format, and structural preferences.
40
-
41
- **Questions to Ask:**
42
- - What writing style is appropriate?
43
- - Should it be formal or casual?
44
- - Are there format requirements?
45
- - Should it follow a specific structure?
46
- - Any style guides to follow?
47
-
48
- **Examples:**
49
- - "Use a journalistic style with short paragraphs..."
50
- - "Follow AP style guidelines..."
51
- - "Write in a conversational, blog-post style..."
52
-
53
- ### T - Tone
54
- **Purpose:** Set the emotional quality and attitude of the response.
55
-
56
- **Questions to Ask:**
57
- - What emotional quality should it have?
58
- - Should it be serious or light-hearted?
59
- - Authoritative or humble?
60
- - Urgent or measured?
61
-
62
- **Examples:**
63
- - "Professional yet friendly..."
64
- - "Urgent and action-oriented..."
65
- - "Empathetic and supportive..."
66
- - "Confident and authoritative..."
67
-
68
- ### A - Audience
69
- **Purpose:** Identify who will consume the output and their characteristics.
70
-
71
- **Questions to Ask:**
72
- - Who is the target audience?
73
- - What's their expertise level?
74
- - What do they care about?
75
- - What are their pain points?
76
- - What's their context?
77
-
78
- **Examples:**
79
- - "Senior executives with limited technical knowledge..."
80
- - "Junior developers learning the framework..."
81
- - "Parents of elementary school children..."
82
-
83
- ### R - Response
84
- **Purpose:** Define the expected output format and structure.
85
-
86
- **Questions to Ask:**
87
- - What format should the output take?
88
- - How long should it be?
89
- - Should it include specific sections?
90
- - Are there structural requirements?
91
- - What level of detail is needed?
92
-
93
- **Examples:**
94
- - "Provide a 500-word article with 3 main sections..."
95
- - "Create a bulleted list of 10 items..."
96
- - "Generate a table comparing features..."
97
-
98
- ## Template Structure
99
-
100
- ```
101
- CONTEXT:
102
- [Background information, situation, constraints]
103
-
104
- OBJECTIVE:
105
- [Clear, specific goal to achieve]
106
-
107
- STYLE:
108
- [Writing style, format preferences]
109
-
110
- TONE:
111
- [Emotional quality, formality level]
112
-
113
- AUDIENCE:
114
- [Target audience characteristics]
115
-
116
- RESPONSE FORMAT:
117
- [Expected output structure and format]
118
- ```
119
-
120
- ## Complete Example
121
-
122
- ### Before CO-STAR:
123
- "Write about the benefits of exercise."
124
-
125
- ### After CO-STAR:
126
- ```
127
- CONTEXT:
128
- I'm creating content for a health blog aimed at busy professionals who struggle to find time for fitness. Previous articles have focused on nutrition, and this is part of a series on lifestyle improvements.
129
-
130
- OBJECTIVE:
131
- Create an engaging article that convinces time-pressed professionals that exercise is worth prioritizing, focusing on benefits beyond just physical health.
132
-
133
- STYLE:
134
- Use a conversational blog style with short paragraphs (2-3 sentences), subheadings every 150-200 words, and occasional bullet points for key takeaways. Include specific examples and avoid medical jargon.
135
-
136
- TONE:
137
- Encouraging and motivating without being preachy. Acknowledge their time constraints and show empathy for their challenges. Be practical and realistic rather than idealistic.
138
-
139
- AUDIENCE:
140
- Professionals aged 30-50 who work 50+ hour weeks, have limited free time, may have families, and currently don't exercise regularly. They're skeptical of fitness advice that seems unrealistic for their lifestyle.
141
-
142
- RESPONSE FORMAT:
143
- 800-word article with:
144
- - Engaging headline
145
- - Brief introduction (2-3 sentences)
146
- - 4-5 main sections with subheadings
147
- - Bullet points highlighting key benefits
148
- - Practical conclusion with next steps
149
- ```
150
-
151
- ## Best Use Cases
152
-
153
- 1. **Content Creation**
154
- - Blog posts, articles, marketing copy
155
- - When multiple stakeholders will review
156
- - When brand voice matters
157
-
158
- 2. **Communication Tasks**
159
- - Emails to specific audiences
160
- - Presentations
161
- - Reports with specific readers
162
-
163
- 3. **Creative Writing**
164
- - When tone significantly impacts effectiveness
165
- - When audience understanding is critical
166
- - When style consistency matters
167
-
168
- 4. **Educational Content**
169
- - Teaching materials
170
- - Explanations for specific skill levels
171
- - Documentation for user groups
172
-
173
- ## Selection Criteria
174
-
175
- **Choose CO-STAR when:**
176
- - ✅ Task involves writing or content creation
177
- - ✅ Multiple stakeholders or diverse audience
178
- - ✅ Tone and style significantly impact success
179
- - ✅ Rich contextual requirements exist
180
- - ✅ Brand or voice consistency matters
181
- - ✅ Audience characteristics are well-defined
182
-
183
- **Avoid CO-STAR when:**
184
- - ❌ Task is purely analytical/technical
185
- - ❌ Audience doesn't matter
186
- - ❌ Tone is irrelevant
187
- - ❌ Simple, quick task without context needs
188
- - ❌ Format is the only concern
189
-
190
- ## Common Mistakes
191
-
192
- 1. **Too Much Context**
193
- - Include only relevant background
194
- - Avoid tangential information
195
- - Focus on what impacts the task
196
-
197
- 2. **Vague Objective**
198
- - Be specific about desired outcome
199
- - Quantify when possible
200
- - Clarify success criteria
201
-
202
- 3. **Confusing Style and Tone**
203
- - Style = structural/format choices
204
- - Tone = emotional quality
205
- - Keep them separate
206
-
207
- 4. **Generic Audience Description**
208
- - Be specific about audience characteristics
209
- - Include their knowledge level
210
- - Mention their goals/pain points
211
-
212
- ## Variations and Combinations
213
-
214
- ### CO-STAR + Chain of Thought
215
- Use for complex content that requires reasoning:
216
- ```
217
- [Standard CO-STAR components]
218
-
219
- PROCESS:
220
- Think through this step-by-step:
221
- 1. Identify key themes
222
- 2. Organize supporting evidence
223
- 3. Structure argument flow
224
- 4. Draft with examples
225
- ```
226
-
227
- ### CO-STAR + RISEN
228
- For content creation with specific methodology:
229
- ```
230
- [Use CO-STAR for context/audience/tone]
231
- [Use RISEN's Steps for the creation process]
232
- [Use CO-STAR's Response for output format]
233
- ```
234
-
235
- ## Quick Reference
236
-
237
- | Component | Focus | Key Question |
238
- |-----------|-------|--------------|
239
- | Context | Background | "What's the situation?" |
240
- | Objective | Goal | "What do you want achieved?" |
241
- | Style | Format/Structure | "How should it be written?" |
242
- | Tone | Emotional Quality | "What feeling should it convey?" |
243
- | Audience | Reader | "Who is this for?" |
244
- | Response | Output | "What should the output look like?" |
245
-
246
- ## Assessment Checklist
247
-
248
- When applying CO-STAR, verify:
249
- - [ ] Context provides necessary background without excess
250
- - [ ] Objective is specific and measurable
251
- - [ ] Style guidance is clear and actionable
252
- - [ ] Tone matches audience and objective
253
- - [ ] Audience is well-defined with characteristics
254
- - [ ] Response format is detailed and specific
255
- - [ ] All components work together cohesively
256
- - [ ] Nothing contradicts other components
1
+ # CO-STAR Framework
2
+
3
+ ## Overview
4
+
5
+ CO-STAR is a comprehensive prompting framework that emphasizes context, audience, and communication style. It's particularly effective for content creation, writing tasks, and scenarios where tone and audience considerations significantly impact output quality.
6
+
7
+ ## Components
8
+
9
+ ### C - Context
10
+ **Purpose:** Provide background information, situational details, and constraints.
11
+
12
+ **Questions to Ask:**
13
+ - What's the background situation?
14
+ - What constraints exist?
15
+ - What's happened previously?
16
+ - What environment/platform is this for?
17
+ - Are there any limitations or restrictions?
18
+
19
+ **Examples:**
20
+ - "You're working with a startup that has limited resources..."
21
+ - "This is for a formal government report..."
22
+ - "The user base is primarily non-technical..."
23
+
24
+ ### O - Objective
25
+ **Purpose:** Define the clear, specific goal to be achieved.
26
+
27
+ **Questions to Ask:**
28
+ - What exactly do you want accomplished?
29
+ - What does success look like?
30
+ - What's the primary outcome?
31
+ - Are there secondary goals?
32
+
33
+ **Examples:**
34
+ - "Create a comprehensive product comparison..."
35
+ - "Generate ideas for reducing customer churn..."
36
+ - "Explain the concept in simple terms..."
37
+
38
+ ### S - Style
39
+ **Purpose:** Specify the writing style, format, and structural preferences.
40
+
41
+ **Questions to Ask:**
42
+ - What writing style is appropriate?
43
+ - Should it be formal or casual?
44
+ - Are there format requirements?
45
+ - Should it follow a specific structure?
46
+ - Any style guides to follow?
47
+
48
+ **Examples:**
49
+ - "Use a journalistic style with short paragraphs..."
50
+ - "Follow AP style guidelines..."
51
+ - "Write in a conversational, blog-post style..."
52
+
53
+ ### T - Tone
54
+ **Purpose:** Set the emotional quality and attitude of the response.
55
+
56
+ **Questions to Ask:**
57
+ - What emotional quality should it have?
58
+ - Should it be serious or light-hearted?
59
+ - Authoritative or humble?
60
+ - Urgent or measured?
61
+
62
+ **Examples:**
63
+ - "Professional yet friendly..."
64
+ - "Urgent and action-oriented..."
65
+ - "Empathetic and supportive..."
66
+ - "Confident and authoritative..."
67
+
68
+ ### A - Audience
69
+ **Purpose:** Identify who will consume the output and their characteristics.
70
+
71
+ **Questions to Ask:**
72
+ - Who is the target audience?
73
+ - What's their expertise level?
74
+ - What do they care about?
75
+ - What are their pain points?
76
+ - What's their context?
77
+
78
+ **Examples:**
79
+ - "Senior executives with limited technical knowledge..."
80
+ - "Junior developers learning the framework..."
81
+ - "Parents of elementary school children..."
82
+
83
+ ### R - Response
84
+ **Purpose:** Define the expected output format and structure.
85
+
86
+ **Questions to Ask:**
87
+ - What format should the output take?
88
+ - How long should it be?
89
+ - Should it include specific sections?
90
+ - Are there structural requirements?
91
+ - What level of detail is needed?
92
+
93
+ **Examples:**
94
+ - "Provide a 500-word article with 3 main sections..."
95
+ - "Create a bulleted list of 10 items..."
96
+ - "Generate a table comparing features..."
97
+
98
+ ## Template Structure
99
+
100
+ ```
101
+ CONTEXT:
102
+ [Background information, situation, constraints]
103
+
104
+ OBJECTIVE:
105
+ [Clear, specific goal to achieve]
106
+
107
+ STYLE:
108
+ [Writing style, format preferences]
109
+
110
+ TONE:
111
+ [Emotional quality, formality level]
112
+
113
+ AUDIENCE:
114
+ [Target audience characteristics]
115
+
116
+ RESPONSE FORMAT:
117
+ [Expected output structure and format]
118
+ ```
119
+
120
+ ## Complete Example
121
+
122
+ ### Before CO-STAR:
123
+ "Write about the benefits of exercise."
124
+
125
+ ### After CO-STAR:
126
+ ```
127
+ CONTEXT:
128
+ I'm creating content for a health blog aimed at busy professionals who struggle to find time for fitness. Previous articles have focused on nutrition, and this is part of a series on lifestyle improvements.
129
+
130
+ OBJECTIVE:
131
+ Create an engaging article that convinces time-pressed professionals that exercise is worth prioritizing, focusing on benefits beyond just physical health.
132
+
133
+ STYLE:
134
+ Use a conversational blog style with short paragraphs (2-3 sentences), subheadings every 150-200 words, and occasional bullet points for key takeaways. Include specific examples and avoid medical jargon.
135
+
136
+ TONE:
137
+ Encouraging and motivating without being preachy. Acknowledge their time constraints and show empathy for their challenges. Be practical and realistic rather than idealistic.
138
+
139
+ AUDIENCE:
140
+ Professionals aged 30-50 who work 50+ hour weeks, have limited free time, may have families, and currently don't exercise regularly. They're skeptical of fitness advice that seems unrealistic for their lifestyle.
141
+
142
+ RESPONSE FORMAT:
143
+ 800-word article with:
144
+ - Engaging headline
145
+ - Brief introduction (2-3 sentences)
146
+ - 4-5 main sections with subheadings
147
+ - Bullet points highlighting key benefits
148
+ - Practical conclusion with next steps
149
+ ```
150
+
151
+ ## Best Use Cases
152
+
153
+ 1. **Content Creation**
154
+ - Blog posts, articles, marketing copy
155
+ - When multiple stakeholders will review
156
+ - When brand voice matters
157
+
158
+ 2. **Communication Tasks**
159
+ - Emails to specific audiences
160
+ - Presentations
161
+ - Reports with specific readers
162
+
163
+ 3. **Creative Writing**
164
+ - When tone significantly impacts effectiveness
165
+ - When audience understanding is critical
166
+ - When style consistency matters
167
+
168
+ 4. **Educational Content**
169
+ - Teaching materials
170
+ - Explanations for specific skill levels
171
+ - Documentation for user groups
172
+
173
+ ## Selection Criteria
174
+
175
+ **Choose CO-STAR when:**
176
+ - ✅ Task involves writing or content creation
177
+ - ✅ Multiple stakeholders or diverse audience
178
+ - ✅ Tone and style significantly impact success
179
+ - ✅ Rich contextual requirements exist
180
+ - ✅ Brand or voice consistency matters
181
+ - ✅ Audience characteristics are well-defined
182
+
183
+ **Avoid CO-STAR when:**
184
+ - ❌ Task is purely analytical/technical
185
+ - ❌ Audience doesn't matter
186
+ - ❌ Tone is irrelevant
187
+ - ❌ Simple, quick task without context needs
188
+ - ❌ Format is the only concern
189
+
190
+ ## Common Mistakes
191
+
192
+ 1. **Too Much Context**
193
+ - Include only relevant background
194
+ - Avoid tangential information
195
+ - Focus on what impacts the task
196
+
197
+ 2. **Vague Objective**
198
+ - Be specific about desired outcome
199
+ - Quantify when possible
200
+ - Clarify success criteria
201
+
202
+ 3. **Confusing Style and Tone**
203
+ - Style = structural/format choices
204
+ - Tone = emotional quality
205
+ - Keep them separate
206
+
207
+ 4. **Generic Audience Description**
208
+ - Be specific about audience characteristics
209
+ - Include their knowledge level
210
+ - Mention their goals/pain points
211
+
212
+ ## Variations and Combinations
213
+
214
+ ### CO-STAR + Chain of Thought
215
+ Use for complex content that requires reasoning:
216
+ ```
217
+ [Standard CO-STAR components]
218
+
219
+ PROCESS:
220
+ Think through this step-by-step:
221
+ 1. Identify key themes
222
+ 2. Organize supporting evidence
223
+ 3. Structure argument flow
224
+ 4. Draft with examples
225
+ ```
226
+
227
+ ### CO-STAR + RISEN
228
+ For content creation with specific methodology:
229
+ ```
230
+ [Use CO-STAR for context/audience/tone]
231
+ [Use RISEN's Steps for the creation process]
232
+ [Use CO-STAR's Response for output format]
233
+ ```
234
+
235
+ ## Quick Reference
236
+
237
+ | Component | Focus | Key Question |
238
+ |-----------|-------|--------------|
239
+ | Context | Background | "What's the situation?" |
240
+ | Objective | Goal | "What do you want achieved?" |
241
+ | Style | Format/Structure | "How should it be written?" |
242
+ | Tone | Emotional Quality | "What feeling should it convey?" |
243
+ | Audience | Reader | "Who is this for?" |
244
+ | Response | Output | "What should the output look like?" |
245
+
246
+ ## Assessment Checklist
247
+
248
+ When applying CO-STAR, verify:
249
+ - [ ] Context provides necessary background without excess
250
+ - [ ] Objective is specific and measurable
251
+ - [ ] Style guidance is clear and actionable
252
+ - [ ] Tone matches audience and objective
253
+ - [ ] Audience is well-defined with characteristics
254
+ - [ ] Response format is detailed and specific
255
+ - [ ] All components work together cohesively
256
+ - [ ] Nothing contradicts other components