create-universal-ai-context 2.0.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 (136) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +171 -0
  3. package/bin/create-ai-context.js +337 -0
  4. package/lib/adapters/antigravity.js +160 -0
  5. package/lib/adapters/claude.js +122 -0
  6. package/lib/adapters/cline.js +111 -0
  7. package/lib/adapters/copilot.js +117 -0
  8. package/lib/adapters/index.js +69 -0
  9. package/lib/ai-context-generator.js +234 -0
  10. package/lib/ai-orchestrator.js +431 -0
  11. package/lib/call-tracer.js +444 -0
  12. package/lib/detector.js +726 -0
  13. package/lib/environment-detector.js +239 -0
  14. package/lib/index.js +310 -0
  15. package/lib/installer.js +418 -0
  16. package/lib/migrate.js +319 -0
  17. package/lib/placeholder.js +541 -0
  18. package/lib/prompts.js +287 -0
  19. package/lib/spinner.js +60 -0
  20. package/lib/static-analyzer.js +729 -0
  21. package/lib/template-populator.js +843 -0
  22. package/lib/template-renderer.js +382 -0
  23. package/lib/validate.js +155 -0
  24. package/package.json +70 -0
  25. package/templates/AI_CONTEXT.md.template +245 -0
  26. package/templates/base/README.md +257 -0
  27. package/templates/base/RPI_WORKFLOW_PLAN.md +320 -0
  28. package/templates/base/agents/api-developer.md +76 -0
  29. package/templates/base/agents/context-engineer.md +525 -0
  30. package/templates/base/agents/core-architect.md +76 -0
  31. package/templates/base/agents/database-ops.md +76 -0
  32. package/templates/base/agents/deployment-ops.md +76 -0
  33. package/templates/base/agents/integration-hub.md +76 -0
  34. package/templates/base/analytics/README.md +114 -0
  35. package/templates/base/automation/config.json +58 -0
  36. package/templates/base/automation/generators/code-mapper.js +308 -0
  37. package/templates/base/automation/generators/index-builder.js +321 -0
  38. package/templates/base/automation/hooks/post-commit.sh +83 -0
  39. package/templates/base/automation/hooks/pre-commit.sh +103 -0
  40. package/templates/base/ci-templates/README.md +108 -0
  41. package/templates/base/ci-templates/github-actions/context-check.yml +144 -0
  42. package/templates/base/ci-templates/github-actions/validate-docs.yml +105 -0
  43. package/templates/base/commands/analytics.md +238 -0
  44. package/templates/base/commands/auto-sync.md +172 -0
  45. package/templates/base/commands/collab.md +194 -0
  46. package/templates/base/commands/help.md +450 -0
  47. package/templates/base/commands/rpi-implement.md +115 -0
  48. package/templates/base/commands/rpi-plan.md +93 -0
  49. package/templates/base/commands/rpi-research.md +88 -0
  50. package/templates/base/commands/session-resume.md +144 -0
  51. package/templates/base/commands/session-save.md +112 -0
  52. package/templates/base/commands/validate-all.md +77 -0
  53. package/templates/base/commands/verify-docs-current.md +86 -0
  54. package/templates/base/config/base.json +57 -0
  55. package/templates/base/config/environments/development.json +13 -0
  56. package/templates/base/config/environments/production.json +17 -0
  57. package/templates/base/config/environments/staging.json +13 -0
  58. package/templates/base/config/local.json.example +21 -0
  59. package/templates/base/context/.meta/generated-at.json +18 -0
  60. package/templates/base/context/ARCHITECTURE_SNAPSHOT.md +156 -0
  61. package/templates/base/context/CODE_TO_WORKFLOW_MAP.md +94 -0
  62. package/templates/base/context/FILE_OWNERSHIP.md +57 -0
  63. package/templates/base/context/INTEGRATION_POINTS.md +92 -0
  64. package/templates/base/context/KNOWN_GOTCHAS.md +195 -0
  65. package/templates/base/context/TESTING_MAP.md +95 -0
  66. package/templates/base/context/WORKFLOW_INDEX.md +129 -0
  67. package/templates/base/context/workflows/WORKFLOW_TEMPLATE.md +294 -0
  68. package/templates/base/indexes/agents/CAPABILITY_MATRIX.md +255 -0
  69. package/templates/base/indexes/agents/CATEGORY_INDEX.md +44 -0
  70. package/templates/base/indexes/code/CATEGORY_INDEX.md +38 -0
  71. package/templates/base/indexes/routing/CATEGORY_INDEX.md +39 -0
  72. package/templates/base/indexes/search/CATEGORY_INDEX.md +39 -0
  73. package/templates/base/indexes/workflows/CATEGORY_INDEX.md +38 -0
  74. package/templates/base/knowledge/README.md +98 -0
  75. package/templates/base/knowledge/sessions/README.md +88 -0
  76. package/templates/base/knowledge/sessions/TEMPLATE.md +150 -0
  77. package/templates/base/knowledge/shared/decisions/0001-adopt-context-engineering.md +144 -0
  78. package/templates/base/knowledge/shared/decisions/README.md +49 -0
  79. package/templates/base/knowledge/shared/decisions/TEMPLATE.md +123 -0
  80. package/templates/base/knowledge/shared/patterns/README.md +62 -0
  81. package/templates/base/knowledge/shared/patterns/TEMPLATE.md +120 -0
  82. package/templates/base/plans/PLAN_TEMPLATE.md +250 -0
  83. package/templates/base/plans/active/.gitkeep +0 -0
  84. package/templates/base/plans/completed/.gitkeep +0 -0
  85. package/templates/base/research/RESEARCH_TEMPLATE.md +153 -0
  86. package/templates/base/research/active/.gitkeep +0 -0
  87. package/templates/base/research/completed/.gitkeep +0 -0
  88. package/templates/base/schemas/agent.schema.json +141 -0
  89. package/templates/base/schemas/anchors.schema.json +54 -0
  90. package/templates/base/schemas/automation.schema.json +93 -0
  91. package/templates/base/schemas/command.schema.json +134 -0
  92. package/templates/base/schemas/hashes.schema.json +40 -0
  93. package/templates/base/schemas/manifest.schema.json +117 -0
  94. package/templates/base/schemas/plan.schema.json +136 -0
  95. package/templates/base/schemas/research.schema.json +115 -0
  96. package/templates/base/schemas/roles.schema.json +34 -0
  97. package/templates/base/schemas/session.schema.json +77 -0
  98. package/templates/base/schemas/settings.schema.json +244 -0
  99. package/templates/base/schemas/staleness.schema.json +53 -0
  100. package/templates/base/schemas/team-config.schema.json +42 -0
  101. package/templates/base/schemas/workflow.schema.json +126 -0
  102. package/templates/base/session/checkpoints/.gitkeep +2 -0
  103. package/templates/base/session/current/state.json +20 -0
  104. package/templates/base/session/history/.gitkeep +2 -0
  105. package/templates/base/settings.json +3 -0
  106. package/templates/base/standards/COMPATIBILITY.md +219 -0
  107. package/templates/base/standards/EXTENSION_GUIDELINES.md +280 -0
  108. package/templates/base/standards/QUALITY_CHECKLIST.md +211 -0
  109. package/templates/base/standards/README.md +66 -0
  110. package/templates/base/sync/anchors.json +6 -0
  111. package/templates/base/sync/hashes.json +6 -0
  112. package/templates/base/sync/staleness.json +10 -0
  113. package/templates/base/team/README.md +168 -0
  114. package/templates/base/team/config.json +79 -0
  115. package/templates/base/team/roles.json +145 -0
  116. package/templates/base/tools/bin/claude-context.js +151 -0
  117. package/templates/base/tools/lib/anchor-resolver.js +276 -0
  118. package/templates/base/tools/lib/config-loader.js +363 -0
  119. package/templates/base/tools/lib/detector.js +350 -0
  120. package/templates/base/tools/lib/diagnose.js +206 -0
  121. package/templates/base/tools/lib/drift-detector.js +373 -0
  122. package/templates/base/tools/lib/errors.js +199 -0
  123. package/templates/base/tools/lib/index.js +36 -0
  124. package/templates/base/tools/lib/init.js +192 -0
  125. package/templates/base/tools/lib/logger.js +230 -0
  126. package/templates/base/tools/lib/placeholder.js +201 -0
  127. package/templates/base/tools/lib/session-manager.js +354 -0
  128. package/templates/base/tools/lib/validate.js +521 -0
  129. package/templates/base/tools/package.json +49 -0
  130. package/templates/handlebars/antigravity.hbs +337 -0
  131. package/templates/handlebars/claude.hbs +184 -0
  132. package/templates/handlebars/cline.hbs +63 -0
  133. package/templates/handlebars/copilot.hbs +131 -0
  134. package/templates/handlebars/partials/gotcha-list.hbs +11 -0
  135. package/templates/handlebars/partials/header.hbs +3 -0
  136. package/templates/handlebars/partials/workflow-summary.hbs +16 -0
@@ -0,0 +1,255 @@
1
+ # Agent Capability Matrix
2
+
3
+ Quick reference for selecting the right agent for your task.
4
+
5
+ ---
6
+
7
+ ## Decision Matrix
8
+
9
+ | Task Type | Primary Agent | Support Agent | Notes |
10
+ |-----------|---------------|---------------|-------|
11
+ | **Initialization/Setup** | `@context-engineer` | - | Only for first-time setup |
12
+ | **System Architecture** | `@core-architect` | `@database-ops` | High-level design |
13
+ | **State Machines** | `@core-architect` | - | Flow analysis |
14
+ | **Database Schema** | `@database-ops` | `@core-architect` | Schema design |
15
+ | **Migrations** | `@database-ops` | - | Schema changes |
16
+ | **Query Optimization** | `@database-ops` | - | Performance |
17
+ | **API Design** | `@api-developer` | `@core-architect` | REST/GraphQL |
18
+ | **API Contracts** | `@api-developer` | - | Request/response |
19
+ | **API Documentation** | `@api-developer` | - | OpenAPI/Swagger |
20
+ | **External Integrations** | `@integration-hub` | `@api-developer` | Third-party APIs |
21
+ | **Webhooks** | `@integration-hub` | - | Incoming/outgoing |
22
+ | **Authentication (External)** | `@integration-hub` | - | OAuth, API keys |
23
+ | **CI/CD Pipelines** | `@deployment-ops` | - | Build/deploy |
24
+ | **Infrastructure** | `@deployment-ops` | - | IaC, cloud |
25
+ | **Deployment Strategy** | `@deployment-ops` | `@core-architect` | Blue-green, canary |
26
+ | **Performance Tuning** | `@core-architect` | `@database-ops` | System-wide |
27
+ | **Security Review** | `@core-architect` | All | Cross-cutting |
28
+
29
+ ---
30
+
31
+ ## Agent Selection Flowchart
32
+
33
+ ```
34
+ START: What are you trying to do?
35
+
36
+ ├─► Setting up for the first time?
37
+ │ └─► @context-engineer
38
+
39
+ ├─► Working with external services?
40
+ │ ├─► Third-party APIs → @integration-hub
41
+ │ ├─► Webhooks → @integration-hub
42
+ │ └─► External auth → @integration-hub
43
+
44
+ ├─► Working with the database?
45
+ │ ├─► Schema design → @database-ops
46
+ │ ├─► Migrations → @database-ops
47
+ │ └─► Query performance → @database-ops
48
+
49
+ ├─► Working with APIs?
50
+ │ ├─► Endpoint design → @api-developer
51
+ │ ├─► Contracts/schemas → @api-developer
52
+ │ └─► API documentation → @api-developer
53
+
54
+ ├─► Working with deployment?
55
+ │ ├─► CI/CD pipelines → @deployment-ops
56
+ │ ├─► Infrastructure → @deployment-ops
57
+ │ └─► Rollback planning → @deployment-ops
58
+
59
+ └─► System design or architecture?
60
+ └─► @core-architect
61
+ ```
62
+
63
+ ---
64
+
65
+ ## Agent Profiles
66
+
67
+ ### @context-engineer
68
+
69
+ | Attribute | Value |
70
+ |-----------|-------|
71
+ | **Category** | Initialization |
72
+ | **Complexity** | Very High |
73
+ | **Context Budget** | ~80K tokens (40%) |
74
+ | **Primary Use** | First-time setup, documentation refresh |
75
+
76
+ **Best For:**
77
+ - Initial repository setup
78
+ - Complete documentation generation
79
+ - Workflow discovery
80
+ - Template population
81
+
82
+ **Not For:**
83
+ - Day-to-day development
84
+ - Specific domain tasks
85
+ - Quick fixes
86
+
87
+ ---
88
+
89
+ ### @core-architect
90
+
91
+ | Attribute | Value |
92
+ |-----------|-------|
93
+ | **Category** | Architecture |
94
+ | **Complexity** | High |
95
+ | **Context Budget** | ~50K tokens (25%) |
96
+ | **Primary Use** | System design, state machines |
97
+
98
+ **Best For:**
99
+ - High-level system design
100
+ - State machine analysis
101
+ - Dependency mapping
102
+ - Scalability planning
103
+ - Cross-cutting concerns
104
+
105
+ **Not For:**
106
+ - Database-specific work
107
+ - API implementation details
108
+ - External service integration
109
+
110
+ ---
111
+
112
+ ### @database-ops
113
+
114
+ | Attribute | Value |
115
+ |-----------|-------|
116
+ | **Category** | Database |
117
+ | **Complexity** | Medium-High |
118
+ | **Context Budget** | ~40K tokens (20%) |
119
+ | **Primary Use** | Schema, migrations, queries |
120
+
121
+ **Best For:**
122
+ - Schema design and validation
123
+ - Migration planning
124
+ - Query optimization
125
+ - Data integrity
126
+ - Database performance
127
+
128
+ **Not For:**
129
+ - API design
130
+ - External integrations
131
+ - Deployment
132
+
133
+ ---
134
+
135
+ ### @api-developer
136
+
137
+ | Attribute | Value |
138
+ |-----------|-------|
139
+ | **Category** | API |
140
+ | **Complexity** | Medium |
141
+ | **Context Budget** | ~35K tokens (17%) |
142
+ | **Primary Use** | Endpoints, contracts |
143
+
144
+ **Best For:**
145
+ - REST API design
146
+ - GraphQL schema
147
+ - Contract definition
148
+ - API documentation
149
+ - Endpoint testing strategy
150
+
151
+ **Not For:**
152
+ - Database operations
153
+ - External service integration
154
+ - Infrastructure
155
+
156
+ ---
157
+
158
+ ### @integration-hub
159
+
160
+ | Attribute | Value |
161
+ |-----------|-------|
162
+ | **Category** | Integration |
163
+ | **Complexity** | Medium-High |
164
+ | **Context Budget** | ~40K tokens (20%) |
165
+ | **Primary Use** | External services, webhooks |
166
+
167
+ **Best For:**
168
+ - Third-party API integration
169
+ - Webhook handling
170
+ - External authentication
171
+ - Rate limiting
172
+ - Integration error handling
173
+
174
+ **Not For:**
175
+ - Internal API design
176
+ - Database work
177
+ - Deployment
178
+
179
+ ---
180
+
181
+ ### @deployment-ops
182
+
183
+ | Attribute | Value |
184
+ |-----------|-------|
185
+ | **Category** | DevOps |
186
+ | **Complexity** | High |
187
+ | **Context Budget** | ~45K tokens (22%) |
188
+ | **Primary Use** | CI/CD, infrastructure |
189
+
190
+ **Best For:**
191
+ - CI/CD pipeline design
192
+ - Infrastructure as code
193
+ - Deployment strategies
194
+ - Environment management
195
+ - Rollback planning
196
+
197
+ **Not For:**
198
+ - Application code
199
+ - Database schema
200
+ - API design
201
+
202
+ ---
203
+
204
+ ## Capability Overlap
205
+
206
+ Some tasks benefit from multiple agents working together:
207
+
208
+ ### Architecture + Database
209
+ When designing a new feature that involves both system architecture and data persistence:
210
+ 1. Start with `@core-architect` for high-level design
211
+ 2. Consult `@database-ops` for schema implications
212
+ 3. Return to `@core-architect` for integration
213
+
214
+ ### API + Integration
215
+ When building an API that wraps external services:
216
+ 1. Start with `@api-developer` for your API design
217
+ 2. Consult `@integration-hub` for external service patterns
218
+ 3. Return to `@api-developer` for implementation
219
+
220
+ ### All Agents for Security Review
221
+ Security reviews often require input from multiple perspectives:
222
+ - `@core-architect` - System-level security
223
+ - `@database-ops` - Data security
224
+ - `@api-developer` - API security
225
+ - `@integration-hub` - Integration security
226
+ - `@deployment-ops` - Infrastructure security
227
+
228
+ ---
229
+
230
+ ## Quick Reference Card
231
+
232
+ ```
233
+ ┌─────────────────────────────────────────────────────────────┐
234
+ │ AGENT QUICK SELECT │
235
+ ├─────────────────────────────────────────────────────────────┤
236
+ │ │
237
+ │ 🚀 Setup/Init → @context-engineer │
238
+ │ 🏗️ Architecture → @core-architect │
239
+ │ 🗄️ Database → @database-ops │
240
+ │ 🔌 API → @api-developer │
241
+ │ 🔗 External → @integration-hub │
242
+ │ 📦 Deploy → @deployment-ops │
243
+ │ │
244
+ ├─────────────────────────────────────────────────────────────┤
245
+ │ When unsure, start with @core-architect for guidance │
246
+ └─────────────────────────────────────────────────────────────┘
247
+ ```
248
+
249
+ ---
250
+
251
+ ## See Also
252
+
253
+ - [Agent Details](./../agents/) - Full agent documentation
254
+ - [Commands Reference](./../../commands/help.md) - Available commands
255
+ - [RPI Workflow](./../../RPI_WORKFLOW_PLAN.md) - Research-Plan-Implement methodology
@@ -0,0 +1,44 @@
1
+ # Agents Category Index
2
+
3
+ ## Purpose
4
+ Entry point for agent selection matrix
5
+
6
+ ## Agents Available
7
+
8
+ | Agent | Primary Workflows | Use For |
9
+ |-------|------------------|---------|
10
+ | **`context-engineer`** | INITIALIZATION | Transform this template for any codebase |
11
+ | **core-architect** | System architecture, state machines | High-level design and architecture |
12
+ | **database-ops** | Migrations, schema, queries | Database operations and optimization |
13
+ | **api-developer** | Endpoints, contracts | API design and implementation |
14
+ | **integration-hub** | External services | Third-party service integration |
15
+ | **deployment-ops** | CI/CD, infrastructure | Deployment and infrastructure management |
16
+
17
+ ## Detailed Selection Guide
18
+
19
+ For detailed agent selection guidance including capabilities, workflows, and decision criteria, see:
20
+ **[CAPABILITY_MATRIX.md](./CAPABILITY_MATRIX.md)**
21
+
22
+ ## Quick Start
23
+
24
+ 1. Load this category index first (~5k tokens)
25
+ 2. Check CAPABILITY_MATRIX.md for detailed selection guidance
26
+ 3. Load agent definition for detailed capabilities
27
+ 4. Use agent for specific tasks
28
+
29
+ ## Context Budget
30
+ - Category Index: ~5k tokens (2.5% of context window)
31
+ - Agent Definition: ~10k tokens (5% of context window)
32
+ - Agent Session: ~50k tokens (25% of context window)
33
+
34
+ ## Getting Started
35
+
36
+ ```bash
37
+ # Load category index first
38
+ Read: .ai-context/indexes/agents/CATEGORY_INDEX.md
39
+
40
+ # Then load relevant agent definition
41
+ Read: .ai-context/agents/[agent].md
42
+
43
+ # Finally use agent for specific tasks
44
+ @agent-name "Task description"
@@ -0,0 +1,38 @@
1
+ # Code Category Index
2
+
3
+ ## Purpose
4
+ Entry point for code organization and domain × layer overview
5
+
6
+ ## Domains & Layers Available
7
+
8
+ | Domain | Layers | Description | When to Use |
9
+ |--------|--------|-------------|-------------|
10
+ | **core** | utils, services, models | Core application logic | When working with fundamental app components |
11
+ | **api** | controllers, routes, middleware | API layer | When implementing or debugging APIs |
12
+ | **infrastructure** | config, db, caching | Infrastructure components | When working with databases, caches, or configs |
13
+ | **ui** | components, pages, styles | User interface | When building or modifying front-end features |
14
+ | **testing** | unit, integration, e2e | Test suites | When writing or debugging tests |
15
+
16
+ ## Quick Start
17
+
18
+ 1. Load this category index first (~5k tokens)
19
+ 2. Identify relevant domain and layer
20
+ 3. Load domain index for detailed navigation
21
+ 4. Access code files for implementation
22
+
23
+ ## Context Budget
24
+ - Category Index: ~5k tokens (2.5% of context window)
25
+ - Domain Index: ~15k tokens (7.5% of context window)
26
+ - Code Files: ~20k tokens (10% of context window)
27
+
28
+ ## Getting Started
29
+
30
+ ```bash
31
+ # Load category index first
32
+ Read: .ai-context/indexes/code/CATEGORY_INDEX.md
33
+
34
+ # Then load relevant domain index
35
+ Read: .ai-context/indexes/code/[domain].md
36
+
37
+ # Finally load specific code files
38
+ Read: [code_file_path]
@@ -0,0 +1,39 @@
1
+ # Routing Category Index
2
+
3
+ ## Purpose
4
+ Entry point for task routing and classification
5
+
6
+ ## Task Types Available
7
+
8
+ | Task Type | Description | When to Use |
9
+ |-----------|-------------|-------------|
10
+ | **Feature** | New feature implementation | When building new functionality |
11
+ | **Bug Fix** | Issue resolution | When fixing bugs or issues |
12
+ | **Refactor** | Code improvement | When refactoring existing code |
13
+ | **Documentation** | Doc updates | When updating documentation |
14
+ | **Technical Debt** | Legacy improvements | When addressing technical debt |
15
+ | **Performance** | Optimization | When improving performance |
16
+
17
+ ## Quick Start
18
+
19
+ 1. Load this category index first (~5k tokens)
20
+ 2. Identify relevant task type
21
+ 3. Load routing matrix for detailed classification
22
+ 4. Follow routing instructions for implementation
23
+
24
+ ## Context Budget
25
+ - Category Index: ~5k tokens (2.5% of context window)
26
+ - Routing Matrix: ~10k tokens (5% of context window)
27
+ - Implementation Guidance: ~30k tokens (15% of context window)
28
+
29
+ ## Getting Started
30
+
31
+ ```bash
32
+ # Load category index first
33
+ Read: .ai-context/indexes/routing/CATEGORY_INDEX.md
34
+
35
+ # Then load relevant routing matrix
36
+ Read: .ai-context/indexes/routing/[task_type].md
37
+
38
+ # Finally follow routing instructions
39
+ Follow guidance in routing matrix
@@ -0,0 +1,39 @@
1
+ # Search Category Index
2
+
3
+ ## Purpose
4
+ Entry point for search strategies and pattern recognition
5
+
6
+ ## Search Patterns Available
7
+
8
+ | Pattern Type | Description | When to Use |
9
+ |--------------|-------------|-------------|
10
+ | **Configuration Values** | Environment variables, hardcoded settings | When searching for config values |
11
+ | **Business Logic** | Core application logic files | When locating business rules |
12
+ | **Database Schema** | Models, migrations, queries | When investigating data structures |
13
+ | **External Integrations** | API calls, webhooks, Connectors | When examining third-party integrations |
14
+ | **Error Handling** | Exception handling patterns | When debugging error scenarios |
15
+ | **Performance Bottlenecks** | Heavy computations, slow queries | When optimizing performance |
16
+
17
+ ## Quick Start
18
+
19
+ 1. Load this category index first (~5k tokens)
20
+ 2. Identify relevant search pattern
21
+ 3. Load pattern details for specific implementation
22
+ 4. Use search strategies for investigation
23
+
24
+ ## Context Budget
25
+ - Category Index: ~5k tokens (2.5% of context window)
26
+ - Pattern Details: ~10k tokens (5% of context window)
27
+ - Search Execution: ~30k tokens (15% of context window)
28
+
29
+ ## Getting Started
30
+
31
+ ```bash
32
+ # Load category index first
33
+ Read: .ai-context/indexes/search/CATEGORY_INDEX.md
34
+
35
+ # Then load relevant pattern details
36
+ Read: .ai-context/indexes/search/[pattern_type].md
37
+
38
+ # Finally execute search strategy
39
+ Follow pattern instructions for investigation
@@ -0,0 +1,38 @@
1
+ # Workflows Category Index
2
+
3
+ ## Purpose
4
+ Entry point for workflow-related navigation and task classification
5
+
6
+ ## Categories Available
7
+
8
+ | Category | Description | When to Use |
9
+ |----------|-------------|-------------|
10
+ | **jobs** | Job-related workflows (hiring, onboarding, payroll) | When working with HR or recruitment processes |
11
+ | **payment** | Payment processing workflows | When implementing payment features |
12
+ | **email** | Email-related workflows | When building email functionality |
13
+ | **reporting** | Reporting and analytics workflows | When creating dashboards or reports |
14
+ | **authentication** | Auth-related workflows | When implementing login/registration features |
15
+
16
+ ## Quick Start
17
+
18
+ 1. Load this category index first (~5k tokens)
19
+ 2. Identify relevant category
20
+ 3. Load domain index for detailed navigation
21
+ 4. Access workflow detail files for implementation
22
+
23
+ ## Context Budget
24
+ - Category Index: ~5k tokens (2.5% of context window)
25
+ - Domain Index: ~15k tokens (7.5% of context window)
26
+ - Workflow Detail: ~40k tokens (20% of context window)
27
+
28
+ ## Getting Started
29
+
30
+ ```bash
31
+ # Load category index first
32
+ Read: .ai-context/indexes/workflows/CATEGORY_INDEX.md
33
+
34
+ # Then load relevant domain index
35
+ Read: .ai-context/indexes/workflows/[category].md
36
+
37
+ # Finally load workflow detail file
38
+ Read: .ai-context/context/workflows/[workflow].md
@@ -0,0 +1,98 @@
1
+ # Shared Knowledge Base
2
+
3
+ Central repository for team knowledge, decisions, patterns, and session handoffs.
4
+
5
+ ## Directory Structure
6
+
7
+ ```
8
+ knowledge/
9
+ ├── shared/ # Team-shared knowledge
10
+ │ ├── decisions/ # Architecture Decision Records (ADRs)
11
+ │ └── patterns/ # Reusable code patterns
12
+ ├── sessions/ # Session handoff documents
13
+ └── README.md # This file
14
+ ```
15
+
16
+ ## Shared Knowledge
17
+
18
+ ### Architecture Decision Records (ADRs)
19
+
20
+ Located in `shared/decisions/`, ADRs document significant architectural decisions.
21
+
22
+ **Creating an ADR:**
23
+ 1. Copy `shared/decisions/TEMPLATE.md`
24
+ 2. Name it `NNNN-descriptive-title.md` (e.g., `0001-use-postgresql.md`)
25
+ 3. Fill in all sections
26
+ 4. Submit for team review
27
+
28
+ **ADR Statuses:**
29
+ - `proposed` - Under discussion
30
+ - `accepted` - Approved and in effect
31
+ - `deprecated` - Superseded by another ADR
32
+ - `rejected` - Not approved
33
+
34
+ ### Reusable Patterns
35
+
36
+ Located in `shared/patterns/`, patterns document proven solutions to common problems.
37
+
38
+ **Pattern Categories:**
39
+ - `api/` - API design patterns
40
+ - `data/` - Data handling patterns
41
+ - `ui/` - User interface patterns
42
+ - `testing/` - Testing patterns
43
+ - `security/` - Security patterns
44
+
45
+ ## Session Handoffs
46
+
47
+ Located in `sessions/`, handoff documents enable continuity between Claude Code sessions.
48
+
49
+ **Handoff Document Contents:**
50
+ - Session summary
51
+ - Work completed
52
+ - Work in progress
53
+ - Blockers and issues
54
+ - Next steps
55
+ - Relevant context
56
+
57
+ **Creating a Handoff:**
58
+ ```
59
+ /collab handoff
60
+ ```
61
+
62
+ **Naming Convention:**
63
+ `YYYY-MM-DD-HH-MM-member-id.md`
64
+
65
+ ## Usage
66
+
67
+ ### Adding Knowledge
68
+
69
+ 1. Create document in appropriate directory
70
+ 2. Follow the template structure
71
+ 3. Run `/collab sync` to notify team
72
+
73
+ ### Finding Knowledge
74
+
75
+ 1. Check category directories for relevant content
76
+ 2. Use grep/search for specific terms
77
+ 3. Review recent session handoffs for context
78
+
79
+ ### Updating Knowledge
80
+
81
+ 1. Edit the document
82
+ 2. Update the `last_updated` metadata
83
+ 3. Add to revision history if significant
84
+
85
+ ## Retention Policy
86
+
87
+ | Content Type | Retention |
88
+ |--------------|-----------|
89
+ | ADRs | Permanent (archive deprecated) |
90
+ | Patterns | Permanent (version updates) |
91
+ | Session Handoffs | 90 days (archive important ones) |
92
+
93
+ ## Best Practices
94
+
95
+ 1. **Keep it Current** - Update knowledge when code changes
96
+ 2. **Be Specific** - Include concrete examples
97
+ 3. **Link to Code** - Reference file:line where applicable
98
+ 4. **Review Regularly** - Prune outdated content monthly
@@ -0,0 +1,88 @@
1
+ # Session Handoffs
2
+
3
+ This directory contains session handoff documents that enable continuity between Claude Code sessions.
4
+
5
+ ## Purpose
6
+
7
+ Session handoffs capture:
8
+ - Work completed during a session
9
+ - Work in progress with current state
10
+ - Blockers and issues encountered
11
+ - Context needed for continuation
12
+ - Recommended next steps
13
+
14
+ ## Creating a Handoff
15
+
16
+ Use the `/collab handoff` command at the end of a session:
17
+
18
+ ```
19
+ /collab handoff
20
+ ```
21
+
22
+ This generates a handoff document from the current session state.
23
+
24
+ ## Manual Handoff
25
+
26
+ If the command isn't available, copy `TEMPLATE.md` and fill in:
27
+
28
+ 1. Session metadata
29
+ 2. Completed work summary
30
+ 3. In-progress work state
31
+ 4. Any blockers or issues
32
+ 5. Context for next session
33
+ 6. Recommended next steps
34
+
35
+ ## Naming Convention
36
+
37
+ Handoff files are named:
38
+ ```
39
+ YYYY-MM-DD-HH-MM-member-id.md
40
+ ```
41
+
42
+ Example: `2024-01-15-14-30-dev-1.md`
43
+
44
+ ## Finding Relevant Handoffs
45
+
46
+ ### Most Recent
47
+
48
+ Sort by filename (most recent first):
49
+ ```bash
50
+ ls -r sessions/*.md
51
+ ```
52
+
53
+ ### By Team Member
54
+
55
+ ```bash
56
+ ls sessions/*-member-id.md
57
+ ```
58
+
59
+ ### By Date Range
60
+
61
+ ```bash
62
+ ls sessions/2024-01-*.md
63
+ ```
64
+
65
+ ## Retention
66
+
67
+ | Age | Action |
68
+ |-----|--------|
69
+ | < 7 days | Keep (active reference) |
70
+ | 7-30 days | Review for archival |
71
+ | 30-90 days | Archive important, delete routine |
72
+ | > 90 days | Delete unless historically significant |
73
+
74
+ ## Archiving
75
+
76
+ Important handoffs (major feature completions, incident resolutions) should be:
77
+
78
+ 1. Moved to `sessions/archive/`
79
+ 2. Renamed with descriptive suffix: `YYYY-MM-DD-feature-name.md`
80
+ 3. Referenced in relevant ADRs if applicable
81
+
82
+ ## Best Practices
83
+
84
+ 1. **Create handoffs proactively** - Don't wait until context is lost
85
+ 2. **Be specific** - Include file paths, line numbers, commit hashes
86
+ 3. **Note blockers clearly** - Help the next person avoid wasted effort
87
+ 4. **Include context** - Share discoveries that aren't in the code
88
+ 5. **Suggest next steps** - Prioritize what should happen next