@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.
- package/CHANGELOG.md +24 -1
- package/README.md +3 -4
- package/agents/backend-engineer.md +3 -3
- package/agents/brainstormer.md +3 -3
- package/agents/business-analyst.md +3 -3
- package/agents/database-architect.md +3 -3
- package/agents/debugger.md +2 -2
- package/agents/designer.md +2 -2
- package/agents/devops-engineer.md +2 -2
- package/agents/docs-manager.md +23 -15
- package/agents/frontend-engineer.md +3 -3
- package/agents/game-engineer.md +3 -3
- package/agents/mobile-engineer.md +4 -4
- package/agents/performance-engineer.md +3 -3
- package/agents/planner.md +4 -4
- package/agents/project-manager.md +3 -3
- package/agents/researcher.md +3 -3
- package/agents/reviewer.md +3 -3
- package/agents/scouter.md +3 -3
- package/agents/security-engineer.md +3 -3
- package/agents/tech-lead.md +3 -3
- package/agents/tester.md +2 -2
- package/code-assistants/codex-assistant/CODEX.md +1 -2
- package/commands/ask/hard.md +1 -1
- package/commands/brainstorm/hard.md +1 -1
- package/commands/code/hard.md +1 -1
- package/commands/code.md +2 -7
- package/commands/cook/hard.md +1 -1
- package/commands/cook.md +1 -6
- package/commands/debug/hard.md +1 -1
- package/commands/debug.md +1 -6
- package/commands/design/hard.md +1 -1
- package/commands/design.md +1 -6
- package/commands/docs/audit.md +554 -78
- package/commands/docs/business.md +392 -76
- package/commands/docs/core.md +573 -74
- package/commands/docs.md +62 -61
- package/commands/fix/hard.md +1 -1
- package/commands/fix.md +1 -6
- package/commands/plan/hard.md +1 -1
- package/commands/plan.md +1 -6
- package/commands/report/fast.md +2 -2
- package/commands/report/hard.md +1 -1
- package/commands/report.md +2 -7
- package/commands/review/hard.md +1 -1
- package/commands/test/hard.md +1 -1
- package/commands/test.md +1 -6
- package/documents/HSOL-ASSESSMENT.md +6 -6
- package/documents/SMART-SKILL-ORCHESTRATION-BLUEPRINT.md +1 -1
- package/documents/business/business-features/00-index.md +101 -0
- package/documents/business/business-features/01-feature-inventory.md +341 -0
- package/documents/business/business-features/02-prioritization-moscow.md +148 -0
- package/documents/business/business-features/03-feature-specifications.md +511 -0
- package/documents/business/business-features/04-dependencies-and-release-sequencing.md +313 -0
- package/documents/business/business-features/05-success-metrics.md +290 -0
- package/documents/business/business-glossary/00-index.md +89 -0
- package/documents/business/business-glossary/01-canonical-terms.md +428 -0
- package/documents/business/business-glossary/02-synonyms-and-deprecated-terms.md +180 -0
- package/documents/business/business-glossary/03-domain-entities-and-events.md +395 -0
- package/documents/business/business-glossary/04-api-term-mapping.md +173 -0
- package/documents/business/business-prd/00-index.md +107 -0
- package/documents/business/business-prd/01-executive-summary.md +131 -0
- package/documents/business/business-prd/02-problem-goals-and-scope.md +204 -0
- package/documents/business/business-prd/03-stakeholders-and-requirements.md +210 -0
- package/documents/business/business-prd/04-acceptance-risks-assumptions.md +246 -0
- package/documents/business/business-workflows/00-index.md +107 -0
- package/documents/business/business-workflows/01-actor-map.md +303 -0
- package/documents/business/business-workflows/02-workflow-catalog.md +252 -0
- package/documents/business/business-workflows/03-detailed-workflows.md +641 -0
- package/documents/business/business-workflows/04-decision-rules-and-exceptions.md +216 -0
- package/documents/business/business-workflows/05-sla-and-handoffs.md +253 -0
- package/documents/knowledge-architecture/00-index.md +159 -0
- package/documents/knowledge-architecture/01-system-overview.md +240 -0
- package/documents/knowledge-architecture/02-components.md +419 -0
- package/documents/knowledge-architecture/03-data-flow.md +368 -0
- package/documents/knowledge-architecture/04-design-patterns.md +497 -0
- package/documents/knowledge-architecture/05-decisions.md +410 -0
- package/documents/knowledge-domain/00-index.md +251 -0
- package/documents/knowledge-domain/01-entities.md +582 -0
- package/documents/knowledge-domain/02-database-schema.md +138 -0
- package/documents/knowledge-domain/03-api-contracts.md +477 -0
- package/documents/knowledge-domain/04-business-rules.md +554 -0
- package/documents/knowledge-overview/00-index.md +107 -0
- package/documents/knowledge-overview/01-project-identity.md +162 -0
- package/documents/knowledge-overview/02-tech-stack.md +119 -0
- package/documents/knowledge-overview/03-features.md +232 -0
- package/documents/knowledge-overview/04-getting-started.md +394 -0
- package/documents/knowledge-source-base/00-index.md +107 -0
- package/documents/knowledge-source-base/01-directory-structure.md +312 -0
- package/documents/knowledge-source-base/02-entry-points.md +346 -0
- package/documents/knowledge-source-base/03-key-modules.md +581 -0
- package/documents/knowledge-source-base/04-configuration.md +467 -0
- package/documents/knowledge-standards/00-index.md +129 -0
- package/documents/knowledge-standards/01-code-style.md +161 -0
- package/documents/knowledge-standards/02-conventions.md +254 -0
- package/documents/knowledge-standards/03-git-workflow.md +228 -0
- package/documents/knowledge-standards/04-testing-standards.md +175 -0
- package/matrix-skills/_index.yaml +1 -1
- package/package.json +1 -1
- package/rules/AGENTS.md +1 -1
- package/rules/REFERENCE.md +18 -14
- package/rules/SKILLS.md +1 -1
- package/rules/TEAMS.md +1 -2
- package/skills/docs-audit/README.md +10 -8
- package/skills/docs-audit/SKILL.md +45 -41
- package/skills/docs-audit/references/scoring-framework.md +5 -5
- package/skills/docs-core/README.md +19 -14
- package/skills/docs-core/SKILL.md +189 -117
- package/skills/planning/references/codebase-understanding.md +5 -5
- package/code-assistants/codex-assistant/skills/agent-assistant-code-focus/SKILL.md +0 -18
- package/code-assistants/codex-assistant/skills/agent-assistant-code-focus/agents/openai.yaml +0 -4
- package/code-assistants/codex-assistant/skills/agent-assistant-cook-focus/SKILL.md +0 -18
- package/code-assistants/codex-assistant/skills/agent-assistant-cook-focus/agents/openai.yaml +0 -4
- package/code-assistants/codex-assistant/skills/agent-assistant-debug-focus/SKILL.md +0 -18
- package/code-assistants/codex-assistant/skills/agent-assistant-debug-focus/agents/openai.yaml +0 -4
- package/code-assistants/codex-assistant/skills/agent-assistant-design-focus/SKILL.md +0 -18
- package/code-assistants/codex-assistant/skills/agent-assistant-design-focus/agents/openai.yaml +0 -4
- package/code-assistants/codex-assistant/skills/agent-assistant-fix-focus/SKILL.md +0 -18
- package/code-assistants/codex-assistant/skills/agent-assistant-fix-focus/agents/openai.yaml +0 -4
- package/code-assistants/codex-assistant/skills/agent-assistant-plan-focus/SKILL.md +0 -18
- package/code-assistants/codex-assistant/skills/agent-assistant-plan-focus/agents/openai.yaml +0 -4
- package/code-assistants/codex-assistant/skills/agent-assistant-report-focus/SKILL.md +0 -18
- package/code-assistants/codex-assistant/skills/agent-assistant-report-focus/agents/openai.yaml +0 -4
- package/code-assistants/codex-assistant/skills/agent-assistant-test-focus/SKILL.md +0 -18
- package/code-assistants/codex-assistant/skills/agent-assistant-test-focus/agents/openai.yaml +0 -4
- package/commands/code/focus.md +0 -297
- package/commands/cook/focus.md +0 -209
- package/commands/debug/focus.md +0 -103
- package/commands/design/focus.md +0 -229
- package/commands/fix/focus.md +0 -145
- package/commands/plan/focus.md +0 -140
- package/commands/report/focus.md +0 -107
- package/commands/test/focus.md +0 -123
- package/documents/business/business-features.md +0 -894
- package/documents/business/business-glossary.md +0 -554
- package/documents/business/business-prd.md +0 -400
- package/documents/business/business-workflows.md +0 -713
- package/documents/knowledge-architecture.md +0 -621
- package/documents/knowledge-domain.md +0 -602
- package/documents/knowledge-overview.md +0 -316
- package/documents/knowledge-source-base.md +0 -581
- 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
|
|
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:
|
|
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
|
|
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
|
|
19
|
-
- **UPDATE** — Incrementally enrich existing
|
|
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
|
-
|
|
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
|
-
|
|
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
|
|
61
|
-
5.
|
|
62
|
-
|
|
63
|
-
-
|
|
64
|
-
|
|
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
|
-
|
|
70
|
-
|
|
|
71
|
-
|
|
72
|
-
| knowledge-overview
|
|
73
|
-
| knowledge-architecture
|
|
74
|
-
| knowledge-domain
|
|
75
|
-
| knowledge-source-base
|
|
76
|
-
| knowledge-standards
|
|
77
|
-
|
|
78
|
-
|
|
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 3
|
|
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
|
|
230
|
+
When existing knowledge folders are found, perform a diff-aware analysis:
|
|
165
231
|
|
|
166
232
|
```
|
|
167
|
-
FOR each existing
|
|
168
|
-
1. READ
|
|
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
|
|
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
|
|
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
|
|
199
|
-
3. WHAT data from reconnaissance supports each
|
|
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
|
-
□
|
|
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
|
|
214
|
-
1. `knowledge-source-base
|
|
215
|
-
2. `knowledge-overview
|
|
216
|
-
3. `knowledge-architecture
|
|
217
|
-
4. `knowledge-domain
|
|
218
|
-
5. `knowledge-standards
|
|
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
|
|
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
|
|
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
|
|
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**:
|
|
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
|
|
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
|
-
|
|
|
272
|
-
|
|
|
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
|
-
|
|
|
360
|
+
| No sub-file > ~300 lines | □ | □ | □ | □ | □ |
|
|
281
361
|
```
|
|
282
362
|
|
|
283
|
-
**Minimum
|
|
284
|
-
- `knowledge-overview
|
|
285
|
-
- `knowledge-architecture
|
|
286
|
-
- `knowledge-domain
|
|
287
|
-
- `knowledge-source-base
|
|
288
|
-
- `knowledge-standards
|
|
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
|
|
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
|
-
##
|
|
303
|
-
|
|
304
|
-
###
|
|
305
|
-
| # |
|
|
306
|
-
|
|
307
|
-
| 1 | ./documents/knowledge-overview
|
|
308
|
-
| 2 | ./documents/knowledge-architecture
|
|
309
|
-
| 3 | ./documents/knowledge-domain
|
|
310
|
-
| 4 | ./documents/knowledge-source-base
|
|
311
|
-
| 5 | ./documents/knowledge-standards
|
|
312
|
-
|
|
313
|
-
|
|
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
|
-
###
|
|
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
|
|
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
|
|
334
|
-
| `references/template-architecture.md` | knowledge-architecture
|
|
335
|
-
| `references/template-domain.md` | knowledge-domain
|
|
336
|
-
| `references/template-source-base.md` | knowledge-source-base
|
|
337
|
-
| `references/template-standards.md` | knowledge-standards
|
|
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 →
|
|
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
|
|
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
|
|
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.
|
|
394
|
-
5. Verify: All checks pass
|
|
395
|
-
6. Report: 5/5
|
|
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
|
|
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.
|
|
410
|
-
6.
|
|
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,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,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,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,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`
|