get-shit-done-cc 1.2.13 → 1.3.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.
- package/README.md +3 -4
- package/commands/gsd/create-roadmap.md +3 -40
- package/commands/gsd/help.md +21 -25
- package/commands/gsd/map-codebase.md +85 -0
- package/commands/gsd/new-project.md +36 -8
- package/commands/gsd/plan-phase.md +3 -0
- package/get-shit-done/templates/codebase/architecture.md +249 -0
- package/get-shit-done/templates/codebase/concerns.md +299 -0
- package/get-shit-done/templates/codebase/conventions.md +307 -0
- package/get-shit-done/templates/codebase/integrations.md +280 -0
- package/get-shit-done/templates/codebase/stack.md +187 -0
- package/get-shit-done/templates/codebase/structure.md +285 -0
- package/get-shit-done/templates/codebase/testing.md +480 -0
- package/get-shit-done/workflows/create-roadmap.md +0 -105
- package/get-shit-done/workflows/execute-phase.md +47 -0
- package/get-shit-done/workflows/map-codebase.md +397 -0
- package/get-shit-done/workflows/plan-phase.md +48 -0
- package/package.json +1 -1
- package/commands/gsd/research-project.md +0 -195
- package/get-shit-done/references/research-subagent-prompts.md +0 -451
- package/get-shit-done/templates/project-research.md +0 -243
- package/get-shit-done/workflows/research-project.md +0 -223
|
@@ -1,451 +0,0 @@
|
|
|
1
|
-
# Research Subagent Prompts
|
|
2
|
-
|
|
3
|
-
<overview>
|
|
4
|
-
Prompt templates for subagents that research implementation context before roadmap creation.
|
|
5
|
-
|
|
6
|
-
**Critical understanding:** This research is NOT for human decision-making.
|
|
7
|
-
This is CONTEXT INJECTION so Claude Code implements correctly.
|
|
8
|
-
|
|
9
|
-
Each subagent:
|
|
10
|
-
- Receives a research manifest extracted from PROJECT.md
|
|
11
|
-
- Researches ONLY the specific features, constraints, and questions in that manifest
|
|
12
|
-
- Outputs HIGH-CONFIDENCE information only (no padding)
|
|
13
|
-
- Writes directly to `.planning/research/{category}.md`
|
|
14
|
-
- Formats output for Claude Code to consume during implementation
|
|
15
|
-
|
|
16
|
-
**Quality bar:** Will this context make Claude Code generate correct, modern code?
|
|
17
|
-
</overview>
|
|
18
|
-
|
|
19
|
-
<stack_subagent_prompt>
|
|
20
|
-
## Stack Research Subagent
|
|
21
|
-
|
|
22
|
-
Use this template for spawning stack research subagents:
|
|
23
|
-
|
|
24
|
-
```
|
|
25
|
-
<subagent_prompt>
|
|
26
|
-
## Objective
|
|
27
|
-
|
|
28
|
-
Research and document the libraries/tools needed for THIS specific project.
|
|
29
|
-
Write findings to .planning/research/stack.md
|
|
30
|
-
|
|
31
|
-
## Critical Context
|
|
32
|
-
|
|
33
|
-
**This research is for Claude Code, not humans.**
|
|
34
|
-
|
|
35
|
-
You are providing context injection so Claude Code implements correctly. Claude's training data may have outdated library versions, deprecated APIs, or old patterns. Your research overrides stale knowledge with current, accurate information.
|
|
36
|
-
|
|
37
|
-
**Quality bar:** Only include information that will make Claude generate correct, modern code.
|
|
38
|
-
|
|
39
|
-
## Research Manifest
|
|
40
|
-
|
|
41
|
-
{Paste the research manifest extracted from PROJECT.md}
|
|
42
|
-
|
|
43
|
-
## Your Assignment
|
|
44
|
-
|
|
45
|
-
For EACH feature in the manifest:
|
|
46
|
-
1. What library/tool should Claude use?
|
|
47
|
-
2. What's the current version?
|
|
48
|
-
3. What's the correct import/setup?
|
|
49
|
-
|
|
50
|
-
For EACH constraint in the manifest:
|
|
51
|
-
1. Does the recommended library work within this constraint?
|
|
52
|
-
2. Any compatibility issues?
|
|
53
|
-
|
|
54
|
-
## Research Requirements
|
|
55
|
-
|
|
56
|
-
Use WebSearch to verify CURRENT information (2024-2025).
|
|
57
|
-
|
|
58
|
-
**INCLUDE only if:**
|
|
59
|
-
- Actively maintained (commits in last 12 months)
|
|
60
|
-
- High confidence this is the right choice
|
|
61
|
-
- Directly relevant to a feature in the manifest
|
|
62
|
-
|
|
63
|
-
**EXCLUDE:**
|
|
64
|
-
- Low or medium confidence options
|
|
65
|
-
- "Might be useful" alternatives
|
|
66
|
-
- Deprecated or unmaintained libraries
|
|
67
|
-
- Generic options not tied to manifest features
|
|
68
|
-
|
|
69
|
-
## Output Format
|
|
70
|
-
|
|
71
|
-
Write to .planning/research/stack.md:
|
|
72
|
-
|
|
73
|
-
```markdown
|
|
74
|
-
# Stack: [Project Name]
|
|
75
|
-
|
|
76
|
-
**Purpose:** Libraries and tools for Claude Code to use during implementation
|
|
77
|
-
**Researched:** [date]
|
|
78
|
-
|
|
79
|
-
## [Feature 1 from Scope]
|
|
80
|
-
|
|
81
|
-
**Use:** [Library Name] v[X.Y.Z]
|
|
82
|
-
**Why:** [One sentence - why this for this feature]
|
|
83
|
-
|
|
84
|
-
```[language]
|
|
85
|
-
// Setup / import
|
|
86
|
-
[actual code]
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
**Docs:** [URL to current documentation]
|
|
90
|
-
|
|
91
|
-
## [Feature 2 from Scope]
|
|
92
|
-
|
|
93
|
-
**Use:** [Library Name] v[X.Y.Z]
|
|
94
|
-
**Why:** [One sentence]
|
|
95
|
-
|
|
96
|
-
```[language]
|
|
97
|
-
// Setup / import
|
|
98
|
-
[actual code]
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
**Docs:** [URL]
|
|
102
|
-
|
|
103
|
-
## [Continue for each feature...]
|
|
104
|
-
|
|
105
|
-
## Constraint Compatibility
|
|
106
|
-
|
|
107
|
-
| Constraint | Status | Notes |
|
|
108
|
-
|------------|--------|-------|
|
|
109
|
-
| [constraint 1] | ✓ Compatible | [brief note] |
|
|
110
|
-
| [constraint 2] | ✓ Compatible | [brief note] |
|
|
111
|
-
|
|
112
|
-
## Unanswered
|
|
113
|
-
|
|
114
|
-
- [Any features where no clear library choice exists]
|
|
115
|
-
- [Any constraints that couldn't be satisfied]
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
## Quality Checklist
|
|
119
|
-
|
|
120
|
-
Before writing output, verify:
|
|
121
|
-
- [ ] Every feature from manifest has a library recommendation
|
|
122
|
-
- [ ] Every library is actively maintained
|
|
123
|
-
- [ ] Current versions specified (not "latest")
|
|
124
|
-
- [ ] Setup code is current syntax
|
|
125
|
-
- [ ] No low-confidence padding included
|
|
126
|
-
</subagent_prompt>
|
|
127
|
-
```
|
|
128
|
-
</stack_subagent_prompt>
|
|
129
|
-
|
|
130
|
-
<implementation_subagent_prompt>
|
|
131
|
-
## Implementation Research Subagent
|
|
132
|
-
|
|
133
|
-
Use this template for spawning implementation research subagents:
|
|
134
|
-
|
|
135
|
-
```
|
|
136
|
-
<subagent_prompt>
|
|
137
|
-
## Objective
|
|
138
|
-
|
|
139
|
-
Research and document CURRENT implementation patterns for this project's stack.
|
|
140
|
-
Write findings to .planning/research/implementation.md
|
|
141
|
-
|
|
142
|
-
## Critical Context
|
|
143
|
-
|
|
144
|
-
**This research is for Claude Code, not humans.**
|
|
145
|
-
|
|
146
|
-
Claude may generate outdated code patterns. Your job is to provide:
|
|
147
|
-
- Current API syntax (not deprecated alternatives)
|
|
148
|
-
- Working code examples (not pseudocode)
|
|
149
|
-
- "Do this, not that" corrections
|
|
150
|
-
|
|
151
|
-
**Quality bar:** Claude reads this file, then generates correct modern code.
|
|
152
|
-
|
|
153
|
-
## Research Manifest
|
|
154
|
-
|
|
155
|
-
{Paste the research manifest extracted from PROJECT.md}
|
|
156
|
-
|
|
157
|
-
## Your Assignment
|
|
158
|
-
|
|
159
|
-
For the stack chosen in stack.md (or infer from manifest):
|
|
160
|
-
1. What are the CURRENT API patterns?
|
|
161
|
-
2. What code does Claude need to generate correctly?
|
|
162
|
-
3. What deprecated patterns might Claude default to?
|
|
163
|
-
|
|
164
|
-
For Open Questions in the manifest:
|
|
165
|
-
1. Research and provide direct answers
|
|
166
|
-
2. If unanswerable, explain why
|
|
167
|
-
|
|
168
|
-
## Research Requirements
|
|
169
|
-
|
|
170
|
-
Use WebSearch and Context7 for current documentation.
|
|
171
|
-
|
|
172
|
-
**INCLUDE:**
|
|
173
|
-
- Actual code examples with current syntax
|
|
174
|
-
- "Do this (current)" vs "Not this (deprecated)" comparisons
|
|
175
|
-
- Version-specific patterns (as of 2024-2025)
|
|
176
|
-
- Answers to Open Questions from manifest
|
|
177
|
-
|
|
178
|
-
**EXCLUDE:**
|
|
179
|
-
- Theoretical explanations without code
|
|
180
|
-
- Multiple options without recommendation
|
|
181
|
-
- Old patterns from outdated tutorials
|
|
182
|
-
- Generic advice not specific to this project
|
|
183
|
-
|
|
184
|
-
## Output Format
|
|
185
|
-
|
|
186
|
-
Write to .planning/research/implementation.md:
|
|
187
|
-
|
|
188
|
-
```markdown
|
|
189
|
-
# Implementation: [Project Name]
|
|
190
|
-
|
|
191
|
-
**Purpose:** Current API patterns for Claude Code to use
|
|
192
|
-
**Researched:** [date]
|
|
193
|
-
|
|
194
|
-
## [Feature 1] Implementation
|
|
195
|
-
|
|
196
|
-
### Current Pattern (2025)
|
|
197
|
-
|
|
198
|
-
```[language]
|
|
199
|
-
// Correct way to do [thing]
|
|
200
|
-
[actual working code]
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
### NOT This (Deprecated)
|
|
204
|
-
|
|
205
|
-
```[language]
|
|
206
|
-
// Claude may generate this - it's outdated
|
|
207
|
-
[old pattern to avoid]
|
|
208
|
-
// Why wrong: [brief explanation]
|
|
209
|
-
```
|
|
210
|
-
|
|
211
|
-
### Key API Details
|
|
212
|
-
|
|
213
|
-
- `methodName()` - [what it does, when to use]
|
|
214
|
-
- `otherMethod()` - [what it does, when to use]
|
|
215
|
-
|
|
216
|
-
## [Feature 2] Implementation
|
|
217
|
-
|
|
218
|
-
[Same structure]
|
|
219
|
-
|
|
220
|
-
## Open Questions Answered
|
|
221
|
-
|
|
222
|
-
### [Question 1 from manifest]
|
|
223
|
-
|
|
224
|
-
**Answer:** [Direct answer with source]
|
|
225
|
-
|
|
226
|
-
### [Question 2 from manifest]
|
|
227
|
-
|
|
228
|
-
**Answer:** [Direct answer with source]
|
|
229
|
-
|
|
230
|
-
## Decisions Validated
|
|
231
|
-
|
|
232
|
-
### [Decision 1 from manifest]
|
|
233
|
-
|
|
234
|
-
**Validation:** ✓ Good choice / ⚠️ Gotcha
|
|
235
|
-
**Notes:** [Any implementation considerations]
|
|
236
|
-
|
|
237
|
-
## Patterns Summary
|
|
238
|
-
|
|
239
|
-
| Task | Current Pattern | Deprecated Pattern |
|
|
240
|
-
|------|-----------------|-------------------|
|
|
241
|
-
| [task 1] | `doThisWay()` | `oldWay()` |
|
|
242
|
-
| [task 2] | `async/await` | `callbacks` |
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
## Quality Checklist
|
|
246
|
-
|
|
247
|
-
Before writing output, verify:
|
|
248
|
-
- [ ] Every code example is runnable (not pseudocode)
|
|
249
|
-
- [ ] Deprecated patterns explicitly flagged
|
|
250
|
-
- [ ] Open Questions from manifest answered
|
|
251
|
-
- [ ] Decisions from manifest validated
|
|
252
|
-
- [ ] No "it depends" - give clear recommendations
|
|
253
|
-
</subagent_prompt>
|
|
254
|
-
```
|
|
255
|
-
</implementation_subagent_prompt>
|
|
256
|
-
|
|
257
|
-
<risks_subagent_prompt>
|
|
258
|
-
## Risks Research Subagent
|
|
259
|
-
|
|
260
|
-
Use this template for spawning risks research subagents:
|
|
261
|
-
|
|
262
|
-
```
|
|
263
|
-
<subagent_prompt>
|
|
264
|
-
## Objective
|
|
265
|
-
|
|
266
|
-
Research what Claude Code might get WRONG when implementing this project.
|
|
267
|
-
Write findings to .planning/research/risks.md
|
|
268
|
-
|
|
269
|
-
## Critical Context
|
|
270
|
-
|
|
271
|
-
**This research is for Claude Code, not humans.**
|
|
272
|
-
|
|
273
|
-
Claude's training data includes outdated tutorials, deprecated APIs, and bad patterns. Your job is to identify:
|
|
274
|
-
- What Claude might generate incorrectly
|
|
275
|
-
- Deprecated patterns to explicitly avoid
|
|
276
|
-
- Common implementation mistakes in this domain
|
|
277
|
-
|
|
278
|
-
**Quality bar:** After reading this, Claude avoids specific mistakes.
|
|
279
|
-
|
|
280
|
-
## Research Manifest
|
|
281
|
-
|
|
282
|
-
{Paste the research manifest extracted from PROJECT.md}
|
|
283
|
-
|
|
284
|
-
## Your Assignment
|
|
285
|
-
|
|
286
|
-
For this project's domain and stack:
|
|
287
|
-
1. What deprecated patterns might Claude default to?
|
|
288
|
-
2. What common mistakes happen in this domain?
|
|
289
|
-
3. What version-specific gotchas exist?
|
|
290
|
-
|
|
291
|
-
For Decisions in the manifest:
|
|
292
|
-
1. Any known issues with these choices?
|
|
293
|
-
2. Pitfalls specific to this combination?
|
|
294
|
-
|
|
295
|
-
## Research Requirements
|
|
296
|
-
|
|
297
|
-
Use WebSearch to find:
|
|
298
|
-
- GitHub issues about common mistakes
|
|
299
|
-
- Stack Overflow questions about gotchas
|
|
300
|
-
- Migration guides showing old → new patterns
|
|
301
|
-
- "Things I wish I knew" posts
|
|
302
|
-
|
|
303
|
-
**INCLUDE:**
|
|
304
|
-
- Specific mistakes with code examples
|
|
305
|
-
- Version-specific deprecations
|
|
306
|
-
- Domain-specific pitfalls for this project
|
|
307
|
-
|
|
308
|
-
**EXCLUDE:**
|
|
309
|
-
- Generic coding advice
|
|
310
|
-
- Low-probability edge cases
|
|
311
|
-
- "Best practices" (that's not risks)
|
|
312
|
-
- Risks that don't apply to this specific project
|
|
313
|
-
|
|
314
|
-
## Output Format
|
|
315
|
-
|
|
316
|
-
Write to .planning/research/risks.md:
|
|
317
|
-
|
|
318
|
-
```markdown
|
|
319
|
-
# Risks: [Project Name]
|
|
320
|
-
|
|
321
|
-
**Purpose:** What Claude Code might get wrong
|
|
322
|
-
**Researched:** [date]
|
|
323
|
-
|
|
324
|
-
## Deprecated Patterns to Avoid
|
|
325
|
-
|
|
326
|
-
### [Deprecated Thing 1]
|
|
327
|
-
|
|
328
|
-
**Claude might generate:**
|
|
329
|
-
```[language]
|
|
330
|
-
// This is outdated
|
|
331
|
-
[deprecated code pattern]
|
|
332
|
-
```
|
|
333
|
-
|
|
334
|
-
**Instead use:**
|
|
335
|
-
```[language]
|
|
336
|
-
// Current approach
|
|
337
|
-
[correct code pattern]
|
|
338
|
-
```
|
|
339
|
-
|
|
340
|
-
**Why:** [Deprecated in vX.Y, removed in vX.Z, etc.]
|
|
341
|
-
|
|
342
|
-
### [Deprecated Thing 2]
|
|
343
|
-
|
|
344
|
-
[Same structure]
|
|
345
|
-
|
|
346
|
-
## Common Mistakes
|
|
347
|
-
|
|
348
|
-
### [Mistake 1: Descriptive Name]
|
|
349
|
-
|
|
350
|
-
**What happens:** [The incorrect approach]
|
|
351
|
-
**Why it's wrong:** [Consequence]
|
|
352
|
-
**Correct approach:** [What to do instead]
|
|
353
|
-
|
|
354
|
-
```[language]
|
|
355
|
-
// Wrong
|
|
356
|
-
[bad code]
|
|
357
|
-
|
|
358
|
-
// Right
|
|
359
|
-
[good code]
|
|
360
|
-
```
|
|
361
|
-
|
|
362
|
-
### [Mistake 2]
|
|
363
|
-
|
|
364
|
-
[Same structure]
|
|
365
|
-
|
|
366
|
-
## Stack-Specific Gotchas
|
|
367
|
-
|
|
368
|
-
### [Gotcha for chosen library/framework]
|
|
369
|
-
|
|
370
|
-
**Issue:** [What goes wrong]
|
|
371
|
-
**When:** [Trigger conditions]
|
|
372
|
-
**Fix:** [How to avoid/handle]
|
|
373
|
-
|
|
374
|
-
## Decision Risks
|
|
375
|
-
|
|
376
|
-
### [Decision 1 from manifest]
|
|
377
|
-
|
|
378
|
-
**Risk level:** Low / Medium / High
|
|
379
|
-
**Specific concern:** [What could go wrong with this choice]
|
|
380
|
-
**Mitigation:** [How to avoid the problem]
|
|
381
|
-
|
|
382
|
-
## Critical Warnings
|
|
383
|
-
|
|
384
|
-
1. **[Most important thing to not mess up]**
|
|
385
|
-
2. **[Second most important]**
|
|
386
|
-
3. **[Third most important]**
|
|
387
|
-
```
|
|
388
|
-
|
|
389
|
-
## Quality Checklist
|
|
390
|
-
|
|
391
|
-
Before writing output, verify:
|
|
392
|
-
- [ ] Every risk is specific (not generic advice)
|
|
393
|
-
- [ ] Code examples show wrong vs right
|
|
394
|
-
- [ ] Risks are relevant to this project's stack
|
|
395
|
-
- [ ] No padding with unlikely scenarios
|
|
396
|
-
- [ ] Critical warnings prioritized
|
|
397
|
-
</subagent_prompt>
|
|
398
|
-
```
|
|
399
|
-
</risks_subagent_prompt>
|
|
400
|
-
|
|
401
|
-
<task_tool_usage>
|
|
402
|
-
## Using the Task Tool
|
|
403
|
-
|
|
404
|
-
Spawn all 3 subagents in a SINGLE message:
|
|
405
|
-
|
|
406
|
-
```
|
|
407
|
-
Task 1:
|
|
408
|
-
subagent_type: "general-purpose"
|
|
409
|
-
description: "Research stack for [project]"
|
|
410
|
-
prompt: [stack_subagent_prompt with manifest]
|
|
411
|
-
|
|
412
|
-
Task 2:
|
|
413
|
-
subagent_type: "general-purpose"
|
|
414
|
-
description: "Research implementation for [project]"
|
|
415
|
-
prompt: [implementation_subagent_prompt with manifest]
|
|
416
|
-
|
|
417
|
-
Task 3:
|
|
418
|
-
subagent_type: "general-purpose"
|
|
419
|
-
description: "Research risks for [project]"
|
|
420
|
-
prompt: [risks_subagent_prompt with manifest]
|
|
421
|
-
```
|
|
422
|
-
|
|
423
|
-
Wait for all to complete, then verify outputs.
|
|
424
|
-
</task_tool_usage>
|
|
425
|
-
|
|
426
|
-
<quality_verification>
|
|
427
|
-
## Post-Research Quality Check
|
|
428
|
-
|
|
429
|
-
After subagents complete, verify each file:
|
|
430
|
-
|
|
431
|
-
**stack.md:**
|
|
432
|
-
- [ ] Every manifest feature has a library
|
|
433
|
-
- [ ] Current versions specified
|
|
434
|
-
- [ ] Setup code included
|
|
435
|
-
- [ ] No low-confidence alternatives
|
|
436
|
-
|
|
437
|
-
**implementation.md:**
|
|
438
|
-
- [ ] Code examples are runnable
|
|
439
|
-
- [ ] Deprecated patterns flagged
|
|
440
|
-
- [ ] Open Questions answered
|
|
441
|
-
- [ ] Decisions validated
|
|
442
|
-
|
|
443
|
-
**risks.md:**
|
|
444
|
-
- [ ] Risks specific to this project
|
|
445
|
-
- [ ] Wrong vs right code shown
|
|
446
|
-
- [ ] No generic advice padding
|
|
447
|
-
- [ ] Critical warnings clear
|
|
448
|
-
|
|
449
|
-
**If a file fails quality check:**
|
|
450
|
-
Re-run that specific subagent with stricter instructions, or flag the gap for the user.
|
|
451
|
-
</quality_verification>
|
|
@@ -1,243 +0,0 @@
|
|
|
1
|
-
# Project Research Template
|
|
2
|
-
|
|
3
|
-
Template for `.planning/research/{category}.md` - implementation context for Claude Code.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
<philosophy>
|
|
8
|
-
## What This Research Is
|
|
9
|
-
|
|
10
|
-
**Context injection for Claude Code implementation quality.**
|
|
11
|
-
|
|
12
|
-
This is NOT research for humans to make decisions.
|
|
13
|
-
This is context that Claude Code reads during implementation to generate correct, modern code.
|
|
14
|
-
|
|
15
|
-
**Quality bar:** Will this make Claude generate better code?
|
|
16
|
-
|
|
17
|
-
**Include:** High-confidence, directly actionable, current patterns with code examples
|
|
18
|
-
**Exclude:** Low-confidence, generic advice, "might be useful" padding, outdated patterns
|
|
19
|
-
</philosophy>
|
|
20
|
-
|
|
21
|
-
---
|
|
22
|
-
|
|
23
|
-
## stack.md Template
|
|
24
|
-
|
|
25
|
-
```markdown
|
|
26
|
-
# Stack: [Project Name]
|
|
27
|
-
|
|
28
|
-
**Purpose:** Libraries and tools for Claude Code to use during implementation
|
|
29
|
-
**Researched:** [date]
|
|
30
|
-
|
|
31
|
-
## [Feature 1 from PROJECT.md Scope]
|
|
32
|
-
|
|
33
|
-
**Use:** [Library Name] v[X.Y.Z]
|
|
34
|
-
**Why:** [One sentence - why this library for this feature]
|
|
35
|
-
|
|
36
|
-
```[language]
|
|
37
|
-
// Setup / import
|
|
38
|
-
import { Thing } from 'library'
|
|
39
|
-
|
|
40
|
-
// Basic usage
|
|
41
|
-
const result = Thing.doThing()
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
**Docs:** [URL to current documentation]
|
|
45
|
-
|
|
46
|
-
## [Feature 2 from PROJECT.md Scope]
|
|
47
|
-
|
|
48
|
-
**Use:** [Library Name] v[X.Y.Z]
|
|
49
|
-
**Why:** [One sentence]
|
|
50
|
-
|
|
51
|
-
```[language]
|
|
52
|
-
// Setup / import
|
|
53
|
-
[actual code]
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
**Docs:** [URL]
|
|
57
|
-
|
|
58
|
-
## [Continue for each feature in Scope...]
|
|
59
|
-
|
|
60
|
-
## Constraint Compatibility
|
|
61
|
-
|
|
62
|
-
| Constraint | Status | Notes |
|
|
63
|
-
|------------|--------|-------|
|
|
64
|
-
| [constraint from PROJECT.md] | ✓ Compatible | [brief note] |
|
|
65
|
-
| [constraint from PROJECT.md] | ✓ Compatible | [brief note] |
|
|
66
|
-
|
|
67
|
-
## Unanswered
|
|
68
|
-
|
|
69
|
-
- [Any features where no clear library choice exists - be honest]
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
---
|
|
73
|
-
|
|
74
|
-
## implementation.md Template
|
|
75
|
-
|
|
76
|
-
```markdown
|
|
77
|
-
# Implementation: [Project Name]
|
|
78
|
-
|
|
79
|
-
**Purpose:** Current API patterns for Claude Code to use
|
|
80
|
-
**Researched:** [date]
|
|
81
|
-
|
|
82
|
-
## [Feature 1] Implementation
|
|
83
|
-
|
|
84
|
-
### Current Pattern (2025)
|
|
85
|
-
|
|
86
|
-
```[language]
|
|
87
|
-
// Correct way to implement [feature]
|
|
88
|
-
[actual working code - not pseudocode]
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
### NOT This (Deprecated)
|
|
92
|
-
|
|
93
|
-
```[language]
|
|
94
|
-
// Claude may generate this - it's outdated
|
|
95
|
-
[old pattern]
|
|
96
|
-
// Why wrong: [deprecated in vX, removed in vY, causes Z problem]
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
### Key APIs
|
|
100
|
-
|
|
101
|
-
- `methodName(params)` - [what it does, when to use]
|
|
102
|
-
- `otherMethod(params)` - [what it does, when to use]
|
|
103
|
-
|
|
104
|
-
## [Feature 2] Implementation
|
|
105
|
-
|
|
106
|
-
[Same structure]
|
|
107
|
-
|
|
108
|
-
## Open Questions Answered
|
|
109
|
-
|
|
110
|
-
### [Question from PROJECT.md Open Questions]
|
|
111
|
-
|
|
112
|
-
**Answer:** [Direct answer]
|
|
113
|
-
**Source:** [URL or documentation reference]
|
|
114
|
-
|
|
115
|
-
### [Question 2]
|
|
116
|
-
|
|
117
|
-
**Answer:** [Direct answer or "Could not determine - [reason]"]
|
|
118
|
-
|
|
119
|
-
## Decisions Validated
|
|
120
|
-
|
|
121
|
-
### [Decision from PROJECT.md Decisions Made]
|
|
122
|
-
|
|
123
|
-
**Validation:** ✓ Good choice / ⚠️ Has gotchas
|
|
124
|
-
**Notes:** [Implementation considerations Claude should know]
|
|
125
|
-
|
|
126
|
-
## Quick Reference
|
|
127
|
-
|
|
128
|
-
| Task | Current Pattern | Deprecated Pattern |
|
|
129
|
-
|------|-----------------|-------------------|
|
|
130
|
-
| [common task 1] | `newWay()` | `oldWay()` |
|
|
131
|
-
| [common task 2] | `async/await` | `.then()` chains |
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
## risks.md Template
|
|
137
|
-
|
|
138
|
-
```markdown
|
|
139
|
-
# Risks: [Project Name]
|
|
140
|
-
|
|
141
|
-
**Purpose:** What Claude Code might get wrong
|
|
142
|
-
**Researched:** [date]
|
|
143
|
-
|
|
144
|
-
## Deprecated Patterns to Avoid
|
|
145
|
-
|
|
146
|
-
### [Deprecated Thing 1]
|
|
147
|
-
|
|
148
|
-
**Claude might generate:**
|
|
149
|
-
```[language]
|
|
150
|
-
// This is outdated - from old tutorials/training data
|
|
151
|
-
[deprecated code pattern]
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
**Instead use:**
|
|
155
|
-
```[language]
|
|
156
|
-
// Current approach (2025)
|
|
157
|
-
[correct code pattern]
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
**Why:** Deprecated in v[X], removed in v[Y]. [Brief explanation]
|
|
161
|
-
|
|
162
|
-
### [Deprecated Thing 2]
|
|
163
|
-
|
|
164
|
-
[Same structure]
|
|
165
|
-
|
|
166
|
-
## Common Mistakes
|
|
167
|
-
|
|
168
|
-
### [Mistake 1: Descriptive Name]
|
|
169
|
-
|
|
170
|
-
**What happens:** [The incorrect approach Claude might take]
|
|
171
|
-
**Why it's wrong:** [Specific consequence - performance, bugs, etc.]
|
|
172
|
-
**Correct approach:**
|
|
173
|
-
|
|
174
|
-
```[language]
|
|
175
|
-
// Wrong
|
|
176
|
-
[bad code]
|
|
177
|
-
|
|
178
|
-
// Right
|
|
179
|
-
[good code]
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
## Stack-Specific Gotchas
|
|
183
|
-
|
|
184
|
-
### [Gotcha for this project's chosen stack]
|
|
185
|
-
|
|
186
|
-
**Issue:** [What goes wrong]
|
|
187
|
-
**When:** [Trigger conditions]
|
|
188
|
-
**Fix:** [How to avoid or handle]
|
|
189
|
-
|
|
190
|
-
## Decision Risks
|
|
191
|
-
|
|
192
|
-
### [Decision from PROJECT.md]
|
|
193
|
-
|
|
194
|
-
**Risk level:** Low / Medium / High
|
|
195
|
-
**Concern:** [What could go wrong with this choice]
|
|
196
|
-
**Mitigation:** [How to avoid the problem]
|
|
197
|
-
|
|
198
|
-
## Critical Warnings
|
|
199
|
-
|
|
200
|
-
1. **[Most important thing Claude must not mess up]**
|
|
201
|
-
2. **[Second most important]**
|
|
202
|
-
3. **[Third most important]**
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
---
|
|
206
|
-
|
|
207
|
-
<quality_rules>
|
|
208
|
-
## Quality Rules
|
|
209
|
-
|
|
210
|
-
### INCLUDE:
|
|
211
|
-
|
|
212
|
-
- High-confidence information only
|
|
213
|
-
- Actual code examples (runnable, not pseudocode)
|
|
214
|
-
- Current syntax (2024-2025)
|
|
215
|
-
- Direct answers to PROJECT.md questions
|
|
216
|
-
- Specific recommendations tied to manifest features
|
|
217
|
-
|
|
218
|
-
### EXCLUDE:
|
|
219
|
-
|
|
220
|
-
- Low or medium confidence items
|
|
221
|
-
- "Might be useful" padding
|
|
222
|
-
- Generic advice not specific to this project
|
|
223
|
-
- Options without clear recommendation
|
|
224
|
-
- Old repos/articles acknowledged as outdated
|
|
225
|
-
- Anything that doesn't directly improve Claude's implementation
|
|
226
|
-
|
|
227
|
-
### Format for Claude Consumption:
|
|
228
|
-
|
|
229
|
-
Every recommendation should include:
|
|
230
|
-
1. What to use (specific, versioned)
|
|
231
|
-
2. Why (one sentence)
|
|
232
|
-
3. How (actual code)
|
|
233
|
-
4. What NOT to do (if relevant)
|
|
234
|
-
|
|
235
|
-
### No Padding Rule:
|
|
236
|
-
|
|
237
|
-
If you can't find high-confidence information for something, say so:
|
|
238
|
-
- "Could not determine - no authoritative source found"
|
|
239
|
-
- "Unanswered - requires experimentation"
|
|
240
|
-
|
|
241
|
-
This is better than padding with low-quality guesses.
|
|
242
|
-
</quality_rules>
|
|
243
|
-
|