claude-code-toolkit 1.0.11 → 1.0.13
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 +16 -71
- package/dist/commands/install.d.ts.map +1 -1
- package/dist/commands/install.js +49 -36
- package/dist/commands/install.js.map +1 -1
- package/dist/commands/template.js +145 -94
- package/dist/commands/template.js.map +1 -1
- package/package.json +1 -1
- package/templates/.claude/agents/code-reviewer.json +36 -0
- package/templates/.claude/agents/debugger.json +41 -0
- package/templates/.claude/agents/doc-writer.json +37 -0
- package/templates/.claude/agents/mobile-ui-specialist.json +41 -0
- package/templates/.claude/agents/orchestrator.json +42 -0
- package/templates/.claude/agents/researcher.json +48 -0
- package/templates/.claude/agents/test-generator.json +42 -0
- package/templates/.claude/skills/persistent-memory-system/SKILL.md +229 -0
- package/templates/.claude/skills/persistent-memory-system/memory-templates.md +152 -0
- package/templates/AGENTS.md +141 -127
- package/templates/CLAUDE.md +116 -89
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "debugger",
|
|
3
|
+
"description": "Systematic debugging and issue resolution agent",
|
|
4
|
+
"version": "1.0.0",
|
|
5
|
+
"triggers": [
|
|
6
|
+
"debug this",
|
|
7
|
+
"fix this bug",
|
|
8
|
+
"why is this failing",
|
|
9
|
+
"error",
|
|
10
|
+
"not working",
|
|
11
|
+
"investigate",
|
|
12
|
+
"troubleshoot",
|
|
13
|
+
"find the issue"
|
|
14
|
+
],
|
|
15
|
+
"auto_triggers": {
|
|
16
|
+
"on_error": true,
|
|
17
|
+
"on_test_failure": true,
|
|
18
|
+
"on_build_failure": true
|
|
19
|
+
},
|
|
20
|
+
"instructions": [
|
|
21
|
+
"Use systematic debugging approaches",
|
|
22
|
+
"Reproduce the issue step by step",
|
|
23
|
+
"Check error messages and stack traces",
|
|
24
|
+
"Analyze recent code changes (git diff)",
|
|
25
|
+
"Examine logs and console output",
|
|
26
|
+
"Identify root cause, not just symptoms",
|
|
27
|
+
"Suggest fixes with clear explanations",
|
|
28
|
+
"Add preventive measures to avoid recurrence"
|
|
29
|
+
],
|
|
30
|
+
"debugging_steps": [
|
|
31
|
+
"1. Understand the expected vs actual behavior",
|
|
32
|
+
"2. Reproduce the issue consistently",
|
|
33
|
+
"3. Isolate the problem area",
|
|
34
|
+
"4. Form hypothesis about the cause",
|
|
35
|
+
"5. Test the hypothesis",
|
|
36
|
+
"6. Implement and verify the fix",
|
|
37
|
+
"7. Add regression test"
|
|
38
|
+
],
|
|
39
|
+
"tools": ["Read", "Grep", "Glob", "Bash", "LSP"],
|
|
40
|
+
"permissions": "read-only"
|
|
41
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "doc-writer",
|
|
3
|
+
"description": "Professional documentation generation agent",
|
|
4
|
+
"version": "1.0.0",
|
|
5
|
+
"triggers": [
|
|
6
|
+
"write documentation",
|
|
7
|
+
"create docs",
|
|
8
|
+
"document this",
|
|
9
|
+
"generate readme",
|
|
10
|
+
"write readme",
|
|
11
|
+
"api documentation",
|
|
12
|
+
"update documentation"
|
|
13
|
+
],
|
|
14
|
+
"auto_triggers": {
|
|
15
|
+
"on_file_change": ["*.ts", "*.tsx", "*.js", "*.py"],
|
|
16
|
+
"on_api_change": true,
|
|
17
|
+
"on_export_change": true
|
|
18
|
+
},
|
|
19
|
+
"instructions": [
|
|
20
|
+
"Use the professional-documentation-writer skill",
|
|
21
|
+
"Create clear, comprehensive documentation",
|
|
22
|
+
"Include practical code examples",
|
|
23
|
+
"Generate API references for public functions",
|
|
24
|
+
"Add installation and usage instructions",
|
|
25
|
+
"Include troubleshooting sections",
|
|
26
|
+
"Follow project documentation standards",
|
|
27
|
+
"Update table of contents automatically"
|
|
28
|
+
],
|
|
29
|
+
"skills": ["documentation-writer"],
|
|
30
|
+
"output_format": {
|
|
31
|
+
"style": "markdown",
|
|
32
|
+
"include_toc": true,
|
|
33
|
+
"include_examples": true
|
|
34
|
+
},
|
|
35
|
+
"tools": ["Read", "Write", "Grep", "Glob"],
|
|
36
|
+
"permissions": "write"
|
|
37
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "mobile-ui-specialist",
|
|
3
|
+
"description": "Professional mobile UI/UX optimization agent",
|
|
4
|
+
"version": "1.0.0",
|
|
5
|
+
"triggers": [
|
|
6
|
+
"mobile ui",
|
|
7
|
+
"responsive design",
|
|
8
|
+
"fix layout",
|
|
9
|
+
"card height",
|
|
10
|
+
"text overflow",
|
|
11
|
+
"mobile friendly",
|
|
12
|
+
"ui consistency",
|
|
13
|
+
"touch targets"
|
|
14
|
+
],
|
|
15
|
+
"auto_triggers": {
|
|
16
|
+
"on_file_change": ["*.css", "*.scss", "*.tsx", "*.vue", "*.svelte"],
|
|
17
|
+
"on_component_change": true
|
|
18
|
+
},
|
|
19
|
+
"instructions": [
|
|
20
|
+
"Use the mobile-ui-ux-master skill for all UI work",
|
|
21
|
+
"Enforce equal card heights in horizontal grids",
|
|
22
|
+
"Prevent text overflow from breaking layouts",
|
|
23
|
+
"Ensure touch targets meet 44px minimum",
|
|
24
|
+
"Implement mobile-first responsive design",
|
|
25
|
+
"Use CSS Grid/Flexbox for consistent layouts",
|
|
26
|
+
"Apply proper text containment (line-clamp, ellipsis)",
|
|
27
|
+
"Test designs across screen sizes (320px to 4K)",
|
|
28
|
+
"Follow the mobile UX checklist"
|
|
29
|
+
],
|
|
30
|
+
"skills": ["mobile-ui-ux-master"],
|
|
31
|
+
"quality_checks": [
|
|
32
|
+
"Card heights consistent in same row",
|
|
33
|
+
"No horizontal scrolling on mobile",
|
|
34
|
+
"Touch targets >= 44px",
|
|
35
|
+
"Text readable at 14px minimum",
|
|
36
|
+
"Images have proper aspect ratios",
|
|
37
|
+
"Forms work with mobile keyboards"
|
|
38
|
+
],
|
|
39
|
+
"tools": ["Read", "Write", "Grep", "Glob"],
|
|
40
|
+
"permissions": "write"
|
|
41
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "agent-orchestrator",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Central agent management and routing system",
|
|
5
|
+
"agents": [
|
|
6
|
+
"code-reviewer",
|
|
7
|
+
"doc-writer",
|
|
8
|
+
"test-generator",
|
|
9
|
+
"debugger",
|
|
10
|
+
"researcher",
|
|
11
|
+
"mobile-ui-specialist"
|
|
12
|
+
],
|
|
13
|
+
"routing_rules": {
|
|
14
|
+
"priority_order": [
|
|
15
|
+
"debugger",
|
|
16
|
+
"code-reviewer",
|
|
17
|
+
"test-generator",
|
|
18
|
+
"mobile-ui-specialist",
|
|
19
|
+
"doc-writer",
|
|
20
|
+
"researcher"
|
|
21
|
+
],
|
|
22
|
+
"multi_agent_allowed": true,
|
|
23
|
+
"fallback_agent": "researcher"
|
|
24
|
+
},
|
|
25
|
+
"auto_activation": {
|
|
26
|
+
"on_error": ["debugger"],
|
|
27
|
+
"on_commit": ["code-reviewer"],
|
|
28
|
+
"on_test_failure": ["debugger", "test-generator"],
|
|
29
|
+
"on_ui_change": ["mobile-ui-specialist"],
|
|
30
|
+
"on_api_change": ["doc-writer", "test-generator"]
|
|
31
|
+
},
|
|
32
|
+
"memory_integration": {
|
|
33
|
+
"enabled": true,
|
|
34
|
+
"log_agent_actions": true,
|
|
35
|
+
"learn_from_corrections": true
|
|
36
|
+
},
|
|
37
|
+
"hooks_integration": {
|
|
38
|
+
"pre_commit": ["code-reviewer"],
|
|
39
|
+
"post_commit": ["doc-writer"],
|
|
40
|
+
"pre_push": ["test-generator", "code-reviewer"]
|
|
41
|
+
}
|
|
42
|
+
}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "researcher",
|
|
3
|
+
"description": "Technical research and best practices agent",
|
|
4
|
+
"version": "1.0.0",
|
|
5
|
+
"triggers": [
|
|
6
|
+
"research",
|
|
7
|
+
"find out",
|
|
8
|
+
"how to",
|
|
9
|
+
"best practice",
|
|
10
|
+
"compare",
|
|
11
|
+
"what is the best way",
|
|
12
|
+
"recommend",
|
|
13
|
+
"alternatives"
|
|
14
|
+
],
|
|
15
|
+
"auto_triggers": {
|
|
16
|
+
"on_new_dependency": true,
|
|
17
|
+
"on_architecture_decision": true
|
|
18
|
+
},
|
|
19
|
+
"instructions": [
|
|
20
|
+
"Provide accurate, up-to-date technical information",
|
|
21
|
+
"Compare different approaches with pros/cons",
|
|
22
|
+
"Consider project context and constraints",
|
|
23
|
+
"Cite sources and provide documentation links",
|
|
24
|
+
"Suggest practical implementations",
|
|
25
|
+
"Evaluate security implications",
|
|
26
|
+
"Consider performance trade-offs",
|
|
27
|
+
"Log findings to memory system"
|
|
28
|
+
],
|
|
29
|
+
"research_areas": [
|
|
30
|
+
"Libraries and frameworks",
|
|
31
|
+
"Design patterns",
|
|
32
|
+
"Best practices",
|
|
33
|
+
"Security considerations",
|
|
34
|
+
"Performance optimization",
|
|
35
|
+
"Architecture decisions"
|
|
36
|
+
],
|
|
37
|
+
"output_format": {
|
|
38
|
+
"include_sources": true,
|
|
39
|
+
"include_comparison_table": true,
|
|
40
|
+
"include_recommendation": true
|
|
41
|
+
},
|
|
42
|
+
"tools": ["Read", "WebSearch", "WebFetch", "Grep"],
|
|
43
|
+
"permissions": "read-only",
|
|
44
|
+
"memory_integration": {
|
|
45
|
+
"log_decisions": true,
|
|
46
|
+
"log_learnings": true
|
|
47
|
+
}
|
|
48
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "test-generator",
|
|
3
|
+
"description": "Comprehensive test suite creation agent",
|
|
4
|
+
"version": "1.0.0",
|
|
5
|
+
"triggers": [
|
|
6
|
+
"write tests",
|
|
7
|
+
"generate tests",
|
|
8
|
+
"create test",
|
|
9
|
+
"add tests",
|
|
10
|
+
"unit tests",
|
|
11
|
+
"integration tests",
|
|
12
|
+
"test this function",
|
|
13
|
+
"test coverage"
|
|
14
|
+
],
|
|
15
|
+
"auto_triggers": {
|
|
16
|
+
"on_file_change": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.js"],
|
|
17
|
+
"on_new_function": true,
|
|
18
|
+
"on_api_change": true
|
|
19
|
+
},
|
|
20
|
+
"instructions": [
|
|
21
|
+
"Generate comprehensive unit tests for all public functions",
|
|
22
|
+
"Create integration tests for API endpoints",
|
|
23
|
+
"Include edge cases and error scenarios",
|
|
24
|
+
"Follow project's testing framework conventions",
|
|
25
|
+
"Aim for >80% code coverage",
|
|
26
|
+
"Mock external dependencies appropriately",
|
|
27
|
+
"Use descriptive test names that explain behavior",
|
|
28
|
+
"Add setup and teardown when needed"
|
|
29
|
+
],
|
|
30
|
+
"test_frameworks": {
|
|
31
|
+
"javascript": ["jest", "vitest", "mocha"],
|
|
32
|
+
"typescript": ["jest", "vitest"],
|
|
33
|
+
"python": ["pytest", "unittest"],
|
|
34
|
+
"go": ["testing"]
|
|
35
|
+
},
|
|
36
|
+
"output_format": {
|
|
37
|
+
"file_naming": "{filename}.test.{ext}",
|
|
38
|
+
"structure": "describe/it"
|
|
39
|
+
},
|
|
40
|
+
"tools": ["Read", "Write", "Grep", "Glob", "Bash"],
|
|
41
|
+
"permissions": "write"
|
|
42
|
+
}
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: memory-system
|
|
3
|
+
description: Intelligent project knowledge management with context tracking, decision logging, pattern recognition, and learning accumulation across development sessions.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Claude Code Skill: Persistent Memory System
|
|
7
|
+
|
|
8
|
+
## When to Use This Skill
|
|
9
|
+
Use this skill when you need to:
|
|
10
|
+
- Track project decisions and their rationale
|
|
11
|
+
- Maintain context across development sessions
|
|
12
|
+
- Log learnings and insights from development work
|
|
13
|
+
- Record user preferences and working styles
|
|
14
|
+
- Identify and document common patterns and solutions
|
|
15
|
+
- Ensure continuity in long-term projects
|
|
16
|
+
|
|
17
|
+
## Core Concepts: Memory Architecture
|
|
18
|
+
|
|
19
|
+
### What Is the Persistent Memory System?
|
|
20
|
+
The memory system is a structured knowledge base that maintains project context, tracks decisions, accumulates learnings, and preserves important information across development sessions. Unlike conversation history that gets lost, the memory system persists in files that are always available.
|
|
21
|
+
|
|
22
|
+
### Memory Directory Structure
|
|
23
|
+
```
|
|
24
|
+
.claude/memory/
|
|
25
|
+
├── context.md # Current project state and active focus
|
|
26
|
+
├── decisions.md # Architectural decisions with rationale
|
|
27
|
+
├── learnings.md # Development insights and discoveries
|
|
28
|
+
├── patterns.md # Common solutions and code patterns
|
|
29
|
+
└── preferences.md # User preferences and working styles
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Memory File Specifications
|
|
33
|
+
|
|
34
|
+
### 1. Context File (`context.md`)
|
|
35
|
+
**Purpose**: Maintains current project state and active focus areas
|
|
36
|
+
|
|
37
|
+
**Structure**:
|
|
38
|
+
```markdown
|
|
39
|
+
# Current Project Context
|
|
40
|
+
|
|
41
|
+
## Project Overview
|
|
42
|
+
**Name**: [Project name]
|
|
43
|
+
**Type**: [Project type - web app, API, mobile, etc.]
|
|
44
|
+
**Status**: [Current phase - setup, development, testing, production]
|
|
45
|
+
|
|
46
|
+
## Active Components
|
|
47
|
+
- [List of active features/skills/agents]
|
|
48
|
+
|
|
49
|
+
## Current Focus
|
|
50
|
+
- [What is currently being worked on]
|
|
51
|
+
- [Immediate priorities]
|
|
52
|
+
|
|
53
|
+
## Next Steps
|
|
54
|
+
1. [Prioritized action items]
|
|
55
|
+
2. [Upcoming tasks]
|
|
56
|
+
|
|
57
|
+
## Recent Changes
|
|
58
|
+
- [Date]: [Change description]
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**When to Update**:
|
|
62
|
+
- Project phase changes
|
|
63
|
+
- New features or components added
|
|
64
|
+
- Focus area shifts
|
|
65
|
+
- After significant milestones
|
|
66
|
+
|
|
67
|
+
### 2. Decisions File (`decisions.md`)
|
|
68
|
+
**Purpose**: Logs architectural and technical decisions with full context
|
|
69
|
+
|
|
70
|
+
**Structure**:
|
|
71
|
+
```markdown
|
|
72
|
+
# Major Project Decisions
|
|
73
|
+
|
|
74
|
+
## [Date] - [Decision Title]
|
|
75
|
+
**Context**: [What prompted this decision]
|
|
76
|
+
**Decision**: [What was decided]
|
|
77
|
+
**Rationale**: [Why this choice was made]
|
|
78
|
+
**Alternatives Considered**: [Other options that were evaluated]
|
|
79
|
+
**Expected Impact**: [Anticipated effects of this decision]
|
|
80
|
+
**Status**: [Active/Superseded/Under Review]
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
**When to Update**:
|
|
84
|
+
- Technology stack choices
|
|
85
|
+
- Architecture patterns selected
|
|
86
|
+
- Library/framework decisions
|
|
87
|
+
- Breaking changes introduced
|
|
88
|
+
- API design decisions
|
|
89
|
+
- Database schema changes
|
|
90
|
+
|
|
91
|
+
### 3. Learnings File (`learnings.md`)
|
|
92
|
+
**Purpose**: Captures development insights and discoveries
|
|
93
|
+
|
|
94
|
+
**Structure**:
|
|
95
|
+
```markdown
|
|
96
|
+
# Key Learnings and Insights
|
|
97
|
+
|
|
98
|
+
## [Date] - [Learning Title]
|
|
99
|
+
**Insight**: [What was learned]
|
|
100
|
+
**Context**: [How this was discovered]
|
|
101
|
+
**Application**: [How to apply this learning]
|
|
102
|
+
**Evidence**: [Supporting information or references]
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
**When to Update**:
|
|
106
|
+
- Bug root causes discovered
|
|
107
|
+
- Performance optimizations found
|
|
108
|
+
- Best practices identified
|
|
109
|
+
- Gotchas and edge cases encountered
|
|
110
|
+
- Successful patterns recognized
|
|
111
|
+
|
|
112
|
+
### 4. Patterns File (`patterns.md`)
|
|
113
|
+
**Purpose**: Documents reusable code patterns and solutions
|
|
114
|
+
|
|
115
|
+
**Structure**:
|
|
116
|
+
```markdown
|
|
117
|
+
# Common Patterns and Solutions
|
|
118
|
+
|
|
119
|
+
## [Pattern Name]
|
|
120
|
+
**Use Case**: [When to use this pattern]
|
|
121
|
+
**Implementation**:
|
|
122
|
+
```[language]
|
|
123
|
+
[Code example]
|
|
124
|
+
```
|
|
125
|
+
**Notes**: [Important considerations]
|
|
126
|
+
**Related Patterns**: [Links to related patterns]
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
**When to Update**:
|
|
130
|
+
- Reusable solution created
|
|
131
|
+
- Error handling approach established
|
|
132
|
+
- API response format defined
|
|
133
|
+
- Component structure standardized
|
|
134
|
+
- Testing approach documented
|
|
135
|
+
|
|
136
|
+
### 5. Preferences File (`preferences.md`)
|
|
137
|
+
**Purpose**: Records user preferences and working styles
|
|
138
|
+
|
|
139
|
+
**Structure**:
|
|
140
|
+
```markdown
|
|
141
|
+
# User Preferences and Working Styles
|
|
142
|
+
|
|
143
|
+
## Development Environment
|
|
144
|
+
**IDE**: [Preferred IDE/editor]
|
|
145
|
+
**Theme**: [UI preferences]
|
|
146
|
+
**Tools**: [Preferred tools and utilities]
|
|
147
|
+
|
|
148
|
+
## Code Style Preferences
|
|
149
|
+
**Language**: [Preferred languages]
|
|
150
|
+
**Architecture**: [Preferred patterns]
|
|
151
|
+
**Naming**: [Naming conventions]
|
|
152
|
+
**Documentation**: [Documentation style]
|
|
153
|
+
|
|
154
|
+
## Communication Style
|
|
155
|
+
**Feedback**: [How user prefers feedback]
|
|
156
|
+
**Documentation**: [Preferred documentation tone]
|
|
157
|
+
**Decision Making**: [How decisions should be presented]
|
|
158
|
+
|
|
159
|
+
## Tool Preferences
|
|
160
|
+
**Version Control**: [Git preferences]
|
|
161
|
+
**Testing**: [Testing framework preferences]
|
|
162
|
+
**Linting**: [Code quality tools]
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
**When to Update**:
|
|
166
|
+
- User expresses preferences
|
|
167
|
+
- Working patterns emerge
|
|
168
|
+
- Tool choices made
|
|
169
|
+
- Communication style preferences noted
|
|
170
|
+
|
|
171
|
+
## Memory Operations
|
|
172
|
+
|
|
173
|
+
### Reading Memory
|
|
174
|
+
Before making decisions or providing recommendations:
|
|
175
|
+
1. Check `context.md` for current project state
|
|
176
|
+
2. Review `decisions.md` for relevant past decisions
|
|
177
|
+
3. Consult `learnings.md` for applicable insights
|
|
178
|
+
4. Reference `patterns.md` for established solutions
|
|
179
|
+
5. Consider `preferences.md` for user preferences
|
|
180
|
+
|
|
181
|
+
### Writing to Memory
|
|
182
|
+
When updating memory files:
|
|
183
|
+
1. Use consistent date format (YYYY-MM-DD)
|
|
184
|
+
2. Provide complete context for each entry
|
|
185
|
+
3. Link related entries across files
|
|
186
|
+
4. Keep entries concise but comprehensive
|
|
187
|
+
5. Include actionable information
|
|
188
|
+
|
|
189
|
+
### Memory Integration with Hooks
|
|
190
|
+
Post-commit hooks can automatically update memory:
|
|
191
|
+
```bash
|
|
192
|
+
# Example: Auto-log decisions from commit messages
|
|
193
|
+
if echo "$COMMIT_MSG" | grep -i "decision\|architecture"; then
|
|
194
|
+
echo "## $(date) - $COMMIT_MSG" >> .claude/memory/decisions.md
|
|
195
|
+
fi
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
## Best Practices
|
|
199
|
+
|
|
200
|
+
### Memory Hygiene
|
|
201
|
+
- Review memory files periodically for relevance
|
|
202
|
+
- Archive outdated decisions (mark as superseded)
|
|
203
|
+
- Keep context.md current with project state
|
|
204
|
+
- Prune learnings that no longer apply
|
|
205
|
+
|
|
206
|
+
### Cross-referencing
|
|
207
|
+
- Reference decision IDs in code comments
|
|
208
|
+
- Link patterns to decisions that created them
|
|
209
|
+
- Connect learnings to specific implementations
|
|
210
|
+
|
|
211
|
+
### Team Collaboration
|
|
212
|
+
- Memory files should be committed to version control
|
|
213
|
+
- Team members can add to shared learnings
|
|
214
|
+
- Decisions provide onboarding context for new members
|
|
215
|
+
|
|
216
|
+
## Input Requirements
|
|
217
|
+
- Project context and current state
|
|
218
|
+
- Decisions being made with rationale
|
|
219
|
+
- Insights and learnings discovered
|
|
220
|
+
- User preferences as they emerge
|
|
221
|
+
- Patterns and solutions developed
|
|
222
|
+
|
|
223
|
+
## Output Format
|
|
224
|
+
Return memory updates in clean markdown format with:
|
|
225
|
+
- Consistent date formatting
|
|
226
|
+
- Clear section headers
|
|
227
|
+
- Complete context for each entry
|
|
228
|
+
- Links to related information
|
|
229
|
+
- Actionable recommendations
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# Memory File Templates
|
|
2
|
+
|
|
3
|
+
## Quick Reference Templates for Memory System Files
|
|
4
|
+
|
|
5
|
+
### Context Entry Template
|
|
6
|
+
```markdown
|
|
7
|
+
## Project Overview
|
|
8
|
+
**Name**: [PROJECT_NAME]
|
|
9
|
+
**Type**: [web app | API | mobile app | library | CLI tool]
|
|
10
|
+
**Status**: [setup | development | testing | staging | production]
|
|
11
|
+
**Started**: [YYYY-MM-DD]
|
|
12
|
+
|
|
13
|
+
## Active Components
|
|
14
|
+
- [ ] Component 1
|
|
15
|
+
- [ ] Component 2
|
|
16
|
+
|
|
17
|
+
## Current Focus
|
|
18
|
+
- Primary: [Main focus area]
|
|
19
|
+
- Secondary: [Supporting work]
|
|
20
|
+
|
|
21
|
+
## Blockers
|
|
22
|
+
- [Any current blockers]
|
|
23
|
+
|
|
24
|
+
## Next Steps
|
|
25
|
+
1. [Priority 1]
|
|
26
|
+
2. [Priority 2]
|
|
27
|
+
3. [Priority 3]
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Decision Entry Template
|
|
31
|
+
```markdown
|
|
32
|
+
## [YYYY-MM-DD] - [Decision Title]
|
|
33
|
+
|
|
34
|
+
**Context**:
|
|
35
|
+
[What situation prompted this decision? What problem are we solving?]
|
|
36
|
+
|
|
37
|
+
**Decision**:
|
|
38
|
+
[What was decided? Be specific and actionable.]
|
|
39
|
+
|
|
40
|
+
**Rationale**:
|
|
41
|
+
[Why this choice over alternatives? What factors influenced the decision?]
|
|
42
|
+
|
|
43
|
+
**Alternatives Considered**:
|
|
44
|
+
1. [Alternative 1] - [Why rejected]
|
|
45
|
+
2. [Alternative 2] - [Why rejected]
|
|
46
|
+
|
|
47
|
+
**Expected Impact**:
|
|
48
|
+
- [Impact 1]
|
|
49
|
+
- [Impact 2]
|
|
50
|
+
|
|
51
|
+
**Review Date**: [When to revisit this decision]
|
|
52
|
+
**Status**: [Active | Superseded | Under Review]
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Learning Entry Template
|
|
56
|
+
```markdown
|
|
57
|
+
## [YYYY-MM-DD] - [Learning Title]
|
|
58
|
+
|
|
59
|
+
**Insight**:
|
|
60
|
+
[One-sentence summary of what was learned]
|
|
61
|
+
|
|
62
|
+
**Context**:
|
|
63
|
+
[How was this discovered? What were you working on?]
|
|
64
|
+
|
|
65
|
+
**Details**:
|
|
66
|
+
[Deeper explanation of the learning]
|
|
67
|
+
|
|
68
|
+
**Application**:
|
|
69
|
+
[How should this be applied going forward?]
|
|
70
|
+
|
|
71
|
+
**Evidence**:
|
|
72
|
+
[Links, references, or examples that support this]
|
|
73
|
+
|
|
74
|
+
**Tags**: [tag1, tag2, tag3]
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Pattern Entry Template
|
|
78
|
+
```markdown
|
|
79
|
+
## [Pattern Name]
|
|
80
|
+
|
|
81
|
+
**Category**: [Error Handling | Data Fetching | State Management | Testing | etc.]
|
|
82
|
+
|
|
83
|
+
**Use Case**:
|
|
84
|
+
[When should this pattern be used?]
|
|
85
|
+
|
|
86
|
+
**Problem**:
|
|
87
|
+
[What problem does this solve?]
|
|
88
|
+
|
|
89
|
+
**Solution**:
|
|
90
|
+
```[language]
|
|
91
|
+
// Code implementation
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
**Example Usage**:
|
|
95
|
+
```[language]
|
|
96
|
+
// Real-world example
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
**Pros**:
|
|
100
|
+
- [Advantage 1]
|
|
101
|
+
- [Advantage 2]
|
|
102
|
+
|
|
103
|
+
**Cons**:
|
|
104
|
+
- [Tradeoff 1]
|
|
105
|
+
- [Tradeoff 2]
|
|
106
|
+
|
|
107
|
+
**Related Patterns**:
|
|
108
|
+
- [Link to related pattern 1]
|
|
109
|
+
- [Link to related pattern 2]
|
|
110
|
+
|
|
111
|
+
**References**:
|
|
112
|
+
- [External resource or documentation]
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Preference Entry Template
|
|
116
|
+
```markdown
|
|
117
|
+
## [Category] Preferences
|
|
118
|
+
|
|
119
|
+
### [Subcategory]
|
|
120
|
+
**Preference**: [What is preferred]
|
|
121
|
+
**Reason**: [Why this preference exists]
|
|
122
|
+
**Exceptions**: [When to deviate from this preference]
|
|
123
|
+
|
|
124
|
+
### Examples
|
|
125
|
+
- Preferred: [Example of preferred approach]
|
|
126
|
+
- Avoid: [Example of what to avoid]
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Memory Update Checklist
|
|
130
|
+
|
|
131
|
+
### After Major Decisions
|
|
132
|
+
- [ ] Add entry to decisions.md
|
|
133
|
+
- [ ] Update context.md if project direction changed
|
|
134
|
+
- [ ] Check if patterns.md needs new pattern
|
|
135
|
+
- [ ] Note any learnings discovered
|
|
136
|
+
|
|
137
|
+
### After Bug Fixes
|
|
138
|
+
- [ ] Add root cause to learnings.md
|
|
139
|
+
- [ ] Document fix pattern in patterns.md if reusable
|
|
140
|
+
- [ ] Update context.md with current focus
|
|
141
|
+
|
|
142
|
+
### After Feature Completion
|
|
143
|
+
- [ ] Update context.md with new components
|
|
144
|
+
- [ ] Document any new patterns discovered
|
|
145
|
+
- [ ] Log architectural decisions made
|
|
146
|
+
- [ ] Capture learnings from implementation
|
|
147
|
+
|
|
148
|
+
### Weekly Review
|
|
149
|
+
- [ ] Is context.md accurate?
|
|
150
|
+
- [ ] Are there decisions that should be reviewed?
|
|
151
|
+
- [ ] Any learnings to add from recent work?
|
|
152
|
+
- [ ] New patterns worth documenting?
|