create-claude-context 1.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 (88) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +146 -0
  3. package/bin/create-claude-context.js +61 -0
  4. package/lib/detector.js +373 -0
  5. package/lib/index.js +170 -0
  6. package/lib/installer.js +362 -0
  7. package/lib/placeholder.js +208 -0
  8. package/lib/prompts.js +287 -0
  9. package/lib/spinner.js +60 -0
  10. package/lib/validate.js +147 -0
  11. package/package.json +59 -0
  12. package/templates/CLAUDE.md.template +235 -0
  13. package/templates/base/README.md +257 -0
  14. package/templates/base/RPI_WORKFLOW_PLAN.md +320 -0
  15. package/templates/base/agents/api-developer.md +76 -0
  16. package/templates/base/agents/context-engineer.md +525 -0
  17. package/templates/base/agents/core-architect.md +76 -0
  18. package/templates/base/agents/database-ops.md +76 -0
  19. package/templates/base/agents/deployment-ops.md +76 -0
  20. package/templates/base/agents/integration-hub.md +76 -0
  21. package/templates/base/analytics/README.md +114 -0
  22. package/templates/base/ci-templates/README.md +108 -0
  23. package/templates/base/ci-templates/github-actions/context-check.yml +144 -0
  24. package/templates/base/ci-templates/github-actions/validate-docs.yml +105 -0
  25. package/templates/base/commands/analytics.md +238 -0
  26. package/templates/base/commands/collab.md +194 -0
  27. package/templates/base/commands/help.md +450 -0
  28. package/templates/base/commands/rpi-implement.md +115 -0
  29. package/templates/base/commands/rpi-plan.md +93 -0
  30. package/templates/base/commands/rpi-research.md +88 -0
  31. package/templates/base/commands/validate-all.md +77 -0
  32. package/templates/base/commands/verify-docs-current.md +86 -0
  33. package/templates/base/config/base.json +57 -0
  34. package/templates/base/config/environments/development.json +13 -0
  35. package/templates/base/config/environments/production.json +17 -0
  36. package/templates/base/config/environments/staging.json +13 -0
  37. package/templates/base/config/local.json.example +21 -0
  38. package/templates/base/context/ARCHITECTURE_SNAPSHOT.md +156 -0
  39. package/templates/base/context/CODE_TO_WORKFLOW_MAP.md +94 -0
  40. package/templates/base/context/KNOWN_GOTCHAS.md +195 -0
  41. package/templates/base/context/WORKFLOW_INDEX.md +129 -0
  42. package/templates/base/context/workflows/WORKFLOW_TEMPLATE.md +294 -0
  43. package/templates/base/indexes/agents/CAPABILITY_MATRIX.md +255 -0
  44. package/templates/base/indexes/agents/CATEGORY_INDEX.md +44 -0
  45. package/templates/base/indexes/code/CATEGORY_INDEX.md +38 -0
  46. package/templates/base/indexes/routing/CATEGORY_INDEX.md +39 -0
  47. package/templates/base/indexes/search/CATEGORY_INDEX.md +39 -0
  48. package/templates/base/indexes/workflows/CATEGORY_INDEX.md +38 -0
  49. package/templates/base/knowledge/README.md +98 -0
  50. package/templates/base/knowledge/sessions/README.md +88 -0
  51. package/templates/base/knowledge/sessions/TEMPLATE.md +150 -0
  52. package/templates/base/knowledge/shared/decisions/0001-adopt-context-engineering.md +144 -0
  53. package/templates/base/knowledge/shared/decisions/README.md +49 -0
  54. package/templates/base/knowledge/shared/decisions/TEMPLATE.md +123 -0
  55. package/templates/base/knowledge/shared/patterns/README.md +62 -0
  56. package/templates/base/knowledge/shared/patterns/TEMPLATE.md +120 -0
  57. package/templates/base/plans/PLAN_TEMPLATE.md +250 -0
  58. package/templates/base/plans/active/.gitkeep +0 -0
  59. package/templates/base/plans/completed/.gitkeep +0 -0
  60. package/templates/base/research/RESEARCH_TEMPLATE.md +153 -0
  61. package/templates/base/research/active/.gitkeep +0 -0
  62. package/templates/base/research/completed/.gitkeep +0 -0
  63. package/templates/base/schemas/agent.schema.json +141 -0
  64. package/templates/base/schemas/command.schema.json +134 -0
  65. package/templates/base/schemas/manifest.schema.json +117 -0
  66. package/templates/base/schemas/plan.schema.json +136 -0
  67. package/templates/base/schemas/research.schema.json +115 -0
  68. package/templates/base/schemas/settings.schema.json +244 -0
  69. package/templates/base/schemas/workflow.schema.json +126 -0
  70. package/templates/base/settings.json +57 -0
  71. package/templates/base/standards/COMPATIBILITY.md +219 -0
  72. package/templates/base/standards/EXTENSION_GUIDELINES.md +280 -0
  73. package/templates/base/standards/QUALITY_CHECKLIST.md +211 -0
  74. package/templates/base/standards/README.md +66 -0
  75. package/templates/base/team/README.md +168 -0
  76. package/templates/base/team/config.json +79 -0
  77. package/templates/base/team/roles.json +145 -0
  78. package/templates/base/tools/bin/claude-context.js +151 -0
  79. package/templates/base/tools/lib/config-loader.js +363 -0
  80. package/templates/base/tools/lib/detector.js +350 -0
  81. package/templates/base/tools/lib/diagnose.js +206 -0
  82. package/templates/base/tools/lib/errors.js +199 -0
  83. package/templates/base/tools/lib/index.js +24 -0
  84. package/templates/base/tools/lib/init.js +192 -0
  85. package/templates/base/tools/lib/logger.js +230 -0
  86. package/templates/base/tools/lib/placeholder.js +201 -0
  87. package/templates/base/tools/lib/validate.js +521 -0
  88. package/templates/base/tools/package.json +49 -0
@@ -0,0 +1,195 @@
1
+ # Known Gotchas - {{PROJECT_NAME}}
2
+
3
+ **Purpose:** Document lessons learned, common pitfalls, and their solutions
4
+ **Use:** Before implementing features or debugging issues
5
+ **Size:** ~15k tokens (grows over time)
6
+ **Last Updated:** {{DATE}}
7
+
8
+ ---
9
+
10
+ ## How to Use This File
11
+
12
+ 1. **Before implementing:** Search for related gotchas
13
+ 2. **After fixing bugs:** Add new gotchas
14
+ 3. **During code review:** Reference relevant gotchas
15
+ 4. **Quarterly:** Review and archive resolved gotchas
16
+
17
+ ---
18
+
19
+ ## Gotcha Categories
20
+
21
+ 1. [Database](#database-gotchas)
22
+ 2. [API](#api-gotchas)
23
+ 3. [Authentication](#authentication-gotchas)
24
+ 4. [External Services](#external-services-gotchas)
25
+ 5. [Testing](#testing-gotchas)
26
+ 6. [Deployment](#deployment-gotchas)
27
+
28
+ ---
29
+
30
+ ## Database Gotchas
31
+
32
+ ### GOTCHA-DB-001: {{GOTCHA_TITLE}}
33
+
34
+ **Severity:** CRITICAL / HIGH / MEDIUM / LOW
35
+ **Discovered:** {{DATE}}
36
+ **Workflow Impact:** [workflow_1.md](./workflows/workflow_1.md)
37
+
38
+ **Symptom:**
39
+ {{WHAT_GOES_WRONG}}
40
+
41
+ **Root Cause:**
42
+ {{WHY_IT_HAPPENS}}
43
+
44
+ **Fix:**
45
+ ```
46
+ {{CODE_OR_STEPS_TO_FIX}}
47
+ ```
48
+
49
+ **Prevention:**
50
+ - {{HOW_TO_AVOID_IN_FUTURE}}
51
+
52
+ ---
53
+
54
+ ### GOTCHA-DB-002: {{GOTCHA_TITLE}}
55
+
56
+ [Same structure...]
57
+
58
+ ---
59
+
60
+ ## API Gotchas
61
+
62
+ ### GOTCHA-API-001: {{GOTCHA_TITLE}}
63
+
64
+ **Severity:** CRITICAL / HIGH / MEDIUM / LOW
65
+ **Discovered:** {{DATE}}
66
+ **Workflow Impact:** [workflow_2.md](./workflows/workflow_2.md)
67
+
68
+ **Symptom:**
69
+ {{WHAT_GOES_WRONG}}
70
+
71
+ **Root Cause:**
72
+ {{WHY_IT_HAPPENS}}
73
+
74
+ **Fix:**
75
+ ```
76
+ {{CODE_OR_STEPS_TO_FIX}}
77
+ ```
78
+
79
+ **Prevention:**
80
+ - {{HOW_TO_AVOID_IN_FUTURE}}
81
+
82
+ ---
83
+
84
+ ## Authentication Gotchas
85
+
86
+ ### GOTCHA-AUTH-001: {{GOTCHA_TITLE}}
87
+
88
+ [Same structure...]
89
+
90
+ ---
91
+
92
+ ## External Services Gotchas
93
+
94
+ ### GOTCHA-EXT-001: {{GOTCHA_TITLE}}
95
+
96
+ [Same structure...]
97
+
98
+ ---
99
+
100
+ ## Testing Gotchas
101
+
102
+ ### GOTCHA-TEST-001: {{GOTCHA_TITLE}}
103
+
104
+ [Same structure...]
105
+
106
+ ---
107
+
108
+ ## Deployment Gotchas
109
+
110
+ ### GOTCHA-DEPLOY-001: {{GOTCHA_TITLE}}
111
+
112
+ [Same structure...]
113
+
114
+ ---
115
+
116
+ ## Quick Reference Table
117
+
118
+ | ID | Title | Severity | Workflow |
119
+ |----|-------|----------|----------|
120
+ | DB-001 | {{TITLE}} | {{SEVERITY}} | workflow_1 |
121
+ | API-001 | {{TITLE}} | {{SEVERITY}} | workflow_2 |
122
+ | AUTH-001 | {{TITLE}} | {{SEVERITY}} | workflow_3 |
123
+
124
+ ---
125
+
126
+ ## Adding New Gotchas
127
+
128
+ ### Template
129
+
130
+ ```markdown
131
+ ### GOTCHA-[CATEGORY]-[NUMBER]: [Title]
132
+
133
+ **Severity:** CRITICAL / HIGH / MEDIUM / LOW
134
+ **Discovered:** YYYY-MM-DD
135
+ **Workflow Impact:** [workflow_name.md](./workflows/workflow_name.md)
136
+
137
+ **Symptom:**
138
+ [What the user/developer observes going wrong]
139
+
140
+ **Root Cause:**
141
+ [Technical explanation of why it happens]
142
+
143
+ **Fix:**
144
+ ```
145
+ [Code or steps to fix]
146
+ ```
147
+
148
+ **Prevention:**
149
+ - [How to avoid this in future code]
150
+ - [What patterns to use instead]
151
+ ```
152
+
153
+ ### Categories
154
+
155
+ - **DB**: Database, migrations, queries
156
+ - **API**: REST endpoints, request/response
157
+ - **AUTH**: Authentication, authorization, sessions
158
+ - **EXT**: External services, APIs, integrations
159
+ - **TEST**: Testing, mocking, fixtures
160
+ - **DEPLOY**: Deployment, CI/CD, infrastructure
161
+
162
+ ### Severity Levels
163
+
164
+ | Level | Definition |
165
+ |-------|------------|
166
+ | CRITICAL | Production down, data loss possible |
167
+ | HIGH | Feature broken, workaround difficult |
168
+ | MEDIUM | Feature degraded, workaround exists |
169
+ | LOW | Minor inconvenience, edge case |
170
+
171
+ ---
172
+
173
+ ## Archived Gotchas
174
+
175
+ Gotchas that are fully resolved and no longer relevant:
176
+
177
+ | ID | Title | Resolved Date | Resolution |
178
+ |----|-------|---------------|------------|
179
+ | - | - | - | - |
180
+
181
+ ---
182
+
183
+ ## Statistics
184
+
185
+ - **Total Active Gotchas:** {{TOTAL_COUNT}}
186
+ - **Critical:** {{CRITICAL_COUNT}}
187
+ - **High:** {{HIGH_COUNT}}
188
+ - **Medium:** {{MEDIUM_COUNT}}
189
+ - **Low:** {{LOW_COUNT}}
190
+ - **Last Added:** {{LAST_ADDED_DATE}}
191
+
192
+ ---
193
+
194
+ **Version:** 1.0
195
+ **Maintainer:** {{MAINTAINER}}
@@ -0,0 +1,129 @@
1
+ # Workflow Index - {{PROJECT_NAME}}
2
+
3
+ **Purpose:** Master catalog of all documented workflows
4
+ **Load First:** Always load this file before debugging/implementing
5
+ **Size:** ~15k tokens (7.5% of 200k context budget)
6
+ **Last Updated:** {{DATE}}
7
+
8
+ ---
9
+
10
+ ## Quick Navigation
11
+
12
+ | # | Workflow | Complexity | Entry Point | Use When |
13
+ |---|----------|------------|-------------|----------|
14
+ | 1 | {{WORKFLOW_1}} | HIGH/MED/LOW | [file:line] | [Scenario] |
15
+ | 2 | {{WORKFLOW_2}} | HIGH/MED/LOW | [file:line] | [Scenario] |
16
+ | 3 | {{WORKFLOW_3}} | HIGH/MED/LOW | [file:line] | [Scenario] |
17
+
18
+ ---
19
+
20
+ ## Workflow Categories
21
+
22
+ ### Category 1: {{CATEGORY_1_NAME}}
23
+
24
+ **Workflows:** X
25
+ **Total Lines:** ~XXX lines
26
+ **Primary Agent:** {{AGENT_NAME}}
27
+
28
+ | Workflow | Lines | Purpose |
29
+ |----------|-------|---------|
30
+ | [workflow_1.md](./workflows/workflow_1.md) | XXX | [Description] |
31
+
32
+ **Use This Category For:**
33
+ - [Scenario 1]
34
+ - [Scenario 2]
35
+
36
+ ---
37
+
38
+ ### Category 2: {{CATEGORY_2_NAME}}
39
+
40
+ [Same structure...]
41
+
42
+ ---
43
+
44
+ ## Cross-Reference Tables
45
+
46
+ ### External APIs × Workflows
47
+
48
+ | API | Used By Workflows |
49
+ |-----|-------------------|
50
+ | {{API_1}} | workflow_1, workflow_2 |
51
+ | {{API_2}} | workflow_3 |
52
+
53
+ ### Database Tables × Workflows
54
+
55
+ | Table | Used By Workflows |
56
+ |-------|-------------------|
57
+ | {{TABLE_1}} | workflow_1, workflow_4 |
58
+ | {{TABLE_2}} | workflow_2, workflow_3 |
59
+
60
+ ### Test Files × Workflows
61
+
62
+ | Test File | Covers Workflows |
63
+ |-----------|------------------|
64
+ | `test_workflow_1.ext` | workflow_1 |
65
+ | `test_e2e.ext` | workflow_1, workflow_2 |
66
+
67
+ ---
68
+
69
+ ## Issue Triage Quick Reference
70
+
71
+ | Symptom | Check Workflow | Key File:Line |
72
+ |---------|---------------|---------------|
73
+ | [Issue type 1] | workflow_1 | file.ext:XXX |
74
+ | [Issue type 2] | workflow_2 | file.ext:YYY |
75
+ | [Issue type 3] | workflow_3 | file.ext:ZZZ |
76
+
77
+ ---
78
+
79
+ ## Context Engineering Usage
80
+
81
+ ### Loading Strategy
82
+
83
+ ```
84
+ Step 1: Load this file (~15k tokens)
85
+ Step 2: Identify relevant workflow(s)
86
+ Step 3: Load specific workflow file (~20-50k tokens)
87
+ Step 4: Read specific code sections as needed
88
+
89
+ Total: ~50-80k tokens (25-40% of budget)
90
+ ```
91
+
92
+ ### When to Load Full Workflow
93
+
94
+ - **Debugging:** Load the affected workflow immediately
95
+ - **Feature:** Load 2-3 related workflows
96
+ - **Refactoring:** Load primary + dependent workflows
97
+
98
+ ### When NOT to Load Full Workflow
99
+
100
+ - **Simple fix:** Use this index + grep
101
+ - **Configuration change:** Direct file edit
102
+ - **Documentation update:** Direct doc edit
103
+
104
+ ---
105
+
106
+ ## Maintenance Schedule
107
+
108
+ | Task | Frequency | Time Required |
109
+ |------|-----------|---------------|
110
+ | Spot-check 5 line numbers | Monthly | 15 minutes |
111
+ | Re-run 3 discovery agents | Quarterly | 2 hours |
112
+ | Full documentation audit | Annually | 4-6 hours |
113
+
114
+ **Last Verification:** {{DATE}}
115
+ **Next Verification:** {{NEXT_DATE}}
116
+
117
+ ---
118
+
119
+ ## See Also
120
+
121
+ - **Detailed workflows:** [./workflows/](./workflows/)
122
+ - **Code organization:** [../indexes/code/CATEGORY_INDEX.md](../indexes/code/CATEGORY_INDEX.md)
123
+ - **Agent selection:** [../indexes/agents/CATEGORY_INDEX.md](../indexes/agents/CATEGORY_INDEX.md)
124
+ - **Reverse lookup:** [./CODE_TO_WORKFLOW_MAP.md](./CODE_TO_WORKFLOW_MAP.md)
125
+
126
+ ---
127
+
128
+ **Version:** 1.0
129
+ **Total Workflows:** {{WORKFLOWS_COUNT}}
@@ -0,0 +1,294 @@
1
+ # [Workflow Name] Workflow
2
+
3
+ **Last Updated:** YYYY-MM-DD
4
+ **Last Verified Against Code:** YYYY-MM-DD (commit: HASH)
5
+ **Complexity:** HIGH / MEDIUM / LOW
6
+ **Token Estimate:** ~XX,XXX tokens (X% of 200k context)
7
+
8
+ ---
9
+
10
+ ## Quick Navigation
11
+
12
+ - [Overview](#overview)
13
+ - [Entry Points](#entry-points)
14
+ - [Sub-Workflow 1: [Name]](#sub-workflow-1-name)
15
+ - [Sub-Workflow 2: [Name]](#sub-workflow-2-name)
16
+ - [Database Schema](#database-schema)
17
+ - [External APIs](#external-apis)
18
+ - [Test Coverage](#test-coverage)
19
+ - [Known Gotchas](#known-gotchas)
20
+ - [Complete Call Chain](#complete-call-chain)
21
+ - [File Reference Table](#file-reference-table)
22
+
23
+ ---
24
+
25
+ ## Overview
26
+
27
+ **User Journey:**
28
+ [Describe what the user experiences from start to finish]
29
+
30
+ **Key Features:**
31
+ - [Feature 1]
32
+ - [Feature 2]
33
+ - [Feature 3]
34
+
35
+ **Business Logic Summary:**
36
+ [2-3 sentences explaining the core business rules]
37
+
38
+ ---
39
+
40
+ ## Entry Points
41
+
42
+ ### Entry Point 1: [Name]
43
+
44
+ **File:** `path/to/file.ext` [Line XXX]
45
+ **Function:** `function_name()` [Lines XXX-YYY]
46
+ **Trigger:** [What triggers this entry point - API call, button click, scheduled job, etc.]
47
+
48
+ ```
49
+ [Brief code snippet if helpful]
50
+ ```
51
+
52
+ ---
53
+
54
+ ### Entry Point 2: [Name]
55
+
56
+ [Same structure as Entry Point 1...]
57
+
58
+ ---
59
+
60
+ ## Sub-Workflow 1: [Name]
61
+
62
+ **Purpose:** [What this sub-workflow accomplishes]
63
+ **Entry Point:** `file.ext:function_name()` [Line XXX]
64
+
65
+ ### Call Chain
66
+
67
+ ```
68
+ function_name() [file.ext:XXX]
69
+ ├─ step_one() [file.ext:YYY]
70
+ │ ├─ helper_a() [helper.ext:ZZZ]
71
+ │ └─ helper_b() [helper.ext:AAA]
72
+ ├─ step_two() [file.ext:BBB]
73
+ │ └─ database_query() [crud.ext:CCC]
74
+ └─ step_three() [file.ext:DDD]
75
+ └─ external_api() [client.ext:EEE]
76
+ ```
77
+
78
+ ### Database Operations
79
+
80
+ | Operation | Table | Purpose |
81
+ |-----------|-------|---------|
82
+ | READ | `table_name` | [Why reading] |
83
+ | WRITE | `table_name` | [What writing] |
84
+ | UPDATE | `table_name` | [What updating] |
85
+
86
+ ### External APIs
87
+
88
+ | API | Endpoint | Purpose |
89
+ |-----|----------|---------|
90
+ | [API Name] | `POST /endpoint` | [What it does] |
91
+
92
+ ### Error Handling
93
+
94
+ | Error | Handling | Recovery |
95
+ |-------|----------|----------|
96
+ | [Error type] | [How handled] | [How to recover] |
97
+
98
+ ---
99
+
100
+ ## Sub-Workflow 2: [Name]
101
+
102
+ [Same structure as Sub-Workflow 1...]
103
+
104
+ ---
105
+
106
+ ## Database Schema
107
+
108
+ ### Tables Involved
109
+
110
+ | Table | Purpose | Key Fields |
111
+ |-------|---------|------------|
112
+ | `table_1` | [Purpose] | `field_a`, `field_b` |
113
+ | `table_2` | [Purpose] | `field_c`, `field_d` |
114
+
115
+ ### Relationships
116
+
117
+ ```
118
+ table_1 ─┬─< table_2 (one-to-many via foreign_key)
119
+ └─< table_3 (one-to-many via other_key)
120
+ ```
121
+
122
+ ### Schema Notes
123
+
124
+ [Any important schema considerations, constraints, indexes, etc.]
125
+
126
+ ---
127
+
128
+ ## External APIs
129
+
130
+ ### [API Name 1]
131
+
132
+ **Base URL:** `https://api.example.com`
133
+ **Authentication:** [Method - API Key, OAuth, etc.]
134
+ **Rate Limits:** [If applicable]
135
+
136
+ **Endpoints Used:**
137
+ | Endpoint | Method | Purpose |
138
+ |----------|--------|---------|
139
+ | `/endpoint` | POST | [What it does] |
140
+
141
+ **Error Codes:**
142
+ | Code | Meaning | Handling |
143
+ |------|---------|----------|
144
+ | 400 | [Meaning] | [How handled] |
145
+ | 500 | [Meaning] | [How handled] |
146
+
147
+ ---
148
+
149
+ ## Test Coverage
150
+
151
+ ### E2E Tests
152
+
153
+ | Test File | Test Name | Coverage |
154
+ |-----------|-----------|----------|
155
+ | `tests/e2e/test_file.ext` | `test_scenario` | Sub-workflows 1-3 |
156
+
157
+ ### Unit Tests
158
+
159
+ | Test File | Coverage Area |
160
+ |-----------|---------------|
161
+ | `tests/unit/test_file.ext` | Function X, Function Y |
162
+
163
+ ### Coverage Gaps
164
+
165
+ - ❌ [Missing test scenario 1]
166
+ - ❌ [Missing test scenario 2]
167
+ - ⚠️ [Edge case not covered]
168
+
169
+ ### Running Tests
170
+
171
+ ```bash
172
+ # Run all tests for this workflow
173
+ [test command]
174
+
175
+ # Run specific test
176
+ [specific test command]
177
+ ```
178
+
179
+ ---
180
+
181
+ ## Known Gotchas
182
+
183
+ ### Gotcha 1: [Title]
184
+
185
+ **Severity:** CRITICAL / HIGH / MEDIUM / LOW
186
+ **Symptom:** [What goes wrong]
187
+ **Root Cause:** [Why it happens]
188
+
189
+ **Fix:**
190
+ ```
191
+ [Code or steps to fix]
192
+ ```
193
+
194
+ **Prevention:**
195
+ - [How to avoid in future]
196
+
197
+ **Workflow Impact:** Sub-Workflow [X] is affected
198
+
199
+ ---
200
+
201
+ ### Gotcha 2: [Title]
202
+
203
+ [Same structure as Gotcha 1...]
204
+
205
+ ---
206
+
207
+ ## Complete Call Chain
208
+
209
+ ### End-to-End Flow Diagram
210
+
211
+ ```
212
+ [User Action / Trigger]
213
+
214
+
215
+ ┌─────────────────────┐
216
+ │ Entry Point │ file.ext:XXX
217
+ │ function_name() │
218
+ └─────────┬───────────┘
219
+
220
+
221
+ ┌─────────────────────┐
222
+ │ Sub-Workflow 1 │
223
+ │ [Name] │
224
+ └─────────┬───────────┘
225
+
226
+
227
+ ┌─────────────────────┐
228
+ │ Sub-Workflow 2 │ ──► [External API]
229
+ │ [Name] │
230
+ └─────────┬───────────┘
231
+
232
+
233
+ ┌─────────────────────┐
234
+ │ Database │
235
+ │ Operations │
236
+ └─────────┬───────────┘
237
+
238
+
239
+ ┌─────────────────────┐
240
+ │ Response/ │
241
+ │ Completion │
242
+ └─────────────────────┘
243
+ ```
244
+
245
+ ### State Transitions (if applicable)
246
+
247
+ ```
248
+ [STATE_A] ──event──► [STATE_B] ──event──► [STATE_C]
249
+ │ │
250
+ └──────────── error ────────────────────►│
251
+
252
+ [STATE_ERROR]
253
+ ```
254
+
255
+ ---
256
+
257
+ ## File Reference Table
258
+
259
+ | File | Size | Purpose | Key Functions |
260
+ |------|------|---------|---------------|
261
+ | `path/file_1.ext` | XX KB | [What it does] | `func_a:XXX`, `func_b:YYY` |
262
+ | `path/file_2.ext` | XX KB | [What it does] | `func_c:ZZZ` |
263
+ | `path/file_3.ext` | XX KB | [What it does] | `func_d:AAA` |
264
+
265
+ ---
266
+
267
+ ## Maintenance Schedule
268
+
269
+ | Task | Frequency | Last Done | Next Due |
270
+ |------|-----------|-----------|----------|
271
+ | Verify line numbers | Monthly | YYYY-MM-DD | YYYY-MM-DD |
272
+ | Full audit | Quarterly | YYYY-MM-DD | YYYY-MM-DD |
273
+
274
+ ---
275
+
276
+ ## Related Documentation
277
+
278
+ - **Parent Index:** [WORKFLOW_INDEX.md](../WORKFLOW_INDEX.md)
279
+ - **Related Workflows:** [workflow_2.md](./workflow_2.md)
280
+ - **Responsible Agent:** [agent-name.md](../../agents/agent-name.md)
281
+
282
+ ---
283
+
284
+ ## Change Log
285
+
286
+ | Date | Change | Commit |
287
+ |------|--------|--------|
288
+ | YYYY-MM-DD | Initial documentation | `hash` |
289
+
290
+ ---
291
+
292
+ **Version:** 1.0
293
+ **Word Count:** ~XXX words
294
+ **Token Estimate:** ~XX,XXX tokens