@namch/agent-assistant 1.3.0 → 1.3.2

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 (142) hide show
  1. package/CHANGELOG.md +24 -1
  2. package/README.md +3 -4
  3. package/agents/backend-engineer.md +3 -3
  4. package/agents/brainstormer.md +3 -3
  5. package/agents/business-analyst.md +3 -3
  6. package/agents/database-architect.md +3 -3
  7. package/agents/debugger.md +2 -2
  8. package/agents/designer.md +2 -2
  9. package/agents/devops-engineer.md +2 -2
  10. package/agents/docs-manager.md +23 -15
  11. package/agents/frontend-engineer.md +3 -3
  12. package/agents/game-engineer.md +3 -3
  13. package/agents/mobile-engineer.md +4 -4
  14. package/agents/performance-engineer.md +3 -3
  15. package/agents/planner.md +4 -4
  16. package/agents/project-manager.md +3 -3
  17. package/agents/researcher.md +3 -3
  18. package/agents/reviewer.md +3 -3
  19. package/agents/scouter.md +3 -3
  20. package/agents/security-engineer.md +3 -3
  21. package/agents/tech-lead.md +3 -3
  22. package/agents/tester.md +2 -2
  23. package/code-assistants/codex-assistant/CODEX.md +1 -2
  24. package/commands/ask/hard.md +1 -1
  25. package/commands/brainstorm/hard.md +1 -1
  26. package/commands/code/hard.md +1 -1
  27. package/commands/code.md +2 -7
  28. package/commands/cook/hard.md +1 -1
  29. package/commands/cook.md +1 -6
  30. package/commands/debug/hard.md +1 -1
  31. package/commands/debug.md +1 -6
  32. package/commands/design/hard.md +1 -1
  33. package/commands/design.md +1 -6
  34. package/commands/docs/audit.md +554 -78
  35. package/commands/docs/business.md +392 -76
  36. package/commands/docs/core.md +573 -74
  37. package/commands/docs.md +62 -61
  38. package/commands/fix/hard.md +1 -1
  39. package/commands/fix.md +1 -6
  40. package/commands/plan/hard.md +1 -1
  41. package/commands/plan.md +1 -6
  42. package/commands/report/fast.md +2 -2
  43. package/commands/report/hard.md +1 -1
  44. package/commands/report.md +2 -7
  45. package/commands/review/hard.md +1 -1
  46. package/commands/test/hard.md +1 -1
  47. package/commands/test.md +1 -6
  48. package/documents/HSOL-ASSESSMENT.md +6 -6
  49. package/documents/SMART-SKILL-ORCHESTRATION-BLUEPRINT.md +1 -1
  50. package/documents/business/business-features/00-index.md +101 -0
  51. package/documents/business/business-features/01-feature-inventory.md +341 -0
  52. package/documents/business/business-features/02-prioritization-moscow.md +148 -0
  53. package/documents/business/business-features/03-feature-specifications.md +511 -0
  54. package/documents/business/business-features/04-dependencies-and-release-sequencing.md +313 -0
  55. package/documents/business/business-features/05-success-metrics.md +290 -0
  56. package/documents/business/business-glossary/00-index.md +89 -0
  57. package/documents/business/business-glossary/01-canonical-terms.md +428 -0
  58. package/documents/business/business-glossary/02-synonyms-and-deprecated-terms.md +180 -0
  59. package/documents/business/business-glossary/03-domain-entities-and-events.md +395 -0
  60. package/documents/business/business-glossary/04-api-term-mapping.md +173 -0
  61. package/documents/business/business-prd/00-index.md +107 -0
  62. package/documents/business/business-prd/01-executive-summary.md +131 -0
  63. package/documents/business/business-prd/02-problem-goals-and-scope.md +204 -0
  64. package/documents/business/business-prd/03-stakeholders-and-requirements.md +210 -0
  65. package/documents/business/business-prd/04-acceptance-risks-assumptions.md +246 -0
  66. package/documents/business/business-workflows/00-index.md +107 -0
  67. package/documents/business/business-workflows/01-actor-map.md +303 -0
  68. package/documents/business/business-workflows/02-workflow-catalog.md +252 -0
  69. package/documents/business/business-workflows/03-detailed-workflows.md +641 -0
  70. package/documents/business/business-workflows/04-decision-rules-and-exceptions.md +216 -0
  71. package/documents/business/business-workflows/05-sla-and-handoffs.md +253 -0
  72. package/documents/knowledge-architecture/00-index.md +159 -0
  73. package/documents/knowledge-architecture/01-system-overview.md +240 -0
  74. package/documents/knowledge-architecture/02-components.md +419 -0
  75. package/documents/knowledge-architecture/03-data-flow.md +368 -0
  76. package/documents/knowledge-architecture/04-design-patterns.md +497 -0
  77. package/documents/knowledge-architecture/05-decisions.md +410 -0
  78. package/documents/knowledge-domain/00-index.md +251 -0
  79. package/documents/knowledge-domain/01-entities.md +582 -0
  80. package/documents/knowledge-domain/02-database-schema.md +138 -0
  81. package/documents/knowledge-domain/03-api-contracts.md +477 -0
  82. package/documents/knowledge-domain/04-business-rules.md +554 -0
  83. package/documents/knowledge-overview/00-index.md +107 -0
  84. package/documents/knowledge-overview/01-project-identity.md +162 -0
  85. package/documents/knowledge-overview/02-tech-stack.md +119 -0
  86. package/documents/knowledge-overview/03-features.md +232 -0
  87. package/documents/knowledge-overview/04-getting-started.md +394 -0
  88. package/documents/knowledge-source-base/00-index.md +107 -0
  89. package/documents/knowledge-source-base/01-directory-structure.md +312 -0
  90. package/documents/knowledge-source-base/02-entry-points.md +346 -0
  91. package/documents/knowledge-source-base/03-key-modules.md +581 -0
  92. package/documents/knowledge-source-base/04-configuration.md +467 -0
  93. package/documents/knowledge-standards/00-index.md +129 -0
  94. package/documents/knowledge-standards/01-code-style.md +161 -0
  95. package/documents/knowledge-standards/02-conventions.md +254 -0
  96. package/documents/knowledge-standards/03-git-workflow.md +228 -0
  97. package/documents/knowledge-standards/04-testing-standards.md +175 -0
  98. package/matrix-skills/_index.yaml +1 -1
  99. package/package.json +1 -1
  100. package/rules/AGENTS.md +1 -1
  101. package/rules/REFERENCE.md +18 -14
  102. package/rules/SKILLS.md +1 -1
  103. package/rules/TEAMS.md +1 -2
  104. package/skills/docs-audit/README.md +10 -8
  105. package/skills/docs-audit/SKILL.md +45 -41
  106. package/skills/docs-audit/references/scoring-framework.md +5 -5
  107. package/skills/docs-core/README.md +19 -14
  108. package/skills/docs-core/SKILL.md +189 -117
  109. package/skills/planning/references/codebase-understanding.md +5 -5
  110. package/code-assistants/codex-assistant/skills/agent-assistant-code-focus/SKILL.md +0 -18
  111. package/code-assistants/codex-assistant/skills/agent-assistant-code-focus/agents/openai.yaml +0 -4
  112. package/code-assistants/codex-assistant/skills/agent-assistant-cook-focus/SKILL.md +0 -18
  113. package/code-assistants/codex-assistant/skills/agent-assistant-cook-focus/agents/openai.yaml +0 -4
  114. package/code-assistants/codex-assistant/skills/agent-assistant-debug-focus/SKILL.md +0 -18
  115. package/code-assistants/codex-assistant/skills/agent-assistant-debug-focus/agents/openai.yaml +0 -4
  116. package/code-assistants/codex-assistant/skills/agent-assistant-design-focus/SKILL.md +0 -18
  117. package/code-assistants/codex-assistant/skills/agent-assistant-design-focus/agents/openai.yaml +0 -4
  118. package/code-assistants/codex-assistant/skills/agent-assistant-fix-focus/SKILL.md +0 -18
  119. package/code-assistants/codex-assistant/skills/agent-assistant-fix-focus/agents/openai.yaml +0 -4
  120. package/code-assistants/codex-assistant/skills/agent-assistant-plan-focus/SKILL.md +0 -18
  121. package/code-assistants/codex-assistant/skills/agent-assistant-plan-focus/agents/openai.yaml +0 -4
  122. package/code-assistants/codex-assistant/skills/agent-assistant-report-focus/SKILL.md +0 -18
  123. package/code-assistants/codex-assistant/skills/agent-assistant-report-focus/agents/openai.yaml +0 -4
  124. package/code-assistants/codex-assistant/skills/agent-assistant-test-focus/SKILL.md +0 -18
  125. package/code-assistants/codex-assistant/skills/agent-assistant-test-focus/agents/openai.yaml +0 -4
  126. package/commands/code/focus.md +0 -297
  127. package/commands/cook/focus.md +0 -209
  128. package/commands/debug/focus.md +0 -103
  129. package/commands/design/focus.md +0 -229
  130. package/commands/fix/focus.md +0 -145
  131. package/commands/plan/focus.md +0 -140
  132. package/commands/report/focus.md +0 -107
  133. package/commands/test/focus.md +0 -123
  134. package/documents/business/business-features.md +0 -894
  135. package/documents/business/business-glossary.md +0 -554
  136. package/documents/business/business-prd.md +0 -400
  137. package/documents/business/business-workflows.md +0 -713
  138. package/documents/knowledge-architecture.md +0 -621
  139. package/documents/knowledge-domain.md +0 -602
  140. package/documents/knowledge-overview.md +0 -316
  141. package/documents/knowledge-source-base.md +0 -581
  142. package/documents/knowledge-standards.md +0 -632
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  name: docs-core
3
- description: "Generate or update the 5 core project knowledge documents (overview, architecture, domain, source-base, standards) in ./documents/. Performs autonomous codebase scanning, gap analysis, and produces enterprise-grade documentation for rapid onboarding. Use when user says 'generate docs', 'update docs', 'create project documentation', 'docs-core', '/docs-core', 'onboarding docs', or wants to create/refresh the knowledge base."
3
+ description: "Generate or update the 5 core project knowledge **folders** (overview, architecture, domain, source-base, standards) in ./documents/. Each knowledge area is a folder with 00-index.md + numbered sub-files. Performs autonomous codebase scanning, gap analysis, and produces enterprise-grade documentation for rapid onboarding. Use when user says 'generate docs', 'update docs', 'create project documentation', 'docs-core', '/docs-core', 'onboarding docs', or wants to create/refresh the knowledge base."
4
4
  metadata:
5
- version: 1.0.0
5
+ version: 2.0.0
6
6
  ---
7
7
 
8
- # Docs-Core — Core Project Documentation Generator
8
+ # Docs-Core — Core Project Documentation Generator (v2.0 Folder-Based)
9
9
 
10
- > **Mission**: Autonomously scan a codebase and produce (or update) **ALL 5** core knowledge documents at the highest quality standard. Every document must enable a new team member to fully understand the project's architecture and business domain in minimal time.
10
+ > **Mission**: Autonomously scan a codebase and produce (or update) **ALL 5** core knowledge **folders** at the highest quality standard. Each folder contains `00-index.md` + numbered sub-files. Every document must enable a new team member to fully understand the project's architecture and business domain in minimal time.
11
11
 
12
12
  ---
13
13
 
@@ -15,8 +15,8 @@ metadata:
15
15
 
16
16
  Intelligent documentation engine. It handles two modes:
17
17
 
18
- - **CREATE** — Generate documents from scratch when `./documents/` is empty or files are missing.
19
- - **UPDATE** — Incrementally enrich existing documents by appending new content and correcting stale sections, **without discarding valuable existing context**.
18
+ - **CREATE** — Generate folder structure from scratch when `./documents/` is empty or knowledge folders are missing.
19
+ - **UPDATE** — Incrementally enrich existing folders/sub-files by appending new content and correcting stale sections, **without discarding valuable existing context**.
20
20
 
21
21
  All output files are written in **English only** regardless of the user's language.
22
22
 
@@ -34,17 +34,83 @@ All output files are written in **English only** regardless of the user's langua
34
34
 
35
35
  ---
36
36
 
37
- ## Deliverables
37
+ ## Deliverables — Folder-Based Structure (v2.0)
38
38
 
39
- | # | File | Purpose |
40
- |---|------|---------|
41
- | 1 | `./documents/knowledge-overview.md` | Project identity, goals, tech stack, getting started |
42
- | 2 | `./documents/knowledge-architecture.md` | System design, components, data flow, design patterns |
43
- | 3 | `./documents/knowledge-domain.md` | Data models, schemas, API contracts, business rules |
44
- | 4 | `./documents/knowledge-source-base.md` | Directory tree, file purposes, entry points, modules |
45
- | 5 | `./documents/knowledge-standards.md` | Code style, naming, commit format, PR guidelines |
39
+ Each knowledge area is a **folder** containing `00-index.md` (summary + TOC) and numbered sub-files:
46
40
 
47
- **Failure condition**: If fewer than 5 files are produced, the execution is **INCOMPLETE**.
41
+ ```
42
+ ./documents/
43
+ knowledge-overview/
44
+ 00-index.md # Project identity summary + TOC linking sub-files
45
+ 01-project-identity.md
46
+ 02-tech-stack.md
47
+ 03-features.md
48
+ 04-getting-started.md
49
+ knowledge-architecture/
50
+ 00-index.md # Architecture summary + TOC linking sub-files
51
+ 01-system-overview.md
52
+ 02-components.md
53
+ 03-data-flow.md
54
+ 04-design-patterns.md
55
+ 05-decisions.md
56
+ knowledge-domain/
57
+ 00-index.md # Domain summary + TOC linking sub-files
58
+ 01-entities.md
59
+ 02-database-schema.md
60
+ 03-api-contracts.md
61
+ 04-business-rules.md
62
+ knowledge-source-base/
63
+ 00-index.md # Source map summary + TOC linking sub-files
64
+ 01-directory-structure.md
65
+ 02-entry-points.md
66
+ 03-key-modules.md
67
+ 04-configuration.md
68
+ knowledge-standards/
69
+ 00-index.md # Standards summary + TOC linking sub-files
70
+ 01-code-style.md
71
+ 02-conventions.md
72
+ 03-git-workflow.md
73
+ 04-testing-standards.md
74
+ ```
75
+
76
+ **Minimum**: 5 folders x (1 index + 4 sub-files) = **25 files minimum**.
77
+ **Failure condition**: If fewer than 5 folders are produced, or any folder is missing `00-index.md`, the execution is **INCOMPLETE**.
78
+
79
+ ### `00-index.md` Pattern
80
+
81
+ Every `00-index.md` MUST follow this structure:
82
+
83
+ ```markdown
84
+ # {Knowledge Area Title}
85
+
86
+ > **Purpose**: {one-line purpose}
87
+ > **Sub-files**: {count}
88
+ > **Last Updated**: {YYYY-MM-DD}
89
+
90
+ ## Quick Summary
91
+ {2-3 paragraph executive summary of this knowledge area}
92
+
93
+ ## Sub-Files
94
+
95
+ | # | File | Description |
96
+ |---|------|-------------|
97
+ | 01 | [01-file-name.md](./01-file-name.md) | Brief description |
98
+ | 02 | [02-file-name.md](./02-file-name.md) | Brief description |
99
+ ...
100
+
101
+ ## Cross-References
102
+ - Related: [knowledge-architecture/00-index.md](../knowledge-architecture/00-index.md)
103
+ ...
104
+ ```
105
+
106
+ ### Scaling Rules
107
+
108
+ | Condition | Action |
109
+ |-----------|--------|
110
+ | Sub-file exceeds ~300 lines | Split into two numbered sub-files |
111
+ | Sub-file has < 20 lines of real content | Merge into adjacent sub-file |
112
+ | New major topic discovered | Add new numbered sub-file at end (e.g., `05-new-topic.md`) |
113
+ | `00-index.md` TOC out of sync | Update TOC to match actual sub-files |
48
114
 
49
115
  ---
50
116
 
@@ -57,27 +123,27 @@ BEFORE any work:
57
123
  1. Confirm ./documents/ directory exists (create if missing)
58
124
  2. Load templates directly from `skills/docs-core/references/` (read-only, in place)
59
125
  3. Do not create or persist template copies under `./documents/templates/`
60
- 4. Check which of the 5 files already exist
61
- 5. Determine execution mode per file:
62
- - File missing CREATE mode
63
- - File exists UPDATE mode
64
- 6. Log the execution plan
126
+ 4. Check which of the 5 knowledge FOLDERS already exist
127
+ 5. Check for legacy flat files (v1.0) and plan migration if found
128
+ 6. Determine execution mode per folder:
129
+ - Folder missing CREATE mode
130
+ - Folder exists → UPDATE mode (check sub-files individually)
131
+ - Flat file exists, no folder → MIGRATE mode
132
+ 7. Log the execution plan
65
133
  ```
66
134
 
67
135
  **Output**:
68
136
  ```markdown
69
- 📋 Docs-Core Execution Plan
70
- | File | Status | Mode |
71
- |------|--------|------|
72
- | knowledge-overview.md | Exists / Missing | UPDATE / CREATE |
73
- | knowledge-architecture.md | Exists / Missing | UPDATE / CREATE |
74
- | knowledge-domain.md | Exists / Missing | UPDATE / CREATE |
75
- | knowledge-source-base.md | Exists / Missing | UPDATE / CREATE |
76
- | knowledge-standards.md | Exists / Missing | UPDATE / CREATE |
77
-
78
- 📚 Template Source
79
- - Source: `skills/docs-core/references/*.md`
80
- - Mode: read-only, no copy
137
+ ## Docs-Core Execution Plan
138
+ | Knowledge Area | Status | Mode |
139
+ |----------------|--------|------|
140
+ | knowledge-overview/ | Folder exists / Missing / Flat file only | UPDATE / CREATE / MIGRATE |
141
+ | knowledge-architecture/ | Folder exists / Missing / Flat file only | UPDATE / CREATE / MIGRATE |
142
+ | knowledge-domain/ | Folder exists / Missing / Flat file only | UPDATE / CREATE / MIGRATE |
143
+ | knowledge-source-base/ | Folder exists / Missing / Flat file only | UPDATE / CREATE / MIGRATE |
144
+ | knowledge-standards/ | Folder exists / Missing / Flat file only | UPDATE / CREATE / MIGRATE |
145
+
146
+ Template Source: `skills/docs-core/references/*.md` (read-only, no copy)
81
147
  ```
82
148
 
83
149
  ---
@@ -96,7 +162,7 @@ If any of these 4 parts is skipped, documentation is considered incomplete.
96
162
 
97
163
  **1.1 — Structure Scan**:
98
164
  - List all top-level directories and files.
99
- - Recursively map the directory tree (depth 34 levels).
165
+ - Recursively map the directory tree (depth 3-4 levels).
100
166
  - Identify entry points: `main.*`, `index.*`, `app.*`, `server.*`, `package.json`, `Makefile`, `Dockerfile`, etc.
101
167
 
102
168
  Minimum direct-read set (must read content, not only file names):
@@ -161,88 +227,100 @@ Required targeted search passes (minimum):
161
227
 
162
228
  ### Step 2: Gap Analysis (UPDATE mode only)
163
229
 
164
- When existing documents are found, perform a diff-aware analysis:
230
+ When existing knowledge folders are found, perform a diff-aware analysis:
165
231
 
166
232
  ```
167
- FOR each existing document:
168
- 1. READ the current content completely.
233
+ FOR each existing knowledge folder:
234
+ 1. READ 00-index.md and all sub-files completely.
169
235
  2. COMPARE against reconnaissance findings.
170
- 3. IDENTIFY:
236
+ 3. IDENTIFY per sub-file:
171
237
  a. Stale sections — info no longer matching codebase
172
238
  b. Missing sections — new components/features not documented
173
239
  c. Accurate sections — still correct, DO NOT TOUCH
174
240
  4. PLAN targeted edits:
175
- - APPEND new sections for new discoveries
241
+ - APPEND new content to existing sub-files
242
+ - ADD new numbered sub-files for newly discovered topics
176
243
  - REVISE stale paragraphs with corrected info
177
244
  - PRESERVE all existing context that remains valid
245
+ - UPDATE 00-index.md TOC if sub-files changed
178
246
  ```
179
247
 
180
248
  **UPDATE Rules**:
181
- - **NEVER** delete existing sections that are still accurate.
182
- - **AVOID** rewriting from scratch in UPDATE mode.
183
- - **ALLOW** controlled rewrite only when file is structurally broken or over 70% stale.
249
+ - **NEVER** delete existing sub-files or sections that are still accurate.
250
+ - **AVOID** rewriting sub-files from scratch in UPDATE mode.
251
+ - **ALLOW** controlled rewrite only when a sub-file is structurally broken or over 70% stale.
184
252
  - For controlled rewrite, preserve still-valid legacy context under `## Legacy Notes (Preserved Context)`.
185
253
  - **ALWAYS** add a changelog entry at the bottom: `> Last updated: {date} — {summary of changes}`.
186
254
  - **PREFER** appending new subsections over modifying existing ones.
187
255
  - Mark newly added sections with: `<!-- Added: {date} -->` HTML comment.
256
+ - **ALWAYS** update `00-index.md` TOC when sub-files are added, removed, or renamed.
188
257
 
189
258
  ---
190
259
 
191
260
  ### Step 3: Content Generation (Thinking Protocol)
192
261
 
193
- For each of the 5 documents, apply this thinking protocol **before** writing:
262
+ For each of the 5 knowledge folders, apply this thinking protocol **before** writing:
194
263
 
195
264
  ```
196
265
  THINK:
197
266
  1. WHO is the reader? → New developer, BA/PM, or AI agent.
198
- 2. WHAT must they understand from this file alone?
199
- 3. WHAT data from reconnaissance supports each section?
267
+ 2. WHAT must they understand from this folder's files alone?
268
+ 3. WHAT data from reconnaissance supports each sub-file?
200
269
  4. Is every claim backed by actual code evidence?
201
270
  5. Is any section speculative? → Remove or mark as assumption.
202
271
  6. Would a new team member find this sufficient for their first day?
203
272
  7. Is the language professional, direct, and jargon-appropriate?
273
+ 8. Is content properly distributed across sub-files (no single file > ~300 lines)?
204
274
 
205
275
  VERIFY before writing:
206
276
  □ Every technical claim references actual files or patterns found
207
277
  □ No placeholder text ("TODO", "TBD", "fill in later")
208
- Table of Contents matches actual headings
278
+ 00-index.md TOC matches actual sub-files
209
279
  □ Mermaid diagrams (if used) are syntactically valid
210
280
  □ All file paths referenced actually exist in the project
211
281
  ```
212
282
 
213
- **Generation order** (each file builds on the previous):
214
- 1. `knowledge-source-base.md` — Foundation: where things are
215
- 2. `knowledge-overview.md` — Identity: what and why
216
- 3. `knowledge-architecture.md` — Design: how things connect
217
- 4. `knowledge-domain.md` — Data: what data flows through
218
- 5. `knowledge-standards.md` — Rules: how to contribute correctly
283
+ **Generation order** (each folder builds on the previous):
284
+ 1. `knowledge-source-base/` — Foundation: where things are
285
+ 2. `knowledge-overview/` — Identity: what and why
286
+ 3. `knowledge-architecture/` — Design: how things connect
287
+ 4. `knowledge-domain/` — Data: what data flows through
288
+ 5. `knowledge-standards/` — Rules: how to contribute correctly
289
+
290
+ **Per-folder execution order**:
291
+ 1. Create folder if missing
292
+ 2. Write `00-index.md` first (summary + planned TOC)
293
+ 3. Write numbered sub-files in order (`01-`, `02-`, ...)
294
+ 4. Verify `00-index.md` TOC links match actual sub-files
295
+ 5. Verify no sub-file exceeds ~300 lines
219
296
 
220
297
  **Onboarding-first requirements**:
221
- - Every generated file must include one subsection named `Onboarding Notes`.
222
- - `knowledge-overview.md` must include `First 60 Minutes` checklist.
223
- - `knowledge-source-base.md` must include `Read Order for New Members`.
298
+ - Every `00-index.md` must include a `Quick Summary` section.
299
+ - `knowledge-overview/01-project-identity.md` must include `First 60 Minutes` checklist.
300
+ - `knowledge-source-base/00-index.md` must include `Read Order for New Members`.
224
301
 
225
302
  ---
226
303
 
227
304
  ### Step 4: Write Documents
228
305
 
229
- For each document, follow the corresponding template structure from `references/`.
306
+ For each knowledge folder, follow the corresponding template structure from `references/`.
230
307
 
231
308
  **Writing rules**:
232
309
  - **Language**: English only. No exceptions.
233
310
  - **Tone**: Professional, direct, accessible to both business and technical readers.
234
311
  - **Format**: Standard Markdown with GFM extensions (tables, task lists, fenced code blocks).
235
- - **TOC**: Every file MUST begin with a Table of Contents after the title.
312
+ - **TOC**: Every `00-index.md` MUST list all sub-files with links.
236
313
  - **Diagrams**: Use Mermaid.js for flowcharts, entity relationships, and architecture diagrams where they add clarity by visualizing relationships that text alone cannot convey.
237
314
  - **Tables**: Use tables for structured data (APIs, config vars, file listings).
238
315
  - **Code blocks**: Use fenced code blocks with language identifiers.
239
316
  - **Headings**: H1 for title, H2 for major sections, H3 for subsections, H4 for details.
240
- - **Metadata header**: Every file starts with:
317
+ - **Metadata header**: Every sub-file starts with:
241
318
 
242
319
  ```markdown
243
320
  # {Project Name} — {Document Title}
244
321
 
245
322
  > **Purpose**: {one-line purpose statement}
323
+ > **Parent**: [00-index.md](./00-index.md)
246
324
  > **Last Updated**: {YYYY-MM-DD}
247
325
  > **Generated By**: docs-core skill
248
326
 
@@ -255,21 +333,23 @@ For each document, follow the corresponding template structure from `references/
255
333
  ...
256
334
  ```
257
335
 
258
- - **Evidence section**: Every file must include `## Evidence Sources` listing concrete files used.
259
- - **Known gaps section**: Every file must include `## Known Gaps and Open Questions`.
336
+ - **Evidence section**: Every sub-file must include `## Evidence Sources` listing concrete files used.
337
+ - **Known gaps section**: At minimum, `00-index.md` must include `## Known Gaps and Open Questions`.
260
338
 
261
339
  ---
262
340
 
263
341
  ### Step 5: Verification Checklist
264
342
 
265
- After generating all 5 files, verify:
343
+ After generating all 5 knowledge folders, verify:
266
344
 
267
345
  ```
268
346
  VERIFICATION MATRIX:
269
- | Check | knowledge-overview | knowledge-architecture | knowledge-domain | knowledge-source-base | knowledge-standards |
270
- |-------|-------------------|----------------------|-----------------|---------------------|-------------------|
271
- | File exists | □ | □ | □ | □ | □ |
272
- | TOC present | □ | □ | □ | □ | □ |
347
+ | Check | knowledge-overview/ | knowledge-architecture/ | knowledge-domain/ | knowledge-source-base/ | knowledge-standards/ |
348
+ |-------|--------------------|-----------------------|-------------------|----------------------|---------------------|
349
+ | Folder exists | □ | □ | □ | □ | □ |
350
+ | 00-index.md present | □ | □ | □ | □ | □ |
351
+ | All sub-files present | □ | □ | □ | □ | □ |
352
+ | TOC matches sub-files | □ | □ | □ | □ | □ |
273
353
  | No TODO/TBD | □ | □ | □ | □ | □ |
274
354
  | English only | □ | □ | □ | □ | □ |
275
355
  | Minimum sections | □ | □ | □ | □ | □ |
@@ -277,20 +357,21 @@ VERIFICATION MATRIX:
277
357
  | Diagrams render | □ | □ | □ | □ | □ |
278
358
  | Professional tone | □ | □ | □ | □ | □ |
279
359
  | Evidence Sources present | □ | □ | □ | □ | □ |
280
- | Known gaps section present | □ | □ | □ | □ | □ |
360
+ | No sub-file > ~300 lines | □ | □ | □ | □ | □ |
281
361
  ```
282
362
 
283
- **Minimum section requirements per file**:
284
- - `knowledge-overview.md`: 6 sections (Identity, Purpose, Tech Stack, Features, Quick Start, Configuration)
285
- - `knowledge-architecture.md`: 5 sections (Overview, Components, Data Flow, Patterns, Dependencies)
286
- - `knowledge-domain.md`: 5 sections (Entities, Relationships, Schema, API Contracts, Business Rules)
287
- - `knowledge-source-base.md`: 4 sections (Root Structure, Directory Breakdown, Entry Points, Key Files)
288
- - `knowledge-standards.md`: 5 sections (Naming, Style, Commit Format, PR Guidelines, Testing)
363
+ **Minimum sub-file requirements per folder**:
364
+ - `knowledge-overview/`: >= 4 sub-files (Project Identity, Tech Stack, Features, Getting Started)
365
+ - `knowledge-architecture/`: >= 5 sub-files (System Overview, Components, Data Flow, Design Patterns, Decisions)
366
+ - `knowledge-domain/`: >= 4 sub-files (Entities, Database Schema, API Contracts, Business Rules)
367
+ - `knowledge-source-base/`: >= 4 sub-files (Directory Structure, Entry Points, Key Modules, Configuration)
368
+ - `knowledge-standards/`: >= 4 sub-files (Code Style, Conventions, Git Workflow, Testing Standards)
289
369
 
290
370
  **Coverage quality gates**:
291
371
  - Every major section must be backed by at least one explicit evidence file.
292
- - No document may contain unresolved placeholders.
372
+ - No sub-file may contain unresolved placeholders.
293
373
  - If confidence is low for a section, mark confidence and list follow-up actions.
374
+ - `00-index.md` TOC MUST match actual sub-files (no phantom links, no unlisted files).
294
375
 
295
376
  ---
296
377
 
@@ -299,25 +380,27 @@ VERIFICATION MATRIX:
299
380
  Present the final status to the user:
300
381
 
301
382
  ```markdown
302
- ## Docs-Core Complete
303
-
304
- ### 📦 Deliverables
305
- | # | File | Mode | Status |
306
- |---|------|------|--------|
307
- | 1 | ./documents/knowledge-overview.md | CREATE/UPDATE | |
308
- | 2 | ./documents/knowledge-architecture.md | CREATE/UPDATE | |
309
- | 3 | ./documents/knowledge-domain.md | CREATE/UPDATE | |
310
- | 4 | ./documents/knowledge-source-base.md | CREATE/UPDATE | |
311
- | 5 | ./documents/knowledge-standards.md | CREATE/UPDATE | |
312
-
313
- ### 📊 Coverage Summary
383
+ ## Docs-Core Complete
384
+
385
+ ### Deliverables
386
+ | # | Folder | Sub-Files | Mode | Status |
387
+ |---|--------|-----------|------|--------|
388
+ | 1 | ./documents/knowledge-overview/ | 00-index + 4 sub-files | CREATE/UPDATE | Done |
389
+ | 2 | ./documents/knowledge-architecture/ | 00-index + 5 sub-files | CREATE/UPDATE | Done |
390
+ | 3 | ./documents/knowledge-domain/ | 00-index + 4 sub-files | CREATE/UPDATE | Done |
391
+ | 4 | ./documents/knowledge-source-base/ | 00-index + 4 sub-files | CREATE/UPDATE | Done |
392
+ | 5 | ./documents/knowledge-standards/ | 00-index + 4 sub-files | CREATE/UPDATE | Done |
393
+
394
+ **Total files**: {count} (minimum 25)
395
+
396
+ ### Coverage Summary
314
397
  - Tech stack documented: {list}
315
398
  - Architecture patterns identified: {list}
316
399
  - Domain entities mapped: {count}
317
400
  - Source directories documented: {count}
318
401
  - Standards defined: {count}
319
402
 
320
- ### 📝 Next Steps
403
+ ### Next Steps
321
404
  - `/docs:business` — Generate business documentation
322
405
  - Review and customize generated docs for project-specific nuances
323
406
  ```
@@ -326,18 +409,18 @@ Present the final status to the user:
326
409
 
327
410
  ## Document Templates
328
411
 
329
- Detailed templates for each document are stored in `references/`. Load the relevant template when generating each file:
412
+ Detailed templates for each document are stored in `references/`. Load the relevant template when generating each folder's sub-files:
330
413
 
331
414
  | Template File | Produces |
332
415
  |---------------|----------|
333
- | `references/template-overview.md` | knowledge-overview.md |
334
- | `references/template-architecture.md` | knowledge-architecture.md |
335
- | `references/template-domain.md` | knowledge-domain.md |
336
- | `references/template-source-base.md` | knowledge-source-base.md |
337
- | `references/template-standards.md` | knowledge-standards.md |
416
+ | `references/template-overview.md` | knowledge-overview/ folder |
417
+ | `references/template-architecture.md` | knowledge-architecture/ folder |
418
+ | `references/template-domain.md` | knowledge-domain/ folder |
419
+ | `references/template-source-base.md` | knowledge-source-base/ folder |
420
+ | `references/template-standards.md` | knowledge-standards/ folder |
338
421
  | `references/deep-recon-checklist.md` | Mandatory deep reconnaissance checklist |
339
422
 
340
- **Usage**: Read the template → Fill sections with reconnaissance data → Write to `./documents/`.
423
+ **Usage**: Read the template → Create folder Write `00-index.md` + numbered sub-files → Write to `./documents/{knowledge-area}/`.
341
424
 
342
425
  ---
343
426
 
@@ -362,7 +445,7 @@ bash skills/docs-core/scripts/scan-project.sh [project-root]
362
445
 
363
446
  | Criterion | Requirement |
364
447
  |-----------|-------------|
365
- | **Completeness** | All 5 files produced with all required sections |
448
+ | **Completeness** | All 5 folders produced with 00-index.md + all required sub-files |
366
449
  | **Accuracy** | Every technical claim backed by actual code evidence |
367
450
  | **Freshness** | Content reflects current codebase state, not historical |
368
451
  | **Readability** | Understandable by both BA/PM and junior developers |
@@ -371,6 +454,7 @@ bash skills/docs-core/scripts/scan-project.sh [project-root]
371
454
  | **No Placeholders** | Zero TODO, TBD, or "fill in later" markers |
372
455
  | **Professional Tone** | Direct, clear, no filler, no marketing-speak |
373
456
  | **Update Safety** | UPDATE mode preserves existing valuable context |
457
+ | **Scalability** | No sub-file exceeds ~300 lines; split when needed |
374
458
 
375
459
  ### Quality Bar
376
460
 
@@ -387,12 +471,12 @@ bash skills/docs-core/scripts/scan-project.sh [project-root]
387
471
  User: Generate documentation for this project
388
472
 
389
473
  Docs-Core Process:
390
- 1. Pre-Flight: ./documents/ exists but all 5 files missing → CREATE mode
474
+ 1. Pre-Flight: ./documents/ exists but knowledge folders missing → CREATE mode
391
475
  2. Reconnaissance: Scan finds Next.js + Prisma + PostgreSQL monorepo
392
- 3. Generation order: source-base → overview → architecture → domain → standards
393
- 4. Write all 5 files with full templates
394
- 5. Verify: All checks pass
395
- 6. Report: 5/5 files created
476
+ 3. Generation order: source-base/ → overview/ → architecture/ → domain/ → standards/
477
+ 4. Per folder: create folder write 00-index.md → write numbered sub-files
478
+ 5. Verify: All checks pass, 25+ files created
479
+ 6. Report: 5/5 folders created (25+ total files)
396
480
  ```
397
481
 
398
482
  ### Example 2: Existing Project (UPDATE mode)
@@ -401,24 +485,12 @@ Docs-Core Process:
401
485
  User: Update the docs, we added a new module
402
486
 
403
487
  Docs-Core Process:
404
- 1. Pre-Flight: All 5 files exist → UPDATE mode
488
+ 1. Pre-Flight: All 5 folders exist → UPDATE mode
405
489
  2. Reconnaissance: Scan finds new `payments/` module with Stripe integration
406
- 3. Gap Analysis: knowledge-architecture.md missing payments component,
407
- knowledge-domain.md missing PaymentIntent entity
408
- 4. Targeted edits: Append payments section to architecture, add entity to domain
409
- 5. Verify: All checks pass, existing content preserved
410
- 6. Report: 2/5 files updated, 3/5 unchanged
411
- ```
412
-
413
- ### Example 3: Partial Documentation (MIXED mode)
414
-
415
- ```
416
- User: Create docs for this repo
417
-
418
- Docs-Core Process:
419
- 1. Pre-Flight: 2 files exist (overview, standards), 3 missing → MIXED mode
420
- 2. Scan codebase, read existing 2 files
421
- 3. CREATE 3 missing files, UPDATE 2 existing files if stale
422
- 4. Verify all 5 files complete
423
- 5. Report: 3 created, 2 updated
490
+ 3. Gap Analysis: knowledge-architecture/02-components.md missing payments component,
491
+ knowledge-domain/01-entities.md missing PaymentIntent entity
492
+ 4. Targeted edits: Append payments section to architecture sub-file, add entity to domain sub-file
493
+ 5. Update affected 00-index.md files if new sub-files were added
494
+ 6. Verify: All checks pass, existing content preserved
495
+ 7. Report: 2 sub-files updated, rest unchanged
424
496
  ```
@@ -21,11 +21,11 @@ ALWAYS read these files first when they exist under `./documents/`:
21
21
  - Development rules and best practices
22
22
  - Code quality standards & Security guidelines
23
23
 
24
- 2. **`./documents/knowledge-overview.md`** — Project purpose, goals, tech stack, getting started
25
- 3. **`./documents/knowledge-architecture.md`** — System design, components, data flow, patterns
26
- 4. **`./documents/knowledge-source-base.md`** — Project structure, modules, entry points
27
- 5. **`./documents/knowledge-domain.md`** — Data models, API contracts, domain entities
28
- 6. **`./documents/knowledge-standards.md`** — Coding conventions, naming, commit format
24
+ 2. **`./documents/knowledge-overview/00-index.md`** — Project purpose, goals, tech stack, getting started (drill into sub-files as needed)
25
+ 3. **`./documents/knowledge-architecture/00-index.md`** — System design, components, data flow, patterns (drill into sub-files as needed)
26
+ 4. **`./documents/knowledge-source-base/00-index.md`** — Project structure, modules, entry points (drill into sub-files as needed)
27
+ 5. **`./documents/knowledge-domain/00-index.md`** — Data models, API contracts, domain entities (drill into sub-files as needed)
28
+ 6. **`./documents/knowledge-standards/00-index.md`** — Coding conventions, naming, commit format (drill into sub-files as needed)
29
29
  7. **`./docs/design-guidelines.md`** (if exists) — Design system, branding, UI/UX
30
30
  - Design system guidelines
31
31
  - Branding and UI/UX conventions
@@ -1,18 +0,0 @@
1
- ---
2
- name: agent-assistant-code-focus
3
- description: "🔒 Focused Development — Full cycle with enforced context optimization. Use when user types /code:focus."
4
- ---
5
-
6
- # /code:focus
7
-
8
- > Activates Agent Assistant `/code:focus` workflow.
9
-
10
- ## Rules
11
-
12
- 1. **Load first**: `~/.codex/skills/agent-assistant/rules/CORE.md` — follow all 10 Laws
13
- 2. **Agents**: Spawn via Codex native multi-agent (`~/.codex/agents/`)
14
- 3. **Skills**: Resolve from `~/.codex/skills/agent-assistant/matrix-skills/`
15
-
16
- ## Workflow
17
-
18
- **Load and follow**: `~/.codex/skills/agent-assistant/commands/code/focus.md`
@@ -1,4 +0,0 @@
1
- display_name: "/code:focus"
2
- short_description: "🔒 Focused Development — Full cycle with enforced context optimization"
3
- brand_color: "#6366F1"
4
- allow_implicit_invocation: true
@@ -1,18 +0,0 @@
1
- ---
2
- name: agent-assistant-cook-focus
3
- description: "🔒 Focused Feature — Complete development with enforced context optimization. Use when user types /cook:focus."
4
- ---
5
-
6
- # /cook:focus
7
-
8
- > Activates Agent Assistant `/cook:focus` workflow.
9
-
10
- ## Rules
11
-
12
- 1. **Load first**: `~/.codex/skills/agent-assistant/rules/CORE.md` — follow all 10 Laws
13
- 2. **Agents**: Spawn via Codex native multi-agent (`~/.codex/agents/`)
14
- 3. **Skills**: Resolve from `~/.codex/skills/agent-assistant/matrix-skills/`
15
-
16
- ## Workflow
17
-
18
- **Load and follow**: `~/.codex/skills/agent-assistant/commands/cook/focus.md`
@@ -1,4 +0,0 @@
1
- display_name: "/cook:focus"
2
- short_description: "🔒 Focused Feature — Complete development with enforced context optimization"
3
- brand_color: "#6366F1"
4
- allow_implicit_invocation: true
@@ -1,18 +0,0 @@
1
- ---
2
- name: agent-assistant-debug-focus
3
- description: "🔒 Focused Debug — Deep investigation with enforced context optimization. Use when user types /debug:focus."
4
- ---
5
-
6
- # /debug:focus
7
-
8
- > Activates Agent Assistant `/debug:focus` workflow.
9
-
10
- ## Rules
11
-
12
- 1. **Load first**: `~/.codex/skills/agent-assistant/rules/CORE.md` — follow all 10 Laws
13
- 2. **Agents**: Spawn via Codex native multi-agent (`~/.codex/agents/`)
14
- 3. **Skills**: Resolve from `~/.codex/skills/agent-assistant/matrix-skills/`
15
-
16
- ## Workflow
17
-
18
- **Load and follow**: `~/.codex/skills/agent-assistant/commands/debug/focus.md`
@@ -1,4 +0,0 @@
1
- display_name: "/debug:focus"
2
- short_description: "🔒 Focused Debug — Deep investigation with enforced context optimization"
3
- brand_color: "#EF4444"
4
- allow_implicit_invocation: true
@@ -1,18 +0,0 @@
1
- ---
2
- name: agent-assistant-design-focus
3
- description: "🔒 Focused Design — Complete design with enforced context optimization. Use when user types /design:focus."
4
- ---
5
-
6
- # /design:focus
7
-
8
- > Activates Agent Assistant `/design:focus` workflow.
9
-
10
- ## Rules
11
-
12
- 1. **Load first**: `~/.codex/skills/agent-assistant/rules/CORE.md` — follow all 10 Laws
13
- 2. **Agents**: Spawn via Codex native multi-agent (`~/.codex/agents/`)
14
- 3. **Skills**: Resolve from `~/.codex/skills/agent-assistant/matrix-skills/`
15
-
16
- ## Workflow
17
-
18
- **Load and follow**: `~/.codex/skills/agent-assistant/commands/design/focus.md`
@@ -1,4 +0,0 @@
1
- display_name: "/design:focus"
2
- short_description: "🔒 Focused Design — Complete design with enforced context optimization"
3
- brand_color: "#EC4899"
4
- allow_implicit_invocation: true
@@ -1,18 +0,0 @@
1
- ---
2
- name: agent-assistant-fix-focus
3
- description: "🔒 Focused Fix — Complete resolution with enforced context optimization. Use when user types /fix:focus."
4
- ---
5
-
6
- # /fix:focus
7
-
8
- > Activates Agent Assistant `/fix:focus` workflow.
9
-
10
- ## Rules
11
-
12
- 1. **Load first**: `~/.codex/skills/agent-assistant/rules/CORE.md` — follow all 10 Laws
13
- 2. **Agents**: Spawn via Codex native multi-agent (`~/.codex/agents/`)
14
- 3. **Skills**: Resolve from `~/.codex/skills/agent-assistant/matrix-skills/`
15
-
16
- ## Workflow
17
-
18
- **Load and follow**: `~/.codex/skills/agent-assistant/commands/fix/focus.md`
@@ -1,4 +0,0 @@
1
- display_name: "/fix:focus"
2
- short_description: "🔒 Focused Fix — Complete resolution with enforced context optimization"
3
- brand_color: "#EF4444"
4
- allow_implicit_invocation: true