@captain_z/zsk 1.8.1 → 1.8.3
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/dist/bin.js +184 -1
- package/dist/bin.js.map +1 -1
- package/dist/commands/check.js +259 -12
- package/dist/commands/check.js.map +1 -1
- package/dist/commands/config.d.ts +11 -0
- package/dist/commands/config.js +132 -3
- package/dist/commands/config.js.map +1 -1
- package/dist/commands/demo.js +2 -2
- package/dist/commands/demo.js.map +1 -1
- package/dist/commands/dispatch.d.ts +11 -0
- package/dist/commands/dispatch.js +69 -0
- package/dist/commands/dispatch.js.map +1 -0
- package/dist/commands/gate.d.ts +11 -0
- package/dist/commands/gate.js +50 -0
- package/dist/commands/gate.js.map +1 -0
- package/dist/commands/prep.d.ts +2 -4
- package/dist/commands/prep.js +1 -131
- package/dist/commands/prep.js.map +1 -1
- package/dist/commands/prepare.d.ts +17 -0
- package/dist/commands/prepare.js +259 -0
- package/dist/commands/prepare.js.map +1 -0
- package/dist/commands/project-init.d.ts +1 -0
- package/dist/commands/project-init.js +12 -10
- package/dist/commands/project-init.js.map +1 -1
- package/dist/commands/template.d.ts +2 -0
- package/dist/commands/template.js +34 -0
- package/dist/commands/template.js.map +1 -0
- package/dist/core/config.d.ts +85 -1
- package/dist/core/config.js +141 -7
- package/dist/core/config.js.map +1 -1
- package/dist/core/origin-detection.d.ts +10 -0
- package/dist/core/origin-detection.js +135 -0
- package/dist/core/origin-detection.js.map +1 -0
- package/dist/core/prepare-lifecycle.d.ts +54 -0
- package/dist/core/prepare-lifecycle.js +302 -0
- package/dist/core/prepare-lifecycle.js.map +1 -0
- package/dist/core/prepare-sync.d.ts +82 -0
- package/dist/core/prepare-sync.js +1514 -0
- package/dist/core/prepare-sync.js.map +1 -0
- package/dist/core/raw-manifest.d.ts +10 -0
- package/dist/core/raw-manifest.js +58 -4
- package/dist/core/raw-manifest.js.map +1 -1
- package/dist/core/source-draft.d.ts +14 -0
- package/dist/core/source-draft.js +251 -0
- package/dist/core/source-draft.js.map +1 -0
- package/dist/core/staffing-plan.d.ts +212 -0
- package/dist/core/staffing-plan.js +1238 -0
- package/dist/core/staffing-plan.js.map +1 -0
- package/dist/core/stage-quality.d.ts +64 -0
- package/dist/core/stage-quality.js +847 -0
- package/dist/core/stage-quality.js.map +1 -0
- package/dist/core/template-registry.d.ts +29 -0
- package/dist/core/template-registry.js +295 -0
- package/dist/core/template-registry.js.map +1 -0
- package/dist/core/workspace-layout.d.ts +3 -0
- package/dist/core/workspace-layout.js +14 -1
- package/dist/core/workspace-layout.js.map +1 -1
- package/package.json +2 -2
- package/schemas/zsk-config.schema.json +233 -196
- package/templates/module/frontend-module/design.md +86 -3
- package/templates/module/frontend-module/proposal.md +17 -0
- package/templates/module/frontend-module/spec.md +26 -0
- package/templates/module/frontend-module/tasks.md +53 -7
- package/templates/project-init/.zsk/config.yaml +8 -96
- package/templates/project-init/.zsk/docs/SYSTEM-SPEC.md +2 -0
- package/templates/project-init/.zsk/raws/index.md +11 -0
- package/templates/project-init/.zsk/raws/prepare/backend/index.md +4 -0
- package/templates/project-init/.zsk/raws/prepare/design/index.md +3 -0
- package/templates/project-init/.zsk/raws/prepare/index.md +4 -0
- package/templates/project-init/.zsk/raws/prepare/product/index.md +4 -0
- package/templates/project-init/.zsk/raws/prepare/qa/index.md +4 -0
- package/templates/project-init/.zsk/raws/prepare/ux/index.md +3 -0
- package/templates/project-init/.zsk/roles.yaml +129 -0
- package/templates/project-init/.zsk/raws/backend/index.md +0 -3
- package/templates/project-init/.zsk/raws/jira/index.md +0 -3
- package/templates/project-init/.zsk/raws/manual/index.md +0 -3
- package/templates/project-init/.zsk/raws/product/index.md +0 -3
- package/templates/project-init/.zsk/raws/qa/index.md +0 -3
- package/templates/project-init/.zsk/raws/ue/index.md +0 -3
|
@@ -1,16 +1,88 @@
|
|
|
1
1
|
# __MODULE_NAME__ Design
|
|
2
2
|
|
|
3
|
+
## Project Rules Gate
|
|
4
|
+
|
|
5
|
+
| Rule Source | Rule / Constraint | Design Impact | Status |
|
|
6
|
+
| --- | --- | --- | --- |
|
|
7
|
+
| `.zsk/docs/PROJECT-CONFIG.md` | | | TODO |
|
|
8
|
+
| `.zsk/docs/SYSTEM-SPEC.md` | | | TODO |
|
|
9
|
+
|
|
10
|
+
Do not approve this design until project-level path boundaries, evidence routing, issue routing, source priority, and stage-document rules are mapped to implementation surfaces or recorded as blockers.
|
|
11
|
+
|
|
3
12
|
## Implementation Map
|
|
4
13
|
|
|
5
14
|
| Requirement / AC | Surface | Files / Modules | Interface / State / Data Flow | Risk |
|
|
6
15
|
| --- | --- | --- | --- | --- |
|
|
7
16
|
| FR-001 / AC-001 | | | | |
|
|
8
17
|
|
|
18
|
+
## Control Traceability Matrix When Triggered
|
|
19
|
+
|
|
20
|
+
Use this table when the module touches auth, permissions, roles, tenancy, data access, compliance, audit, privacy, or security. If none apply, write an evidence-backed N/A rationale.
|
|
21
|
+
|
|
22
|
+
| Source Rule / Spec | Subject / Actor | Action / Capability | Resource / Data | Scope | UI / API / State Behavior | Enforcement Point | AC / Scenario | Test / Evidence |
|
|
23
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
24
|
+
| N/A or source id | | | | | | | | |
|
|
25
|
+
|
|
26
|
+
## Design Views
|
|
27
|
+
|
|
28
|
+
Use Mermaid or linked configured design-source evidence to make boundaries, flows, states, and dependencies reviewable. Keep a view N/A only with rationale.
|
|
29
|
+
|
|
30
|
+
### Context / Container View
|
|
31
|
+
|
|
32
|
+
```mermaid
|
|
33
|
+
flowchart LR
|
|
34
|
+
User[User / Actor] --> App[Module / Application]
|
|
35
|
+
App --> API[API / Service]
|
|
36
|
+
API --> Data[(Data Store)]
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Clarifies:
|
|
40
|
+
- Spec / AC:
|
|
41
|
+
- Decision / risk / verification path:
|
|
42
|
+
|
|
43
|
+
### Sequence / Flow View
|
|
44
|
+
|
|
45
|
+
```mermaid
|
|
46
|
+
sequenceDiagram
|
|
47
|
+
actor User
|
|
48
|
+
participant UI as UI
|
|
49
|
+
participant API as API
|
|
50
|
+
User->>UI: Trigger scenario
|
|
51
|
+
UI->>API: Request
|
|
52
|
+
API-->>UI: Response
|
|
53
|
+
UI-->>User: Observable result
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Clarifies:
|
|
57
|
+
- Spec / AC:
|
|
58
|
+
- Decision / risk / verification path:
|
|
59
|
+
|
|
60
|
+
### State View
|
|
61
|
+
|
|
62
|
+
```mermaid
|
|
63
|
+
stateDiagram-v2
|
|
64
|
+
[*] --> Loading
|
|
65
|
+
Loading --> Success
|
|
66
|
+
Loading --> Error
|
|
67
|
+
Error --> Retry
|
|
68
|
+
Retry --> Loading
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Clarifies:
|
|
72
|
+
- Spec / AC:
|
|
73
|
+
- Decision / risk / verification path:
|
|
74
|
+
|
|
75
|
+
### Data Flow / UX Flow View
|
|
76
|
+
|
|
77
|
+
N/A rationale or diagram:
|
|
78
|
+
|
|
9
79
|
## Decisions
|
|
10
80
|
|
|
11
|
-
|
|
|
12
|
-
| --- | --- | --- | --- |
|
|
13
|
-
| | | | |
|
|
81
|
+
| ADR | Context / Requirement | Options Considered | Decision | Consequences / Risks | Rollback / Migration | Verification |
|
|
82
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
83
|
+
| ADR-001 | | | | | | |
|
|
84
|
+
|
|
85
|
+
Use `N/A` only when no architecture, interface, data-flow, storage, migration, dependency, rollback, integration, cross-team ownership, security, or permission-enforcement decision is made.
|
|
14
86
|
|
|
15
87
|
## States And Failure Modes
|
|
16
88
|
|
|
@@ -32,8 +104,19 @@ Guidelines:
|
|
|
32
104
|
- Prefer user-facing locators: `getByRole`, `getByLabel`, `getByPlaceholder`, `getByTestId`.
|
|
33
105
|
- Add implementation tasks for missing accessible names, labels, or stable test ids.
|
|
34
106
|
- Define auth/storage reuse before demo so Playwright can run repeatably.
|
|
107
|
+
- Keep generated docs, issues, evidence, and Playwright assets inside the `.zsk` paths required by `PROJECT-CONFIG.md` and `SYSTEM-SPEC.md`.
|
|
35
108
|
- Route unclear behavior back to spec instead of redesigning requirements here.
|
|
36
109
|
|
|
110
|
+
## Best-Practice Checklist
|
|
111
|
+
|
|
112
|
+
- [ ] Behavior maps to files/modules/interfaces/state/data flow without changing approved requirements.
|
|
113
|
+
- [ ] Design includes useful diagrams/charts for context, flow, state, data, dependency, or UX where complexity requires them; otherwise N/A rationale is explicit.
|
|
114
|
+
- [ ] ADR/decision-record entries capture context, options, decision, consequences, rollback/migration, and verification for design-significant decisions.
|
|
115
|
+
- [ ] Auth/permission/privacy/security/data-access scope has a control traceability matrix, or N/A cites source evidence.
|
|
116
|
+
- [ ] Security/auth/privacy, migration/rollback, performance, and rollout risks are recorded when touched.
|
|
117
|
+
- [ ] UI work includes accessible locator/state strategy and Playwright evidence needs.
|
|
118
|
+
- [ ] Project military rules from `PROJECT-CONFIG.md` and `SYSTEM-SPEC.md` are enforced or blocked.
|
|
119
|
+
|
|
37
120
|
## Documentation Feedback
|
|
38
121
|
|
|
39
122
|
- No-update rationale:
|
|
@@ -1,11 +1,21 @@
|
|
|
1
1
|
# __MODULE_NAME__ Proposal
|
|
2
2
|
|
|
3
|
+
## Project Rules Gate
|
|
4
|
+
|
|
5
|
+
| Rule Source | Rule / Constraint | Proposal Impact | Status |
|
|
6
|
+
| --- | --- | --- | --- |
|
|
7
|
+
| `.zsk/docs/PROJECT-CONFIG.md` | | | TODO |
|
|
8
|
+
| `.zsk/docs/SYSTEM-SPEC.md` | | | TODO |
|
|
9
|
+
|
|
10
|
+
Do not draft or pass this proposal until project-level path, source-priority, evidence, issue-routing, and stage-document rules from both files are reflected here or explicitly blocked.
|
|
11
|
+
|
|
3
12
|
## Problem
|
|
4
13
|
|
|
5
14
|
- Target user / stakeholder:
|
|
6
15
|
- Problem:
|
|
7
16
|
- Why now:
|
|
8
17
|
- Source evidence:
|
|
18
|
+
- Project-rule evidence:
|
|
9
19
|
|
|
10
20
|
## Scope
|
|
11
21
|
|
|
@@ -26,6 +36,13 @@
|
|
|
26
36
|
| --- | --- | --- |
|
|
27
37
|
| | | |
|
|
28
38
|
|
|
39
|
+
## Best-Practice Checklist
|
|
40
|
+
|
|
41
|
+
- [ ] Problem, target user, business outcome, scope, non-goals, success criteria, risks, and blockers are explicit.
|
|
42
|
+
- [ ] Local configured sources were used before external/current research.
|
|
43
|
+
- [ ] External/current research, if used, is separated from accepted product requirements.
|
|
44
|
+
- [ ] Conflicts with `PROJECT-CONFIG.md` or `SYSTEM-SPEC.md` are recorded as blockers or issues.
|
|
45
|
+
|
|
29
46
|
## Documentation Feedback
|
|
30
47
|
|
|
31
48
|
- No-update rationale:
|
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# __MODULE_NAME__ Spec
|
|
2
2
|
|
|
3
|
+
## Project Rules Gate
|
|
4
|
+
|
|
5
|
+
| Rule Source | Rule / Constraint | Behavior Impact | Status |
|
|
6
|
+
| --- | --- | --- | --- |
|
|
7
|
+
| `.zsk/docs/PROJECT-CONFIG.md` | | | TODO |
|
|
8
|
+
| `.zsk/docs/SYSTEM-SPEC.md` | | | TODO |
|
|
9
|
+
|
|
10
|
+
Do not freeze this spec until source-priority, conflict-routing, evidence, and stage-document rules from both project files are reflected in requirements, scenarios, and acceptance criteria.
|
|
11
|
+
|
|
3
12
|
## Behavior Contract
|
|
4
13
|
|
|
5
14
|
| ID | Requirement | Type | Source / Decision | Priority | Observable Outcome |
|
|
@@ -12,6 +21,14 @@
|
|
|
12
21
|
| --- | --- | --- | --- |
|
|
13
22
|
| AC-001 | FR-001 | Given / When / Then | |
|
|
14
23
|
|
|
24
|
+
## Control Matrix When Triggered
|
|
25
|
+
|
|
26
|
+
Use this table when the module touches auth, permissions, roles, tenancy, data access, compliance, audit, privacy, or security. If none apply, write an evidence-backed N/A rationale.
|
|
27
|
+
|
|
28
|
+
| Source Rule | Subject / Actor | Action / Capability | Resource / Data | Scope | Expected Outcome | FR/AC / Scenario |
|
|
29
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
30
|
+
| N/A or source id | | | | | | |
|
|
31
|
+
|
|
15
32
|
## Scenario Contracts
|
|
16
33
|
|
|
17
34
|
| Scenario | User Goal | Entry | Preconditions | Observable Result | PRD/SRS / FR/AC | Automate |
|
|
@@ -22,11 +39,20 @@ Rules:
|
|
|
22
39
|
|
|
23
40
|
- Define behavior and observable outcomes here.
|
|
24
41
|
- Link every P0/P1 scenario back to the original PRD/SRS or accepted FR/AC.
|
|
42
|
+
- Link every project-wide rule that changes behavior back to `PROJECT-CONFIG.md` or `SYSTEM-SPEC.md`.
|
|
43
|
+
- Include a control matrix when auth/permission/privacy/security/data-access behavior is touched; N/A needs evidence.
|
|
25
44
|
- Mark unclear or conflicting facts as blockers instead of choosing behavior silently.
|
|
26
45
|
- Do not write brittle selectors in spec.
|
|
27
46
|
- Mark which P0/P1 scenarios must become Playwright cases.
|
|
28
47
|
- Keep implementation choices out unless they are part of the product contract.
|
|
29
48
|
|
|
49
|
+
## Best-Practice Checklist
|
|
50
|
+
|
|
51
|
+
- [ ] FR/NFR, scenarios, edge cases, and acceptance criteria are observable.
|
|
52
|
+
- [ ] Every P0/P1 behavior has a source link or is explicitly marked as an assumption/blocker.
|
|
53
|
+
- [ ] Project military rules from `PROJECT-CONFIG.md` and `SYSTEM-SPEC.md` are enforced or blocked.
|
|
54
|
+
- [ ] Design can proceed without hidden chat context.
|
|
55
|
+
|
|
30
56
|
## Documentation Feedback
|
|
31
57
|
|
|
32
58
|
- No-update rationale:
|
|
@@ -1,16 +1,57 @@
|
|
|
1
1
|
# __MODULE_NAME__ Tasks
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Project Rules Gate
|
|
4
4
|
|
|
5
|
-
|
|
|
6
|
-
| --- | --- | --- | --- |
|
|
7
|
-
|
|
|
5
|
+
| Rule Source | Rule / Constraint | Task Impact | Status |
|
|
6
|
+
| --- | --- | --- | --- |
|
|
7
|
+
| `.zsk/docs/PROJECT-CONFIG.md` | | | TODO |
|
|
8
|
+
| `.zsk/docs/SYSTEM-SPEC.md` | | | TODO |
|
|
9
|
+
|
|
10
|
+
Do not start coding until path boundaries, evidence routing, issue routing, validation commands, and source-priority rules from both project files are reflected in the task list or recorded as blockers.
|
|
11
|
+
|
|
12
|
+
## Task Todo List
|
|
13
|
+
|
|
14
|
+
- [ ] 1. <task group: deliverable outcome>
|
|
15
|
+
- Owner:
|
|
16
|
+
- Depends on:
|
|
17
|
+
- Scope / files:
|
|
18
|
+
- Linked FR/AC:
|
|
19
|
+
- Evidence hook:
|
|
20
|
+
- Stop condition:
|
|
21
|
+
- [ ] 1.1 <subtask: executable step>
|
|
22
|
+
- Owner:
|
|
23
|
+
- Output:
|
|
24
|
+
- Evidence:
|
|
25
|
+
- [ ] 1.2 <subtask: executable step>
|
|
26
|
+
- Owner:
|
|
27
|
+
- Output:
|
|
28
|
+
- Evidence:
|
|
29
|
+
|
|
30
|
+
## Dependency Order
|
|
31
|
+
|
|
32
|
+
| Order | Task / Subtask | Depends On | Can Run In Parallel With | Blocker / Decision Needed |
|
|
33
|
+
| --- | --- | --- | --- | --- |
|
|
34
|
+
| 1 | 1.1 | | | |
|
|
8
35
|
|
|
9
|
-
##
|
|
36
|
+
## Proposal / Spec / Design / ADR Alignment Matrix
|
|
10
37
|
|
|
11
|
-
| FR/AC
|
|
38
|
+
| Goal / FR / AC / NFR | Design Decision / ADR | Task Group | Subtask | Evidence |
|
|
39
|
+
| --- | --- | --- | --- | --- |
|
|
40
|
+
| FR-001 / AC-001 | ADR-001 | 1 | 1.1 | |
|
|
41
|
+
|
|
42
|
+
## FR / AC Coverage Matrix
|
|
43
|
+
|
|
44
|
+
| FR/AC | Implementation Task/Subtask | Test / Scenario Task/Subtask | Docs / Issue / Evidence Task/Subtask |
|
|
12
45
|
| --- | --- | --- | --- |
|
|
13
|
-
| FR-001 / AC-001 |
|
|
46
|
+
| FR-001 / AC-001 | 1.1 | 1.2 | |
|
|
47
|
+
|
|
48
|
+
## Control Row Task Coverage When Triggered
|
|
49
|
+
|
|
50
|
+
Use this table when spec/design include auth, permission, privacy, security, tenancy, compliance, audit, or data-access control rows. If none apply, write an evidence-backed N/A rationale.
|
|
51
|
+
|
|
52
|
+
| Control Row | Implementation Task | Test / Scenario Task | Docs / Issue Task | Evidence |
|
|
53
|
+
| --- | --- | --- | --- | --- |
|
|
54
|
+
| N/A or CTRL-001 | | | | |
|
|
14
55
|
|
|
15
56
|
## Playwright Case Tasks
|
|
16
57
|
|
|
@@ -20,11 +61,16 @@
|
|
|
20
61
|
|
|
21
62
|
Rules:
|
|
22
63
|
|
|
64
|
+
- Use a Kiro-style checkbox hierarchy: `- [ ] 1. <task group>` with indented `- [ ] 1.1 <subtask>` children.
|
|
65
|
+
- Every task and subtask must have owner, dependency, output, evidence hook, and stop condition.
|
|
66
|
+
- Every design decision/ADR must map to task groups, subtasks, and evidence or an explicit blocker.
|
|
67
|
+
- Every triggered control row must map to implementation, test/scenario, docs/issue, and evidence tasks.
|
|
23
68
|
- Create Playwright skeletons under `__PLAYWRIGHT_SPECS__` before demo.
|
|
24
69
|
- Create or update source-aligned tests/scenarios before implementation for testable behavior changes.
|
|
25
70
|
- Tag cases as smoke/demo/verify/regression.
|
|
26
71
|
- Include tasks for labels/test ids required by stable locators.
|
|
27
72
|
- Do not create vague tasks such as "implement feature"; each task needs scope, dependency, and evidence.
|
|
73
|
+
- Do not treat docs feedback, issue updates, evidence capture, or verification as optional cleanup.
|
|
28
74
|
|
|
29
75
|
## Documentation Feedback
|
|
30
76
|
|
|
@@ -5,102 +5,14 @@ layoutVersion: 2
|
|
|
5
5
|
project:
|
|
6
6
|
name: "<project-name>"
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
raws: .zsk/raws
|
|
12
|
-
issues: .zsk/issues
|
|
13
|
-
evidence: .zsk/evidence
|
|
14
|
-
playwright: .zsk/playwright
|
|
8
|
+
template:
|
|
9
|
+
id: founder-os
|
|
10
|
+
version: 1
|
|
15
11
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
# Optional snapshots should land under paths.raws with stable role/provider paths.
|
|
19
|
-
# Dates belong in manifest metadata such as syncedAt, not in path authority.
|
|
20
|
-
#
|
|
21
|
-
# sources:
|
|
22
|
-
# srs:
|
|
23
|
-
# type: srs
|
|
24
|
-
# origin:
|
|
25
|
-
# kind: url
|
|
26
|
-
# url: https://example.com/srs
|
|
27
|
-
# snapshot: .zsk/raws/product/srs.md
|
|
28
|
-
# design_main:
|
|
29
|
-
# type: design
|
|
30
|
-
# origin:
|
|
31
|
-
# kind: design
|
|
32
|
-
# provider: figma
|
|
33
|
-
# url: https://www.figma.com/file/...
|
|
34
|
-
# snapshot: .zsk/raws/ue/design-main.json
|
|
35
|
-
# backend_api:
|
|
36
|
-
# type: api_contract
|
|
37
|
-
# origin:
|
|
38
|
-
# kind: git
|
|
39
|
-
# repository: https://github.com/example/backend-api.git
|
|
40
|
-
# path: openapi.yaml
|
|
41
|
-
# snapshot: .zsk/raws/backend/api-contract.yaml
|
|
42
|
-
# acceptance_cases:
|
|
43
|
-
# type: test_case
|
|
44
|
-
# origin:
|
|
45
|
-
# kind: url
|
|
46
|
-
# url: https://example.com/qa-cases
|
|
47
|
-
# snapshot: .zsk/raws/qa/testing/acceptance-cases.md
|
|
48
|
-
sources: {}
|
|
49
|
-
|
|
50
|
-
tools:
|
|
51
|
-
runtime_ui:
|
|
52
|
-
- playwright_cli
|
|
53
|
-
- playwright_mcp
|
|
54
|
-
- playwright
|
|
55
|
-
- computer_use
|
|
56
|
-
- browser_use
|
|
57
|
-
design:
|
|
58
|
-
- manual
|
|
59
|
-
- figma_mcp
|
|
12
|
+
mode: standard
|
|
13
|
+
scale: auto
|
|
60
14
|
|
|
61
|
-
|
|
62
|
-
index: .zsk/modules/index.md
|
|
63
|
-
root: .zsk/modules
|
|
15
|
+
sources: {}
|
|
64
16
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
commands:
|
|
68
|
-
- pnpm lint
|
|
69
|
-
- pnpm typecheck
|
|
70
|
-
- pnpm test
|
|
71
|
-
deploy:
|
|
72
|
-
command: pnpm deploy:staging
|
|
73
|
-
demo:
|
|
74
|
-
# Default optimized lane:
|
|
75
|
-
# - Formal test cases come from module tests.raw_cases or sources.testing, normally snapshots under .zsk/raws/qa/testing.
|
|
76
|
-
# - Playwright storageState is the preferred way to reuse login/session state without stopping on login pages.
|
|
77
|
-
# - Computer Use is the preferred visual/current-page observation lane when it is available and authorized.
|
|
78
|
-
# - Browser Use is optional and runtime-specific; use it only where the agent platform supports it and permissions are available.
|
|
79
|
-
# - If neither Computer Use nor Browser Use exists, use Playwright MCP/ARIA/CDP snapshots or documented manual evidence as the compatible handoff.
|
|
80
|
-
# - zsk/agent generation writes test-plan.json, then Playwright CLI/Skills generate executable .spec.ts cases.
|
|
81
|
-
# - Playwright Test executes/debugs and records evidence. No MCP or bridge fallback is used in optimized mode.
|
|
82
|
-
# - Use --hybrid explicitly for the legacy bridge lane.
|
|
83
|
-
defaultMode: optimized
|
|
84
|
-
baseUrl: http://localhost:3000
|
|
85
|
-
command: pnpm dev
|
|
86
|
-
evidenceDir: .zsk/modules/{module}/_evidence/demo
|
|
87
|
-
scenarioDir: .zsk/modules/{module}/_playwright/specs
|
|
88
|
-
playwright:
|
|
89
|
-
config: playwright.config.ts
|
|
90
|
-
project: chromium
|
|
91
|
-
cli: playwright-cli
|
|
92
|
-
computerUse:
|
|
93
|
-
enabled: false
|
|
94
|
-
role: understand-and-decide
|
|
95
|
-
bridge:
|
|
96
|
-
enabled: true
|
|
97
|
-
# Legacy hybrid-only bridge. Not used by defaultMode: optimized.
|
|
98
|
-
# Prefer computer_use for visual/system-level understanding when available.
|
|
99
|
-
# Fall back to playwright_mcp for structured accessibility snapshots, or browser_use only on runtimes that support it.
|
|
100
|
-
decisionTool: playwright_mcp
|
|
101
|
-
executionTool: playwright
|
|
102
|
-
planFile: .zsk/modules/{module}/_playwright/execution/operation-plan.json
|
|
103
|
-
executionFile: .zsk/modules/{module}/_playwright/execution/playwright-execution.json
|
|
104
|
-
verify:
|
|
105
|
-
commands:
|
|
106
|
-
- pnpm test:e2e
|
|
17
|
+
customize:
|
|
18
|
+
roles: .zsk/roles.yaml
|
|
@@ -20,6 +20,7 @@ Agents must use the smallest sufficient lane: read local sources first, run dete
|
|
|
20
20
|
- `paths.docs` stores project-level docs only.
|
|
21
21
|
- `paths.modules` stores module source-of-truth docs.
|
|
22
22
|
- `paths.raws` stores immutable shared source snapshots and manually provided fact sources.
|
|
23
|
+
- `preproposal` may add candidate/generated product, roadmap, UX, and design-source readiness resources under `paths.raws` only when provenance, assumptions, review checkpoint status, and blockers are explicit.
|
|
23
24
|
- Module `_issues` stores module-specific actionable issue records; `paths.issues` is created on demand only for shared/global indexes or cross-module issues.
|
|
24
25
|
- Module `_evidence` stores module-specific runtime evidence and verification artifacts; `paths.evidence` is created on demand only for shared/global evidence.
|
|
25
26
|
- Module `_playwright` stores module-specific Playwright specs, plans, auth state, results, reports, and execution records; `paths.playwright` is created on demand only for shared Playwright assets.
|
|
@@ -46,6 +47,7 @@ ZSK stage documents are decision artifacts. They are complete only when the next
|
|
|
46
47
|
| Stage | Document Mode | Must Prove |
|
|
47
48
|
| --- | --- | --- |
|
|
48
49
|
| `prepare` | Evidence report | Source origins, freshness, conflicts, and raw snapshot paths are known before planning. |
|
|
50
|
+
| `preproposal` | Decision brief | Product direction, MVP/phase split, UX/design readiness, assumptions, risks, and readiness review are complete before proposal when no reviewed source pack exists. |
|
|
49
51
|
| `proposal` | Decision brief | Problem, user/business outcome, scope, non-goals, risks, and success criteria are explicit. |
|
|
50
52
|
| `spec` | Behavior contract | FR/NFR, scenarios, edge cases, and acceptance criteria are observable and source-linked. |
|
|
51
53
|
| `design` | Implementation contract | Behavior maps to files/modules/interfaces/state/data flow, with risks and verification strategy. |
|
|
@@ -2,6 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
Immutable fact sources for this project. Generated and refreshed by `zsk prep`.
|
|
4
4
|
|
|
5
|
+
Active source snapshots should be organized by prepare responsibility lane:
|
|
6
|
+
|
|
7
|
+
- `prepare/product/` for SRS, PRD, business process, acceptance semantics, and work items.
|
|
8
|
+
- `prepare/product/{topic}/product-brief.md` and `roadmap.md` for preproposal-generated product direction and MVP/phase decomposition after checkpoint review.
|
|
9
|
+
- `prepare/backend/` for backend repositories, API contracts, data model, and service-boundary evidence.
|
|
10
|
+
- `prepare/design/` for design/prototype sources, screen maps, and visual assets.
|
|
11
|
+
- `prepare/design/{topic}/design-source-needs.md` for preproposal design-source readiness gaps after checkpoint review.
|
|
12
|
+
- `prepare/ux/` for user flows, interaction notes, IA, and usability evidence.
|
|
13
|
+
- `prepare/ux/{topic}/ux-readiness.md` for preproposal journey/flow/IA/readiness seeds after checkpoint review.
|
|
14
|
+
- `prepare/qa/` for test cases, acceptance scenarios, regression matrices, and QA evidence.
|
|
15
|
+
|
|
5
16
|
| Provider | Type | Status | Snapshot / Origin |
|
|
6
17
|
| --- | --- | --- | --- |
|
|
7
18
|
| | | | |
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# ZSK role resource pool.
|
|
2
|
+
# Skills dispatch work to these roles as needed; stages and lanes are routing
|
|
3
|
+
# hints, not hard limits. Projects may add roles or lane aliases freely.
|
|
4
|
+
|
|
5
|
+
version: 1
|
|
6
|
+
|
|
7
|
+
roles:
|
|
8
|
+
lead-integrator:
|
|
9
|
+
subagentType: planner
|
|
10
|
+
required: true
|
|
11
|
+
activation: required
|
|
12
|
+
reason: Own stage scope, dispatch boundaries, integration, and final evidence.
|
|
13
|
+
|
|
14
|
+
product-owner:
|
|
15
|
+
subagentType: analyst
|
|
16
|
+
stages: [prepare, preproposal, proposal, spec, review, verify, acceptance]
|
|
17
|
+
lanes: [product, pm, requirement, requirements, srs, prd]
|
|
18
|
+
activation: when product or requirement evidence is configured or in scope
|
|
19
|
+
reason: Interpret product scope, requirement semantics, priorities, and acceptance gaps.
|
|
20
|
+
|
|
21
|
+
business-analyst:
|
|
22
|
+
subagentType: analyst
|
|
23
|
+
stages: [preproposal, proposal, spec]
|
|
24
|
+
lanes: [business, domain, process, rules]
|
|
25
|
+
activation: when domain process or business-rule evidence is configured or in scope
|
|
26
|
+
reason: Map domain process, terminology, business rules, and edge cases.
|
|
27
|
+
|
|
28
|
+
architect:
|
|
29
|
+
subagentType: architect
|
|
30
|
+
stages: [preproposal, proposal, spec, design, review]
|
|
31
|
+
activation: when architecture, API, system-boundary, or dependency decisions are in scope
|
|
32
|
+
reason: Review system boundaries, module relationships, contracts, and technical risks.
|
|
33
|
+
|
|
34
|
+
backend-engineer:
|
|
35
|
+
subagentType: executor
|
|
36
|
+
stages: [prepare, design]
|
|
37
|
+
lanes: [backend, api, service, server, repository, repo, repos]
|
|
38
|
+
activation: when backend, API, service, repository, or data sources are configured
|
|
39
|
+
reason: Inspect backend sources, API contracts, data models, and service-boundary gaps.
|
|
40
|
+
|
|
41
|
+
frontend-engineer:
|
|
42
|
+
subagentType: executor
|
|
43
|
+
stages: [design]
|
|
44
|
+
lanes: [frontend, web, client, mobile]
|
|
45
|
+
activation: when frontend implementation, routing, state, or UI integration is in scope
|
|
46
|
+
reason: Map UI implementation, routing, state, and component integration risk.
|
|
47
|
+
|
|
48
|
+
design-specialist:
|
|
49
|
+
subagentType: designer
|
|
50
|
+
stages: [prepare, preproposal, design]
|
|
51
|
+
lanes: [design, ui, visual]
|
|
52
|
+
activation: when design, UI, visual, prototype, or asset sources are configured
|
|
53
|
+
reason: Inspect design assets, screens, visual states, and design-source gaps.
|
|
54
|
+
|
|
55
|
+
ux-specialist:
|
|
56
|
+
subagentType: designer
|
|
57
|
+
stages: [prepare, preproposal]
|
|
58
|
+
lanes: [ux, ue, user-experience, research]
|
|
59
|
+
activation: when UX, UE, user-flow, or research sources are configured
|
|
60
|
+
reason: Inspect user flows, interaction constraints, and usability ambiguity.
|
|
61
|
+
|
|
62
|
+
qa-engineer:
|
|
63
|
+
subagentType: test-engineer
|
|
64
|
+
stages: [prepare, preproposal, spec, task, coding, fix, review, verify]
|
|
65
|
+
lanes: [qa, test, testing, quality]
|
|
66
|
+
activation: when QA, test, acceptance, or quality evidence is configured or in scope
|
|
67
|
+
reason: Connect requirements to acceptance scenarios, test coverage, and verification evidence.
|
|
68
|
+
|
|
69
|
+
security-reviewer:
|
|
70
|
+
subagentType: security-reviewer
|
|
71
|
+
stages: [spec, design, review]
|
|
72
|
+
lanes: [security, sec, auth]
|
|
73
|
+
activation: when auth, permission, privacy, or data-safety boundaries are in scope
|
|
74
|
+
reason: Review trust boundaries, credentials, privacy, and abuse cases.
|
|
75
|
+
|
|
76
|
+
operations-engineer:
|
|
77
|
+
subagentType: executor
|
|
78
|
+
lanes: [ops, devops, release, deploy, platform]
|
|
79
|
+
activation: when environment, CI/CD, deployment, or platform risks are configured or in scope
|
|
80
|
+
reason: Review release, deployment, rollback, and operational risks.
|
|
81
|
+
|
|
82
|
+
auth-fetch-agent:
|
|
83
|
+
subagentType: researcher
|
|
84
|
+
stages: [prepare]
|
|
85
|
+
remoteSources: true
|
|
86
|
+
activation: when remote or provider-managed sources are configured
|
|
87
|
+
reason: Materialize remote/provider sources through explicit auth, session, and fetch contracts.
|
|
88
|
+
|
|
89
|
+
researcher:
|
|
90
|
+
subagentType: researcher
|
|
91
|
+
stages: [prepare, preproposal]
|
|
92
|
+
activation: optional when current official or external evidence is required
|
|
93
|
+
reason: Collect official/current external references only when configured local sources are insufficient.
|
|
94
|
+
|
|
95
|
+
planner:
|
|
96
|
+
subagentType: planner
|
|
97
|
+
stages: [preproposal, task]
|
|
98
|
+
activation: when task sequencing, dependencies, and risk flags are in scope
|
|
99
|
+
reason: Sequence implementation tasks, dependencies, ownership, and evidence hooks.
|
|
100
|
+
|
|
101
|
+
executor:
|
|
102
|
+
subagentType: executor
|
|
103
|
+
stages: [task, coding, fix]
|
|
104
|
+
activation: when implementation ownership, write scope, or scoped code changes are in scope
|
|
105
|
+
reason: Implement or estimate scoped code ownership and write boundaries.
|
|
106
|
+
|
|
107
|
+
technical-writer:
|
|
108
|
+
subagentType: writer
|
|
109
|
+
stages: [proposal, archive]
|
|
110
|
+
activation: when documentation structure, decision records, or handoff clarity are in scope
|
|
111
|
+
reason: Preserve traceable docs, decisions, and reusable learning.
|
|
112
|
+
|
|
113
|
+
senior-engineering-reviewer:
|
|
114
|
+
subagentType: code-reviewer
|
|
115
|
+
stages: [review]
|
|
116
|
+
activation: when execution-path correctness, maintainability, regressions, or API compatibility need review
|
|
117
|
+
reason: Review execution-path correctness, maintainability, regressions, and API boundaries.
|
|
118
|
+
|
|
119
|
+
ue-a11y-reviewer:
|
|
120
|
+
subagentType: designer
|
|
121
|
+
stages: [review]
|
|
122
|
+
activation: when UI, UX, accessibility, i18n, or visual behavior is touched
|
|
123
|
+
reason: Review UX, accessibility, i18n, and visual impacts when UI is touched.
|
|
124
|
+
|
|
125
|
+
verifier:
|
|
126
|
+
subagentType: verifier
|
|
127
|
+
required: true
|
|
128
|
+
activation: required
|
|
129
|
+
reason: Verify stage outputs against source authority and command evidence.
|