@vpxa/aikit 0.1.65 → 0.1.66
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/package.json +1 -1
- package/packages/cli/dist/constants-D93JHBiN.js +1 -0
- package/packages/cli/dist/index.js +3 -3
- package/packages/cli/dist/{init-DBo2fDoM.js → init-DANkCO2c.js} +1 -1
- package/packages/cli/dist/{user-CXIL0rVI.js → user-Bb99C6xW.js} +1 -1
- package/scaffold/flows/_epilogue/steps/docs-sync/README.md +119 -119
- package/scaffold/general/skills/docs/SKILL.md +508 -508
- package/scaffold/general/skills/docs/references/diataxis-anti-patterns.md +146 -146
- package/scaffold/general/skills/docs/references/diataxis-compass.md +122 -122
- package/scaffold/general/skills/docs/references/diataxis-quadrants.md +191 -191
- package/scaffold/general/skills/docs/references/diataxis-quality.md +75 -75
- package/scaffold/general/skills/docs/references/diataxis-templates.md +119 -119
- package/scaffold/general/skills/docs/references/flow-artifacts-guide.md +69 -69
- package/scaffold/general/skills/docs/references/project-knowledge-gotchas.md +31 -31
- package/scaffold/general/skills/docs/references/project-knowledge-templates.md +280 -280
- package/scaffold/general/skills/docs/references/project-knowledge-workflow.md +79 -79
- package/packages/cli/dist/constants-BjDyZo-l.js +0 -1
|
@@ -1,80 +1,80 @@
|
|
|
1
|
-
# Project Knowledge — Workflow
|
|
2
|
-
|
|
3
|
-
Detailed workflow for acquiring and documenting project knowledge into `docs/architecture/`.
|
|
4
|
-
|
|
5
|
-
## Four-Phase Workflow
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
- [ ] Phase 1: Scan with AI Kit tools, read intent documents
|
|
9
|
-
- [ ] Phase 2: Investigate each documentation area
|
|
10
|
-
- [ ] Phase 3: Populate all seven docs in docs/architecture/
|
|
11
|
-
- [ ] Phase 4: Validate docs, present findings, resolve all [ASK USER] items
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
### Phase 1: Scan and Read Intent
|
|
15
|
-
|
|
16
|
-
```
|
|
17
|
-
onboard({ path: "." }) # Full codebase scan
|
|
18
|
-
produce_knowledge({ path: "." }) # Comprehensive analysis
|
|
19
|
-
analyze_structure({ path: "." }) # Project layout, packages, layers
|
|
20
|
-
analyze_dependencies({ path: "." }) # All dependencies + import graph
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
Then read `README`, `PRD`, `TRD`, `ROADMAP`, `SPEC`, `DESIGN` files if they exist.
|
|
24
|
-
Summarise the stated project intent before reading any source code.
|
|
25
|
-
|
|
26
|
-
### Phase 2: Investigate
|
|
27
|
-
|
|
28
|
-
Use Phase 1 tool outputs to answer questions for each of the seven documents. Run additional targeted tools:
|
|
29
|
-
|
|
30
|
-
| Document | Investigation Tools |
|
|
31
|
-
|----------|-------------------|
|
|
32
|
-
| stack.md | `analyze_dependencies` → manifests, frameworks; `analyze_structure` → runtime signals |
|
|
33
|
-
| structure.md | `analyze_structure` → file tree, packages; `analyze_entry_points` → entry points, key files |
|
|
34
|
-
| design.md | `analyze_structure` → layers; `analyze_patterns` → design patterns; `analyze_diagram` → component diagrams |
|
|
35
|
-
| conventions.md | `analyze_patterns` → naming, formatting; `search("conventions")` → detected conventions |
|
|
36
|
-
| integrations.md | `analyze_dependencies` → external deps; `search("API\|database\|auth\|webhook")` → integration points |
|
|
37
|
-
| testing.md | `analyze_patterns` → test patterns; `search("test framework")` → test setup; `test_run({})` → test health |
|
|
38
|
-
| concerns.md | `audit({ path: "." })` → health issues; `dead_symbols({})` → dead code; `git_context({})` → high-churn files |
|
|
39
|
-
|
|
40
|
-
### Phase 3: Populate Documents
|
|
41
|
-
|
|
42
|
-
Create each document in `docs/architecture/` in this order:
|
|
43
|
-
|
|
44
|
-
1. **stack.md** — Language, runtime version, frameworks, production dependencies, dev tooling
|
|
45
|
-
2. **structure.md** — Directory layout, entry points, key files, package organization
|
|
46
|
-
3. **design.md** — Layers, architectural patterns, data flow, component boundaries
|
|
47
|
-
4. **conventions.md** — Naming conventions, formatting rules, error handling patterns, import conventions
|
|
48
|
-
5. **integrations.md** — External APIs, databases, auth providers, monitoring, CI/CD
|
|
49
|
-
6. **testing.md** — Test frameworks, file organization, mocking strategy, coverage approach
|
|
50
|
-
7. **concerns.md** — Tech debt, known bugs, security risks, performance bottlenecks, high-churn files
|
|
51
|
-
|
|
52
|
-
Rules:
|
|
53
|
-
- Use `[TODO]` for anything that cannot be determined from code
|
|
54
|
-
- Use `[ASK USER]` where the right answer requires team intent
|
|
55
|
-
- Include an "Evidence" section in each doc with file paths and tool receipts
|
|
56
|
-
|
|
57
|
-
### Phase 4: Validate, Repair, Verify
|
|
58
|
-
|
|
59
|
-
Run this mandatory validation loop before finalizing:
|
|
60
|
-
|
|
61
|
-
1. For each non-trivial claim, confirm at least one evidence reference exists
|
|
62
|
-
2. If any required section is missing or unsupported → fix and re-validate
|
|
63
|
-
3. Repeat until all seven docs pass
|
|
64
|
-
|
|
65
|
-
Validation pass criteria:
|
|
66
|
-
- No unsupported claims
|
|
67
|
-
- No empty required sections
|
|
68
|
-
- Unknowns use `[TODO]` rather than assumptions
|
|
69
|
-
- Team-intent gaps are explicitly marked `[ASK USER]`
|
|
70
|
-
|
|
71
|
-
Then present a summary, list every `[ASK USER]` item as a numbered question, and highlight any Intent vs. Reality divergences from Phase 1.
|
|
72
|
-
|
|
73
|
-
## Focus Area Mode
|
|
74
|
-
|
|
75
|
-
If the user specifies a focus area (e.g., "architecture only" or "testing and concerns"):
|
|
76
|
-
|
|
77
|
-
1. Always run Phase 1 in full
|
|
78
|
-
2. Fully complete focus-area documents first
|
|
79
|
-
3. For non-focus documents, keep required sections present and mark unknowns as `[TODO]`
|
|
1
|
+
# Project Knowledge — Workflow
|
|
2
|
+
|
|
3
|
+
Detailed workflow for acquiring and documenting project knowledge into `docs/architecture/`.
|
|
4
|
+
|
|
5
|
+
## Four-Phase Workflow
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
- [ ] Phase 1: Scan with AI Kit tools, read intent documents
|
|
9
|
+
- [ ] Phase 2: Investigate each documentation area
|
|
10
|
+
- [ ] Phase 3: Populate all seven docs in docs/architecture/
|
|
11
|
+
- [ ] Phase 4: Validate docs, present findings, resolve all [ASK USER] items
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
### Phase 1: Scan and Read Intent
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
onboard({ path: "." }) # Full codebase scan
|
|
18
|
+
produce_knowledge({ path: "." }) # Comprehensive analysis
|
|
19
|
+
analyze_structure({ path: "." }) # Project layout, packages, layers
|
|
20
|
+
analyze_dependencies({ path: "." }) # All dependencies + import graph
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Then read `README`, `PRD`, `TRD`, `ROADMAP`, `SPEC`, `DESIGN` files if they exist.
|
|
24
|
+
Summarise the stated project intent before reading any source code.
|
|
25
|
+
|
|
26
|
+
### Phase 2: Investigate
|
|
27
|
+
|
|
28
|
+
Use Phase 1 tool outputs to answer questions for each of the seven documents. Run additional targeted tools:
|
|
29
|
+
|
|
30
|
+
| Document | Investigation Tools |
|
|
31
|
+
|----------|-------------------|
|
|
32
|
+
| stack.md | `analyze_dependencies` → manifests, frameworks; `analyze_structure` → runtime signals |
|
|
33
|
+
| structure.md | `analyze_structure` → file tree, packages; `analyze_entry_points` → entry points, key files |
|
|
34
|
+
| design.md | `analyze_structure` → layers; `analyze_patterns` → design patterns; `analyze_diagram` → component diagrams |
|
|
35
|
+
| conventions.md | `analyze_patterns` → naming, formatting; `search("conventions")` → detected conventions |
|
|
36
|
+
| integrations.md | `analyze_dependencies` → external deps; `search("API\|database\|auth\|webhook")` → integration points |
|
|
37
|
+
| testing.md | `analyze_patterns` → test patterns; `search("test framework")` → test setup; `test_run({})` → test health |
|
|
38
|
+
| concerns.md | `audit({ path: "." })` → health issues; `dead_symbols({})` → dead code; `git_context({})` → high-churn files |
|
|
39
|
+
|
|
40
|
+
### Phase 3: Populate Documents
|
|
41
|
+
|
|
42
|
+
Create each document in `docs/architecture/` in this order:
|
|
43
|
+
|
|
44
|
+
1. **stack.md** — Language, runtime version, frameworks, production dependencies, dev tooling
|
|
45
|
+
2. **structure.md** — Directory layout, entry points, key files, package organization
|
|
46
|
+
3. **design.md** — Layers, architectural patterns, data flow, component boundaries
|
|
47
|
+
4. **conventions.md** — Naming conventions, formatting rules, error handling patterns, import conventions
|
|
48
|
+
5. **integrations.md** — External APIs, databases, auth providers, monitoring, CI/CD
|
|
49
|
+
6. **testing.md** — Test frameworks, file organization, mocking strategy, coverage approach
|
|
50
|
+
7. **concerns.md** — Tech debt, known bugs, security risks, performance bottlenecks, high-churn files
|
|
51
|
+
|
|
52
|
+
Rules:
|
|
53
|
+
- Use `[TODO]` for anything that cannot be determined from code
|
|
54
|
+
- Use `[ASK USER]` where the right answer requires team intent
|
|
55
|
+
- Include an "Evidence" section in each doc with file paths and tool receipts
|
|
56
|
+
|
|
57
|
+
### Phase 4: Validate, Repair, Verify
|
|
58
|
+
|
|
59
|
+
Run this mandatory validation loop before finalizing:
|
|
60
|
+
|
|
61
|
+
1. For each non-trivial claim, confirm at least one evidence reference exists
|
|
62
|
+
2. If any required section is missing or unsupported → fix and re-validate
|
|
63
|
+
3. Repeat until all seven docs pass
|
|
64
|
+
|
|
65
|
+
Validation pass criteria:
|
|
66
|
+
- No unsupported claims
|
|
67
|
+
- No empty required sections
|
|
68
|
+
- Unknowns use `[TODO]` rather than assumptions
|
|
69
|
+
- Team-intent gaps are explicitly marked `[ASK USER]`
|
|
70
|
+
|
|
71
|
+
Then present a summary, list every `[ASK USER]` item as a numbered question, and highlight any Intent vs. Reality divergences from Phase 1.
|
|
72
|
+
|
|
73
|
+
## Focus Area Mode
|
|
74
|
+
|
|
75
|
+
If the user specifies a focus area (e.g., "architecture only" or "testing and concerns"):
|
|
76
|
+
|
|
77
|
+
1. Always run Phase 1 in full
|
|
78
|
+
2. Fully complete focus-area documents first
|
|
79
|
+
3. For non-focus documents, keep required sections present and mark unknowns as `[TODO]`
|
|
80
80
|
4. Still run the Phase 4 validation loop on all seven documents
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
const e=`aikit`,t={type:`stdio`,command:`npx`,args:[`-y`,`@vpxa/aikit`,`serve`]},n=[`aikit`,`brainstorming`,`multi-agents-development`,`session-handoff`,`requirements-clarity`,`lesson-learned`,`c4-architecture`,`adr-skill`,`present`,`frontend-design`,`react`,`typescript`],r=[`aikit-basic`,`aikit-advanced`,`_epilogue`],i={"chat.agentFilesLocations":{"~/.claude/agents":!1},"github.copilot.chat.copilotMemory.enabled":!0,"chat.customAgentInSubagent.enabled":!0,"chat.useNestedAgentsMdFiles":!0,"chat.useAgentSkills":!0,"github.copilot.chat.switchAgent.enabled":!0,"workbench.browser.enableChatTools":!0,"chat.mcp.apps.enabled":!0,"chat.instructionsFilesLocations":{"~/.copilot/instructions":!0,".github/instructions":!0}};export{i as a,n as i,t as n,e as r,r as t};
|