prizmkit 1.1.41 → 1.1.46
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/bundled/VERSION.json +3 -3
- package/bundled/adapters/claude/settings-adapter.js +4 -4
- package/bundled/adapters/codebuddy/settings-adapter.js +1 -1
- package/bundled/agents/prizm-dev-team-critic.md +9 -9
- package/bundled/agents/prizm-dev-team-dev.md +13 -13
- package/bundled/agents/prizm-dev-team-reviewer.md +2 -2
- package/bundled/dev-pipeline/.env.example +6 -6
- package/bundled/dev-pipeline/README.md +32 -32
- package/bundled/dev-pipeline/assets/prizm-dev-team-integration.md +1 -1
- package/bundled/dev-pipeline/launch-bugfix-daemon.sh +5 -2
- package/bundled/dev-pipeline/launch-feature-daemon.sh +5 -2
- package/bundled/dev-pipeline/launch-refactor-daemon.sh +5 -2
- package/bundled/dev-pipeline/lib/common.sh +34 -5
- package/bundled/dev-pipeline/reset-bug.sh +7 -5
- package/bundled/dev-pipeline/reset-feature.sh +7 -5
- package/bundled/dev-pipeline/reset-refactor.sh +7 -5
- package/bundled/dev-pipeline/run-bugfix.sh +14 -11
- package/bundled/dev-pipeline/run-feature.sh +15 -12
- package/bundled/dev-pipeline/run-recovery.sh +6 -3
- package/bundled/dev-pipeline/run-refactor.sh +15 -12
- package/bundled/dev-pipeline/scripts/generate-bootstrap-prompt.py +15 -15
- package/bundled/dev-pipeline/scripts/generate-bugfix-prompt.py +10 -5
- package/bundled/dev-pipeline/scripts/generate-recovery-prompt.py +19 -13
- package/bundled/dev-pipeline/scripts/generate-refactor-prompt.py +10 -5
- package/bundled/dev-pipeline/scripts/parse-stream-progress.py +1 -1
- package/bundled/dev-pipeline/scripts/update-bug-status.py +9 -1
- package/bundled/dev-pipeline/scripts/update-feature-status.py +13 -1
- package/bundled/dev-pipeline/scripts/update-refactor-status.py +9 -1
- package/bundled/dev-pipeline/templates/agent-prompts/critic-plan-challenge.md +1 -1
- package/bundled/dev-pipeline/templates/bootstrap-prompt.md +3 -3
- package/bundled/dev-pipeline/templates/bootstrap-tier1.md +8 -8
- package/bundled/dev-pipeline/templates/bootstrap-tier2.md +11 -11
- package/bundled/dev-pipeline/templates/bootstrap-tier3.md +9 -9
- package/bundled/dev-pipeline/templates/bugfix-bootstrap-prompt.md +7 -7
- package/bundled/dev-pipeline/templates/refactor-bootstrap-prompt.md +4 -4
- package/bundled/dev-pipeline/templates/sections/phase-commit-full.md +5 -5
- package/bundled/dev-pipeline/templates/sections/phase-commit.md +6 -6
- package/bundled/dev-pipeline/templates/sections/phase-context-snapshot-agent-suffix.md +1 -1
- package/bundled/dev-pipeline/templates/sections/phase-context-snapshot-base.md +1 -1
- package/bundled/dev-pipeline/templates/sections/phase-specify-plan-full.md +2 -2
- package/bundled/dev-pipeline/templates/sections/phase0-init.md +1 -1
- package/bundled/dev-pipeline/tests/test-path-resolution.sh +100 -0
- package/bundled/rules/USAGE.md +2 -2
- package/bundled/rules/_rules-metadata.json +1 -1
- package/bundled/rules/prizm/prizm-commit-workflow.md +1 -1
- package/bundled/rules/prizm/prizm-documentation.md +4 -4
- package/bundled/rules/prizm/prizm-progressive-loading.md +3 -3
- package/bundled/skills/_metadata.json +4 -4
- package/bundled/skills/app-planner/SKILL.md +35 -7
- package/bundled/skills/bug-fix-workflow/SKILL.md +6 -6
- package/bundled/skills/bug-planner/SKILL.md +5 -5
- package/bundled/skills/bugfix-pipeline-launcher/SKILL.md +28 -21
- package/bundled/skills/feature-pipeline-launcher/SKILL.md +28 -21
- package/bundled/skills/feature-planner/SKILL.md +5 -5
- package/bundled/skills/feature-workflow/SKILL.md +8 -8
- package/bundled/skills/prizm-kit/SKILL.md +10 -10
- package/bundled/skills/prizmkit-committer/SKILL.md +4 -2
- package/bundled/skills/prizmkit-implement/SKILL.md +2 -2
- package/bundled/skills/prizmkit-init/SKILL.md +17 -17
- package/bundled/skills/prizmkit-plan/SKILL.md +3 -3
- package/bundled/skills/prizmkit-plan/references/verification-checklist.md +2 -2
- package/bundled/skills/prizmkit-prizm-docs/SKILL.md +17 -17
- package/bundled/skills/prizmkit-prizm-docs/assets/prizm-docs-format.md +45 -45
- package/bundled/skills/prizmkit-prizm-docs/references/op-init.md +9 -9
- package/bundled/skills/prizmkit-prizm-docs/references/op-rebuild.md +1 -1
- package/bundled/skills/prizmkit-prizm-docs/references/op-status.md +2 -2
- package/bundled/skills/prizmkit-prizm-docs/references/op-update.md +3 -3
- package/bundled/skills/prizmkit-prizm-docs/references/op-validate.md +1 -1
- package/bundled/skills/prizmkit-retrospective/SKILL.md +10 -10
- package/bundled/skills/prizmkit-retrospective/references/knowledge-injection-steps.md +3 -3
- package/bundled/skills/prizmkit-retrospective/references/structural-sync-steps.md +1 -1
- package/bundled/skills/recovery-workflow/SKILL.md +15 -15
- package/bundled/skills/recovery-workflow/scripts/detect-recovery-state.py +0 -1
- package/bundled/skills/refactor-pipeline-launcher/SKILL.md +28 -21
- package/bundled/skills/refactor-planner/SKILL.md +6 -6
- package/bundled/skills/refactor-workflow/SKILL.md +9 -9
- package/bundled/team/prizm-dev-team.json +1 -1
- package/bundled/templates/hooks/commit-intent.json +2 -2
- package/bundled/templates/hooks/diff-prizm-docs.sh +8 -8
- package/bundled/templates/hooks/prizm-pre-commit.sh +4 -4
- package/bundled/templates/hooks/validate-prizm-docs.sh +4 -4
- package/bundled/templates/project-memory-template.md +4 -4
- package/package.json +1 -1
- package/src/clean.js +1 -3
- package/src/config.js +1 -1
- package/src/gitignore-template.js +4 -24
- package/src/scaffold.js +12 -11
- package/src/upgrade.js +3 -3
|
@@ -124,7 +124,7 @@ Ask the user to describe what they want to build. Listen for:
|
|
|
124
124
|
Ask:
|
|
125
125
|
1. **Existing code** — "Is there existing code I should look at? Which files or directories are relevant?"
|
|
126
126
|
2. **Design documents** — "Do you have any design docs, wireframes, API specs, or PRDs I should read?"
|
|
127
|
-
3. **Knowledge docs** — "Are there related `.prizm-docs/`, README files, or internal wiki pages?"
|
|
127
|
+
3. **Knowledge docs** — "Are there related `.prizmkit/prizm-docs/`, README files, or internal wiki pages?"
|
|
128
128
|
4. **Reference projects** — "Any reference implementations or similar projects I should look at for inspiration?"
|
|
129
129
|
|
|
130
130
|
Record everything the user provides — these become inputs for Step 1.3.
|
|
@@ -139,7 +139,7 @@ Record everything the user provides — these become inputs for Step 1.3.
|
|
|
139
139
|
|-------|-------------|---------|
|
|
140
140
|
| Agent A | User-provided code paths — read existing source files | Understand current architecture, patterns, conventions |
|
|
141
141
|
| Agent B | User-provided documents — design docs, specs, PRDs | Understand intended requirements and constraints |
|
|
142
|
-
| Agent C | `.prizm-docs/` — root.prizm, L1/L2 docs, TRAPS, RULES | Understand existing architecture knowledge and known pitfalls |
|
|
142
|
+
| Agent C | `.prizmkit/prizm-docs/` — root.prizm, L1/L2 docs, TRAPS, RULES | Understand existing architecture knowledge and known pitfalls |
|
|
143
143
|
| Agent D | Database/schema files + `.prizmkit/config.json` | Understand data model and tech stack preferences |
|
|
144
144
|
|
|
145
145
|
**Also gather** (can be included in any agent's task):
|
|
@@ -156,7 +156,7 @@ Record everything the user provides — these become inputs for Step 1.3.
|
|
|
156
156
|
Present what you learned from the parallel reading:
|
|
157
157
|
- Current project structure and patterns (with specific references)
|
|
158
158
|
- Existing data model and schema conventions
|
|
159
|
-
- Known TRAPS and pitfalls from `.prizm-docs/`
|
|
159
|
+
- Known TRAPS and pitfalls from `.prizmkit/prizm-docs/`
|
|
160
160
|
- Integration points with existing modules
|
|
161
161
|
|
|
162
162
|
Then ask targeted questions based on what you read. **Adapt question depth to the feature complexity** — a simple CRUD feature needs fewer questions than a real-time collaboration system.
|
|
@@ -251,7 +251,7 @@ Once brainstorming is complete, produce a structured requirements summary:
|
|
|
251
251
|
- [Requirement]
|
|
252
252
|
|
|
253
253
|
### Reference Materials Reviewed
|
|
254
|
-
- [List of code paths, documents, .prizm-docs/ files that were read]
|
|
254
|
+
- [List of code paths, documents, .prizmkit/prizm-docs/ files that were read]
|
|
255
255
|
|
|
256
256
|
### Confirmed by user: ✓
|
|
257
257
|
```
|
|
@@ -292,7 +292,7 @@ AskUserQuestion:
|
|
|
292
292
|
2. Invoke `/prizmkit-implement` to execute the plan
|
|
293
293
|
3. After implementation, run `/prizmkit-code-review` for quality check
|
|
294
294
|
4. Commit via `/prizmkit-committer` with `feat(<scope>):` prefix
|
|
295
|
-
5. Run `/prizmkit-retrospective` to sync `.prizm-docs/`
|
|
295
|
+
5. Run `/prizmkit-retrospective` to sync `.prizmkit/prizm-docs/`
|
|
296
296
|
6. **End workflow** — skip Phase 2/3/4
|
|
297
297
|
- **Add to feature list** → Continue to Phase 2 (Plan via pipeline)
|
|
298
298
|
|
|
@@ -392,7 +392,7 @@ AskUserQuestion:
|
|
|
392
392
|
|
|
393
393
|
1. **Initial status check**:
|
|
394
394
|
```bash
|
|
395
|
-
dev-pipeline/launch-feature-daemon.sh status
|
|
395
|
+
.prizmkit/dev-pipeline/launch-feature-daemon.sh status
|
|
396
396
|
```
|
|
397
397
|
|
|
398
398
|
2. **Offer monitoring options**:
|
|
@@ -402,7 +402,7 @@ AskUserQuestion:
|
|
|
402
402
|
|
|
403
403
|
3. **Periodic progress reports** (when user asks):
|
|
404
404
|
```bash
|
|
405
|
-
python3 dev-pipeline/scripts/update-feature-status.py \
|
|
405
|
+
python3 .prizmkit/dev-pipeline/scripts/update-feature-status.py \
|
|
406
406
|
--feature-list .prizmkit/plans/feature-list.json \
|
|
407
407
|
--state-dir .prizmkit/state/features \
|
|
408
408
|
--action status
|
|
@@ -508,4 +508,4 @@ All internal asset paths use `${SKILL_DIR}` placeholder for cross-IDE compatibil
|
|
|
508
508
|
- Pipeline execution (Phase 3)
|
|
509
509
|
- Progress updates (Phase 4)
|
|
510
510
|
- Multiple git commits with `feat(<scope>):` prefix
|
|
511
|
-
- Updated `.prizm-docs/` (via prizmkit-retrospective per feature)
|
|
511
|
+
- Updated `.prizmkit/prizm-docs/` (via prizmkit-retrospective per feature)
|
|
@@ -17,15 +17,15 @@ read docs → plan → implement → code-review → retrospective → committer
|
|
|
17
17
|
Each task begins by reading context at two levels:
|
|
18
18
|
|
|
19
19
|
**Application level** (read every session):
|
|
20
|
-
- `.prizm-docs/root.prizm` — L0 project architecture index (modules, tech stack, conventions)
|
|
20
|
+
- `.prizmkit/prizm-docs/root.prizm` — L0 project architecture index (modules, tech stack, conventions)
|
|
21
21
|
- `.prizmkit/plans/project-brief.md` — user's product vision checklist (generated by app-planner)
|
|
22
22
|
- `.prizmkit/config.json` — tech stack config, deploy strategy
|
|
23
23
|
|
|
24
24
|
**Task level** (read for the specific task):
|
|
25
25
|
- `spec.md` / `plan.md` — task specification and implementation plan
|
|
26
|
-
- `.prizm-docs/<module>.prizm` (L1/L2) — architecture docs for affected modules (TRAPS, DECISIONS, INTERFACES)
|
|
26
|
+
- `.prizmkit/prizm-docs/<module>.prizm` (L1/L2) — architecture docs for affected modules (TRAPS, DECISIONS, INTERFACES)
|
|
27
27
|
|
|
28
|
-
Each cycle produces spec, plan, and task artifacts that create a traceable record of what was built and why. `.prizm-docs/` stays in sync through retrospective, so the next session starts with up-to-date context.
|
|
28
|
+
Each cycle produces spec, plan, and task artifacts that create a traceable record of what was built and why. `.prizmkit/prizm-docs/` stays in sync through retrospective, so the next session starts with up-to-date context.
|
|
29
29
|
|
|
30
30
|
**Fast path** — for small, well-scoped changes, always ask user whether to use fast path:
|
|
31
31
|
```
|
|
@@ -42,13 +42,13 @@ PrizmKit supports any development scenario through the same skill chain. `/prizm
|
|
|
42
42
|
| **Bug Fix** | `spec.md` → `plan.md` → code | Complex defects, regressions, crash fixes. Simple bugs can use fast path directly. |
|
|
43
43
|
| **Refactor** | `spec.md` → `plan.md` → code | Restructure, extract, rename, performance. No behavior change. |
|
|
44
44
|
|
|
45
|
-
All three follow the same per-task flow. Detailed documentation policies (when to update `.prizm-docs/`, when to skip steps) are defined within each skill — not here.
|
|
45
|
+
All three follow the same per-task flow. Detailed documentation policies (when to update `.prizmkit/prizm-docs/`, when to skip steps) are defined within each skill — not here.
|
|
46
46
|
|
|
47
47
|
### Best Practices for AI-Driven Development
|
|
48
48
|
|
|
49
49
|
**Monorepo structure recommended**: Keep frontend, backend, and shared libraries in one repository. AI needs visibility into the full call chain — cross-repo references are invisible to it. If you have a multi-repo setup, add all related repos to the AI workspace so module boundaries and API contracts are discoverable.
|
|
50
50
|
|
|
51
|
-
**Module organization**: Ensure every meaningful module has a `.prizm-docs/` L1 doc. AI reads TRAPS and DECISIONS before modifying files — undocumented modules get no guardrails.
|
|
51
|
+
**Module organization**: Ensure every meaningful module has a `.prizmkit/prizm-docs/` L1 doc. AI reads TRAPS and DECISIONS before modifying files — undocumented modules get no guardrails.
|
|
52
52
|
|
|
53
53
|
**Small, focused tasks**: Break large features into tasks that can each be completed in one AI session. The pipeline handles this automatically via `/prizmkit-plan` task decomposition.
|
|
54
54
|
|
|
@@ -59,23 +59,23 @@ All three follow the same per-task flow. Detailed documentation policies (when t
|
|
|
59
59
|
| `/prizmkit-plan` | Specify + plan: natural language → spec.md → plan.md + tasks | "specify", "plan", "new feature", "I want to add...", "architect", "break it down" |
|
|
60
60
|
| `/prizmkit-implement` | Execute plan.md tasks, write code (TDD) | "implement", "build", "code it", "start coding" |
|
|
61
61
|
| `/prizmkit-code-review` | Diagnose issues + produce Fix Instructions | "review", "check code", "is it ready to commit" |
|
|
62
|
-
| `/prizmkit-retrospective` | Sync .prizm-docs/ with code changes | "retrospective", "retro", "sync docs", "wrap up" |
|
|
62
|
+
| `/prizmkit-retrospective` | Sync .prizmkit/prizm-docs/ with code changes | "retrospective", "retro", "sync docs", "wrap up" |
|
|
63
63
|
| `/prizmkit-committer` | Safe git commit with Conventional Commits | "commit", "submit", "finish", "ship it" |
|
|
64
64
|
| `/prizmkit-deploy` | Generate/update deployment documentation | "deploy docs", "deployment guide", "how to deploy" |
|
|
65
|
-
| `/prizmkit-init` | Project bootstrap + .prizm-docs/ setup | "init", "initialize", "take over this project" |
|
|
65
|
+
| `/prizmkit-init` | Project bootstrap + .prizmkit/prizm-docs/ setup | "init", "initialize", "take over this project" |
|
|
66
66
|
| `/prizmkit-prizm-docs` | Doc management (init/status/rebuild/validate) | "check docs", "rebuild docs", "validate docs" |
|
|
67
67
|
|
|
68
68
|
**Reading guide**:
|
|
69
|
-
- Need code structure/modules/interfaces/traps/decisions? → `.prizm-docs/`
|
|
69
|
+
- Need code structure/modules/interfaces/traps/decisions? → `.prizmkit/prizm-docs/`
|
|
70
70
|
|
|
71
71
|
## Quick Start (First-Time Setup)
|
|
72
72
|
|
|
73
73
|
1. `npx prizmkit install .` → installs skills, rules (`prizm-documentation.md`, `prizm-commit-workflow.md`), hooks, platform scaffolding
|
|
74
|
-
2. `/prizmkit-init` → scans project code, generates `.prizm-docs/`, detects tech stack, populates `.prizmkit/config.json`
|
|
74
|
+
2. `/prizmkit-init` → scans project code, generates `.prizmkit/prizm-docs/`, detects tech stack, populates `.prizmkit/config.json`
|
|
75
75
|
3. `/prizmkit-plan` → specify your first feature → produces spec.md + plan.md
|
|
76
76
|
4. `/prizmkit-implement` → TDD implementation following the plan
|
|
77
77
|
5. `/prizmkit-code-review` → review before commit
|
|
78
|
-
6. `/prizmkit-retrospective` → sync `.prizm-docs/` with changes
|
|
78
|
+
6. `/prizmkit-retrospective` → sync `.prizmkit/prizm-docs/` with changes
|
|
79
79
|
7. `/prizmkit-committer` → safe Conventional Commit
|
|
80
80
|
|
|
81
81
|
> **Note**: Rules and hooks are installed by `npx prizmkit install`, not by `/prizmkit-init`.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: "prizmkit-committer"
|
|
3
|
-
description: "Pure git commit workflow with safety checks. Stages files, generates Conventional Commits message, and commits. Does NOT modify .prizm-docs/ — run /prizmkit-retrospective first. Trigger on: 'commit', 'submit', 'finish', 'done', 'ship it'. (project)"
|
|
3
|
+
description: "Pure git commit workflow with safety checks. Stages files, generates Conventional Commits message, and commits. Does NOT modify .prizmkit/prizm-docs/ — run /prizmkit-retrospective first. Trigger on: 'commit', 'submit', 'finish', 'done', 'ship it'. (project)"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# PrizmKit Committer
|
|
@@ -15,7 +15,7 @@ description: "Pure git commit workflow with safety checks. Stages files, generat
|
|
|
15
15
|
| Required State | Check | If Missing |
|
|
16
16
|
|---|---|---|
|
|
17
17
|
| Uncommitted changes exist | `git status` shows modified/added/untracked files | Inform user "nothing to commit" and stop |
|
|
18
|
-
| `.prizm-docs/` synced (feature/refactor) | `/prizmkit-retrospective` has run | Run `/prizmkit-retrospective` first |
|
|
18
|
+
| `.prizmkit/prizm-docs/` synced (feature/refactor) | `/prizmkit-retrospective` has run | Run `/prizmkit-retrospective` first |
|
|
19
19
|
| Code review passed (pipeline mode) | `review-report.md` in artifact directory has `## Verdict: PASS` | Run `/prizmkit-code-review` first |
|
|
20
20
|
|
|
21
21
|
### Workflow
|
|
@@ -66,6 +66,8 @@ Ask user: "Push to remote?"
|
|
|
66
66
|
- Yes: `git push`
|
|
67
67
|
- No: Stop
|
|
68
68
|
|
|
69
|
+
**Headless mode**: If the skill was invoked with `--headless` in the args (e.g., `/prizmkit-committer --headless feat(F-001): ...`), **SKIP this step entirely**. Do NOT ask the question. Do NOT push. Stop after Step 5 verification. Headless mode is used by autonomous pipeline sessions where there is no human to answer interactive prompts.
|
|
70
|
+
|
|
69
71
|
## Example
|
|
70
72
|
|
|
71
73
|
**Feature commit:**
|
|
@@ -30,9 +30,9 @@ description: "Execute plan.md tasks with TDD approach. Respects task ordering an
|
|
|
30
30
|
Before implementation, load context once:
|
|
31
31
|
|
|
32
32
|
1. **Task context**: Read `plan.md` (including Tasks section) and `spec.md` from the artifact directory. If other companion documents exist in the directory (e.g., `refactor-analysis.md`), read them for additional context.
|
|
33
|
-
2. **Architecture context**: Read `.prizm-docs/root.prizm` (L0 — project overview, module index, tech stack, conventions) and relevant L1/L2 docs for affected modules. Pay special attention to TRAPS (known pitfalls) and DECISIONS (architectural choices).
|
|
33
|
+
2. **Architecture context**: Read `.prizmkit/prizm-docs/root.prizm` (L0 — project overview, module index, tech stack, conventions) and relevant L1/L2 docs for affected modules. Pay special attention to TRAPS (known pitfalls) and DECISIONS (architectural choices).
|
|
34
34
|
|
|
35
|
-
> `.prizm-docs/` uses a 3-level hierarchy: L0 (`root.prizm`) is the project-wide index. L1 (e.g., `auth.prizm`) covers a module — its key files, interfaces, dependencies, traps, and decisions. L2 is for sub-modules with their own complexity. Implement reads these docs to avoid repeating known mistakes; `/prizmkit-retrospective` is responsible for updating them after implementation.
|
|
35
|
+
> `.prizmkit/prizm-docs/` uses a 3-level hierarchy: L0 (`root.prizm`) is the project-wide index. L1 (e.g., `auth.prizm`) covers a module — its key files, interfaces, dependencies, traps, and decisions. L2 is for sub-modules with their own complexity. Implement reads these docs to avoid repeating known mistakes; `/prizmkit-retrospective` is responsible for updating them after implementation.
|
|
36
36
|
|
|
37
37
|
## Execution
|
|
38
38
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: "prizmkit-init"
|
|
3
|
-
description: "Project takeover and bootstrap. Scans any project, generates Prizm docs and project brief. Use this skill whenever a user opens a new project for the first time, says 'initialize', 'set up PrizmKit', 'take over this project', 'bootstrap', 'scan this codebase', 'init', or when .prizm-docs/ doesn't exist yet. Also use when PrizmKit was just installed via npx but not yet initialized. (project)"
|
|
3
|
+
description: "Project takeover and bootstrap. Scans any project, generates Prizm docs and project brief. Use this skill whenever a user opens a new project for the first time, says 'initialize', 'set up PrizmKit', 'take over this project', 'bootstrap', 'scan this codebase', 'init', or when .prizmkit/prizm-docs/ doesn't exist yet. Also use when PrizmKit was just installed via npx but not yet initialized. (project)"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# PrizmKit Init
|
|
@@ -11,7 +11,7 @@ Project takeover and bootstrap skill. Scans any project (brownfield or greenfiel
|
|
|
11
11
|
- Taking over a new project (brownfield or greenfield)
|
|
12
12
|
- User says "initialize PrizmKit", "set up PrizmKit", "take over this project"
|
|
13
13
|
- First time using PrizmKit on a project
|
|
14
|
-
- After `npx prizmkit install` when project has no `.prizm-docs/`
|
|
14
|
+
- After `npx prizmkit install` when project has no `.prizmkit/prizm-docs/`
|
|
15
15
|
|
|
16
16
|
### When NOT to Use
|
|
17
17
|
- All artifacts exist and are up to date → use `/prizmkit-prizm-docs` (Update) instead if you only want to resync docs
|
|
@@ -38,14 +38,14 @@ Scan all init artifacts and display their status:
|
|
|
38
38
|
|
|
39
39
|
| Artifact | Path | Check |
|
|
40
40
|
|----------|------|-------|
|
|
41
|
-
| Prizm docs | `.prizm-docs/` | Directory exists + `root.prizm` present |
|
|
41
|
+
| Prizm docs | `.prizmkit/prizm-docs/` | Directory exists + `root.prizm` present |
|
|
42
42
|
| Runtime config | `.prizmkit/config.json` | File exists |
|
|
43
43
|
| Project brief | `.prizmkit/plans/project-brief.md` | File exists |
|
|
44
44
|
|
|
45
45
|
Display status table to user:
|
|
46
46
|
```
|
|
47
47
|
Init Status Check:
|
|
48
|
-
[exists] .prizm-docs/ (N files)
|
|
48
|
+
[exists] .prizmkit/prizm-docs/ (N files)
|
|
49
49
|
[exists] .prizmkit/config.json
|
|
50
50
|
[missing] .prizmkit/plans/project-brief.md
|
|
51
51
|
```
|
|
@@ -59,7 +59,7 @@ Init Status Check:
|
|
|
59
59
|
Each subsequent phase checks its artifact's action before executing:
|
|
60
60
|
- `action == skip` → output "Skipped (exists)" and move on
|
|
61
61
|
- `action == generate | regenerate` → run normally
|
|
62
|
-
- **Special case for `.prizm-docs/`**:
|
|
62
|
+
- **Special case for `.prizmkit/prizm-docs/`**:
|
|
63
63
|
- `skip` = **Update** mode: preserve existing L1/L2 docs, re-scan tech stack, merge changes, check for missing docs (see `${SKILL_DIR}/references/update-supplement.md`)
|
|
64
64
|
- `regenerate` = **Reinitialize**: overwrite everything
|
|
65
65
|
|
|
@@ -70,8 +70,8 @@ BROWNFIELD WORKFLOW (existing project):
|
|
|
70
70
|
2. Map directory structure using a TWO-TIER model — flat structures lose the nesting relationships that AI needs to navigate the codebase:
|
|
71
71
|
- TOP-LEVEL modules: directories directly under project root that contain source files or sub-directories with source files (e.g. `src/`, `internal/`, `lib/`)
|
|
72
72
|
- SUB-MODULES: directories INSIDE a top-level module (e.g. `src/routes/`, `src/models/`)
|
|
73
|
-
- A sub-module maps to `.prizm-docs/<M>/<S>.prizm`, never to `.prizm-docs/<S>.prizm` — flattening would create ambiguous paths when two modules have identically-named sub-modules
|
|
74
|
-
- Exclude: `.git/`, `node_modules/`, `vendor/`, `build/`, `dist/`, `__pycache__/`, `target/`, `bin/`, `.claude/`, `.codebuddy/`, `.prizmkit/`, `.prizm-docs/`, `dev-pipeline/`
|
|
73
|
+
- A sub-module maps to `.prizmkit/prizm-docs/<M>/<S>.prizm`, never to `.prizmkit/prizm-docs/<S>.prizm` — flattening would create ambiguous paths when two modules have identically-named sub-modules
|
|
74
|
+
- Exclude: `.git/`, `node_modules/`, `vendor/`, `build/`, `dist/`, `__pycache__/`, `target/`, `bin/`, `.claude/`, `.codebuddy/`, `.prizmkit/`, `.prizmkit/prizm-docs/`, `dev-pipeline/`
|
|
75
75
|
- **Scan command** — run this to get a 2-level directory tree (excludes noise directories):
|
|
76
76
|
```bash
|
|
77
77
|
find . -maxdepth 2 -type d \
|
|
@@ -79,7 +79,7 @@ BROWNFIELD WORKFLOW (existing project):
|
|
|
79
79
|
-not -path '*/dist/*' -not -path '*/build/*' \
|
|
80
80
|
-not -path '*/__pycache__/*' -not -path '*/vendor/*' \
|
|
81
81
|
-not -path '*/.claude/*' -not -path '*/.codebuddy/*' \
|
|
82
|
-
-not -path '*/.prizmkit/*' -not -path '*/.prizm-docs/*' \
|
|
82
|
+
-not -path '*/.prizmkit/*' -not -path '*/.prizmkit/prizm-docs/*' \
|
|
83
83
|
-not -path '*/dev-pipeline/*' -not -path '*/target/*' \
|
|
84
84
|
| sed -e 's;[^/]*/;|____;g;s;____|; |;g'
|
|
85
85
|
```
|
|
@@ -151,10 +151,10 @@ Detect database and deployment signals, then ask 1-2 brief questions. This phase
|
|
|
151
151
|
|
|
152
152
|
**Phase 5: Prizm Documentation Generation**
|
|
153
153
|
Invoke prizmkit-prizm-docs (Init operation), passing the two-tier module structure from Phase 4:
|
|
154
|
-
- Create `.prizm-docs/` directory structure mirroring the source tree (sub-module dirs become subdirectories under `.prizm-docs/<top-level>/`)
|
|
154
|
+
- Create `.prizmkit/prizm-docs/` directory structure mirroring the source tree (sub-module dirs become subdirectories under `.prizmkit/prizm-docs/<top-level>/`)
|
|
155
155
|
- Generate `root.prizm` (L0) with project meta and MODULE_INDEX listing only top-level modules. If module count > 15, use MODULE_GROUPS format instead (group by functional domain).
|
|
156
156
|
- For each module entry in MODULE_INDEX/MODULE_GROUPS, include keyword tags extracted from the module's source files — scan for: exported symbols, imported packages, domain terms in file/directory names. Format: `- module-name [tag1, tag2, tag3]: ...`. Tags help AI match user intent to relevant modules.
|
|
157
|
-
- Generate L1 docs for top-level modules at `.prizm-docs/<M>.prizm` and for sub-modules at `.prizm-docs/<M>/<S>.prizm`
|
|
157
|
+
- Generate L1 docs for top-level modules at `.prizmkit/prizm-docs/<M>.prizm` and for sub-modules at `.prizmkit/prizm-docs/<M>/<S>.prizm`
|
|
158
158
|
- Create `changelog.prizm`
|
|
159
159
|
- Skip L2 (lazy generation) — L2 is generated on first file modification, saving tokens upfront
|
|
160
160
|
|
|
@@ -231,7 +231,7 @@ GREENFIELD WORKFLOW (new project):
|
|
|
231
231
|
- Record answers in `config.json` `tech_stack` with `"_auto_detected": false` (user-provided, not auto-detected)
|
|
232
232
|
- If user is unsure, skip tech_stack — it can be populated later on re-init after code exists
|
|
233
233
|
- Phase 4.5: Run Infrastructure Quick Scan — in greenfield mode, no auto-detection is possible, so only ask the 2 brief questions (database need and deployment target). If user is unsure, skip — these can be configured later via `app-planner` or `/prizmkit-deploy`.
|
|
234
|
-
- Phase 5: Create minimal `.prizm-docs/` with just `root.prizm` skeleton (populate TECH_STACK from user answers if provided)
|
|
234
|
+
- Phase 5: Create minimal `.prizmkit/prizm-docs/` with just `root.prizm` skeleton (populate TECH_STACK from user answers if provided)
|
|
235
235
|
- Phase 7: Generate project brief (greenfield flow — ask user about project goals, see Phase 7 above)
|
|
236
236
|
- Phases 6, 8: Same as brownfield (Phase 8 Report recommends `/prizmkit-plan` for first feature)
|
|
237
237
|
|
|
@@ -243,7 +243,7 @@ $ /prizmkit-init
|
|
|
243
243
|
|
|
244
244
|
Platform detected: Claude Code
|
|
245
245
|
Init Status Check:
|
|
246
|
-
[missing] .prizm-docs/
|
|
246
|
+
[missing] .prizmkit/prizm-docs/
|
|
247
247
|
[missing] .prizmkit/config.json
|
|
248
248
|
[missing] .prizmkit/plans/project-brief.md
|
|
249
249
|
→ All missing, generating everything.
|
|
@@ -266,10 +266,10 @@ Infrastructure Quick Scan:
|
|
|
266
266
|
→ Written to CLAUDE.md ### Infrastructure
|
|
267
267
|
|
|
268
268
|
Modules discovered:
|
|
269
|
-
src/routes/ → .prizm-docs/routes.prizm (12 files)
|
|
270
|
-
src/models/ → .prizm-docs/models.prizm (8 files)
|
|
271
|
-
src/services/ → .prizm-docs/services.prizm (15 files)
|
|
272
|
-
src/middleware/ → .prizm-docs/middleware.prizm (5 files)
|
|
269
|
+
src/routes/ → .prizmkit/prizm-docs/routes.prizm (12 files)
|
|
270
|
+
src/models/ → .prizmkit/prizm-docs/models.prizm (8 files)
|
|
271
|
+
src/services/ → .prizmkit/prizm-docs/services.prizm (15 files)
|
|
272
|
+
src/middleware/ → .prizmkit/prizm-docs/middleware.prizm (5 files)
|
|
273
273
|
|
|
274
274
|
Project brief: inferred from codebase → confirmed by user
|
|
275
275
|
→ .prizmkit/plans/project-brief.md
|
|
@@ -288,7 +288,7 @@ UPDATE SUPPLEMENT (runs after tech stack merge in Update mode):
|
|
|
288
288
|
$ /prizmkit-init
|
|
289
289
|
|
|
290
290
|
Init Status Check:
|
|
291
|
-
[exists] .prizm-docs/ (12 files)
|
|
291
|
+
[exists] .prizmkit/prizm-docs/ (12 files)
|
|
292
292
|
[exists] .prizmkit/config.json
|
|
293
293
|
[missing] .prizmkit/plans/project-brief.md
|
|
294
294
|
|
|
@@ -36,7 +36,7 @@ A universal spec + plan generator. Takes a natural-language description of ANY d
|
|
|
36
36
|
- If `artifact_dir` is provided → use it directly
|
|
37
37
|
- If not provided → scan `.prizmkit/specs/` for existing `###-*` directories, find highest numeric prefix, next = highest + 1 (zero-padded to 3 digits; start at `001` if empty). Create `.prizmkit/specs/###-task-slug/`
|
|
38
38
|
- Auto-generate 2-10 word task slug from description
|
|
39
|
-
3. Load project context: read `.prizm-docs/root.prizm` and relevant L1/L2 docs
|
|
39
|
+
3. Load project context: read `.prizmkit/prizm-docs/root.prizm` and relevant L1/L2 docs
|
|
40
40
|
4. Generate `spec.md` from template (`${SKILL_DIR}/assets/spec-template.md`):
|
|
41
41
|
- Fill sections based on the task description — all sections are optional, include only what is relevant
|
|
42
42
|
- `[NEEDS CLARIFICATION]` markers for all ambiguous items
|
|
@@ -56,7 +56,7 @@ A universal spec + plan generator. Takes a natural-language description of ANY d
|
|
|
56
56
|
**Steps:**
|
|
57
57
|
|
|
58
58
|
1. Read `spec.md` from the artifact directory
|
|
59
|
-
2. Load project context if not already loaded in Phase 0: read `.prizm-docs/root.prizm` and relevant L1/L2 docs
|
|
59
|
+
2. Load project context if not already loaded in Phase 0: read `.prizmkit/prizm-docs/root.prizm` and relevant L1/L2 docs
|
|
60
60
|
3. Resolve any remaining `[NEEDS CLARIFICATION]` by proposing solutions
|
|
61
61
|
4. Generate `plan.md` from template (`${SKILL_DIR}/assets/plan-template.md`):
|
|
62
62
|
- Change approach (how the changes integrate with existing system)
|
|
@@ -67,7 +67,7 @@ A universal spec + plan generator. Takes a natural-language description of ANY d
|
|
|
67
67
|
- Risk assessment
|
|
68
68
|
- Behavior preservation strategy (if the task modifies existing behavior — include what must remain unchanged and how to verify)
|
|
69
69
|
5. Cross-check: every goal in spec.md maps to plan components — unmapped goals = coverage gaps
|
|
70
|
-
6. Check alignment with `.prizm-docs/root.prizm` RULES section
|
|
70
|
+
6. Check alignment with `.prizmkit/prizm-docs/root.prizm` RULES section
|
|
71
71
|
|
|
72
72
|
### Phase 2: Task Generation (plan.md → Tasks section)
|
|
73
73
|
|
|
@@ -40,8 +40,8 @@ Run this checklist after generating the Tasks section in plan.md. Fix any issues
|
|
|
40
40
|
|
|
41
41
|
## Rules Alignment
|
|
42
42
|
|
|
43
|
-
- [ ] No spec or plan element conflicts with `.prizm-docs/root.prizm` RULES MUST/NEVER directives
|
|
44
|
-
- [ ] Tech stack choices in plan.md match `.prizm-docs/root.prizm` TECH_STACK (if defined)
|
|
43
|
+
- [ ] No spec or plan element conflicts with `.prizmkit/prizm-docs/root.prizm` RULES MUST/NEVER directives
|
|
44
|
+
- [ ] Tech stack choices in plan.md match `.prizmkit/prizm-docs/root.prizm` TECH_STACK (if defined)
|
|
45
45
|
|
|
46
46
|
## Database Design (skip if no Data Model section)
|
|
47
47
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: "prizmkit-prizm-docs"
|
|
3
|
-
description: "Project documentation specification and standard for AI-optimized progressive context loading. Defines the .prizm-docs/ 3-level hierarchy (L0/L1/L2), format rules, size limits, and loading protocol. Use this skill to: bootstrap docs for new projects (init), check doc freshness (status), regenerate stale modules (rebuild), validate format compliance (validate), or migrate existing docs (migrate). For incremental doc updates after code changes, use /prizmkit-retrospective instead — it is the sole writer of .prizm-docs/ during development. Trigger on: 'initialize docs', 'check doc status', 'rebuild docs', 'validate docs', 'migrate docs', 'docs are stale', 'prizm docs'. (project)"
|
|
3
|
+
description: "Project documentation specification and standard for AI-optimized progressive context loading. Defines the .prizmkit/prizm-docs/ 3-level hierarchy (L0/L1/L2), format rules, size limits, and loading protocol. Use this skill to: bootstrap docs for new projects (init), check doc freshness (status), regenerate stale modules (rebuild), validate format compliance (validate), or migrate existing docs (migrate). For incremental doc updates after code changes, use /prizmkit-retrospective instead — it is the sole writer of .prizmkit/prizm-docs/ during development. Trigger on: 'initialize docs', 'check doc status', 'rebuild docs', 'validate docs', 'migrate docs', 'docs are stale', 'prizm docs'. (project)"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Prizm Docs - AI Documentation Framework
|
|
@@ -30,53 +30,53 @@ This skill handles 6 operations. When invoked, determine the user's intent and e
|
|
|
30
30
|
|--------|----------------------|--------------------------|
|
|
31
31
|
| **Role** | Documentation SPECIFICATION + BOOTSTRAP | Incremental WRITER during development |
|
|
32
32
|
| **When** | Project setup, health checks, migrations | After feature completion, before commit |
|
|
33
|
-
| **Writes** | Initial .prizm-docs/ structure (init, rebuild, migrate) | Incremental updates to existing .prizm-docs/ |
|
|
33
|
+
| **Writes** | Initial .prizmkit/prizm-docs/ structure (init, rebuild, migrate) | Incremental updates to existing .prizmkit/prizm-docs/ |
|
|
34
34
|
| **Reads** | Source code structure (for init/rebuild) | git diff + code changes (for sync) |
|
|
35
|
-
| **Knowledge** | Defines format rules, size limits, loading protocol | Extracts TRAPS/RULES/DECISIONS into `.prizm-docs/` |
|
|
35
|
+
| **Knowledge** | Defines format rules, size limits, loading protocol | Extracts TRAPS/RULES/DECISIONS into `.prizmkit/prizm-docs/` |
|
|
36
36
|
|
|
37
37
|
**Key principle**: `/prizmkit-prizm-docs` defines WHAT the docs should look like and bootstraps them. `/prizmkit-retrospective` is the SOLE WRITER that keeps docs in sync with code during ongoing development.
|
|
38
38
|
|
|
39
39
|
## Operation: Init
|
|
40
40
|
|
|
41
|
-
Bootstrap .prizm-docs/ for the current project.
|
|
42
|
-
PRECONDITION: No .prizm-docs/ directory exists, or user confirms overwrite.
|
|
41
|
+
Bootstrap .prizmkit/prizm-docs/ for the current project.
|
|
42
|
+
PRECONDITION: No .prizmkit/prizm-docs/ directory exists, or user confirms overwrite.
|
|
43
43
|
→ Read `${SKILL_DIR}/references/op-init.md` for detailed steps.
|
|
44
44
|
|
|
45
45
|
## Operation: Update
|
|
46
46
|
|
|
47
|
-
Update .prizm-docs/ to reflect recent code changes.
|
|
48
|
-
PRECONDITION: .prizm-docs/ exists with root.prizm.
|
|
47
|
+
Update .prizmkit/prizm-docs/ to reflect recent code changes.
|
|
48
|
+
PRECONDITION: .prizmkit/prizm-docs/ exists with root.prizm.
|
|
49
49
|
→ Read `${SKILL_DIR}/references/op-update.md` for detailed steps.
|
|
50
50
|
|
|
51
51
|
## Operation: Status
|
|
52
52
|
|
|
53
53
|
Check freshness of all .prizm docs.
|
|
54
|
-
PRECONDITION: .prizm-docs/ exists with root.prizm.
|
|
54
|
+
PRECONDITION: .prizmkit/prizm-docs/ exists with root.prizm.
|
|
55
55
|
→ Read `${SKILL_DIR}/references/op-status.md` for detailed steps.
|
|
56
56
|
|
|
57
57
|
## Operation: Rebuild
|
|
58
58
|
|
|
59
59
|
Regenerate docs for a specific module from scratch. Requires a module path argument.
|
|
60
|
-
PRECONDITION: .prizm-docs/ exists. Module path is valid.
|
|
60
|
+
PRECONDITION: .prizmkit/prizm-docs/ exists. Module path is valid.
|
|
61
61
|
→ Read `${SKILL_DIR}/references/op-rebuild.md` for detailed steps.
|
|
62
62
|
|
|
63
63
|
## Operation: Validate
|
|
64
64
|
|
|
65
65
|
Check format compliance and consistency of all .prizm docs.
|
|
66
|
-
PRECONDITION: .prizm-docs/ exists.
|
|
66
|
+
PRECONDITION: .prizmkit/prizm-docs/ exists.
|
|
67
67
|
→ Read `${SKILL_DIR}/references/op-validate.md` for detailed steps.
|
|
68
68
|
|
|
69
69
|
## Operation: Migrate
|
|
70
70
|
|
|
71
|
-
Convert existing documentation to .prizm-docs/ format.
|
|
72
|
-
PRECONDITION: Existing docs/ or docs/AI_CONTEXT/ directory. No .prizm-docs/ (or user confirms overwrite).
|
|
71
|
+
Convert existing documentation to .prizmkit/prizm-docs/ format.
|
|
72
|
+
PRECONDITION: Existing docs/ or docs/AI_CONTEXT/ directory. No .prizmkit/prizm-docs/ (or user confirms overwrite).
|
|
73
73
|
|
|
74
74
|
STEPS:
|
|
75
75
|
1. DISCOVER existing docs: Scan docs/, docs/AI_CONTEXT/, README.md, ARCHITECTURE.md, and any structured documentation files.
|
|
76
76
|
2. EXTRACT information from existing docs: project metadata, module descriptions, architecture patterns, rules, decisions, dependencies.
|
|
77
77
|
3. MAP existing doc content to Prizm levels: project-wide info -> L0 root.prizm, module-level info -> L1 docs (MODULE, FILES, RESPONSIBILITY, KEY_FILES, DEPENDENCIES), detailed module info -> L2 docs (INTERFACES, DATA_FLOW, TRAPS, DECISIONS, domain-specific sections).
|
|
78
78
|
4. CONVERT prose content to KEY: value format. Strip markdown formatting, tables, diagrams. Condense explanatory text into single-line values.
|
|
79
|
-
5. GENERATE .prizm-docs/ structure following standard init procedure but seeded with extracted information instead of scanning source code alone.
|
|
79
|
+
5. GENERATE .prizmkit/prizm-docs/ structure following standard init procedure but seeded with extracted information instead of scanning source code alone.
|
|
80
80
|
6. VALIDATE migrated docs against Prizm format rules and size limits.
|
|
81
81
|
7. REPORT migration summary: files processed, content mapped, information that could not be automatically converted (requires manual review).
|
|
82
82
|
|
|
@@ -99,7 +99,7 @@ For detailed protocol specifications, see prizm-docs-format.md:
|
|
|
99
99
|
|
|
100
100
|
**Init output (Node.js project):**
|
|
101
101
|
```
|
|
102
|
-
Generated .prizm-docs/:
|
|
102
|
+
Generated .prizmkit/prizm-docs/:
|
|
103
103
|
root.prizm (L0) — 3 modules in MODULE_INDEX
|
|
104
104
|
routes.prizm (L1) — 12 files, 4 interfaces
|
|
105
105
|
models.prizm (L1) — 8 files, 3 interfaces
|
|
@@ -110,8 +110,8 @@ Generated .prizm-docs/:
|
|
|
110
110
|
**Update after adding new API endpoint:**
|
|
111
111
|
```
|
|
112
112
|
Changed: src/routes/avatar.ts (A), src/models/user.ts (M)
|
|
113
|
-
Updated: .prizm-docs/routes.prizm — added avatar.ts to KEY_FILES, new POST /api/avatar interface
|
|
114
|
-
Updated: .prizm-docs/models.prizm — updated User interface with avatar_url field
|
|
115
|
-
Skipped: .prizm-docs/services.prizm — no changes in services module
|
|
113
|
+
Updated: .prizmkit/prizm-docs/routes.prizm — added avatar.ts to KEY_FILES, new POST /api/avatar interface
|
|
114
|
+
Updated: .prizmkit/prizm-docs/models.prizm — updated User interface with avatar_url field
|
|
115
|
+
Skipped: .prizmkit/prizm-docs/services.prizm — no changes in services module
|
|
116
116
|
Appended: changelog.prizm — "routes | add: avatar upload endpoint"
|
|
117
117
|
```
|