create-yss-spec 1.1.1 → 1.1.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/package.json +1 -1
- package/template/.agents/skills/high-fidelity-html-prototype/SKILL.md +102 -0
- package/template/.codex/skills/high-fidelity-html-prototype/SKILL.md +102 -0
- package/template/.codex/skills/high-fidelity-html-prototype/agents/openai.yaml +5 -0
- package/template/.codex/skills/product-design-prototype/SKILL.md +2 -4
- package/template/.codex/skills/prototype-review/SKILL.md +7 -7
- package/template/.codex/skills/yss-design-system/SKILL.md +4 -2
- package/template/.codex/skills/yss-product-lifecycle/SKILL.md +10 -7
- package/template/.codex/skills/yss-product-lifecycle/references/artifact-checklist.md +1 -0
- package/template/.codex/skills/yss-product-lifecycle/references/stage-routing.md +1 -1
- package/template/.codex/skills/yss-ui/SKILL.md +4 -10
- package/template/.codex/skills/yss-ui/references/quick-recipes.md +1 -1
- package/template/AGENTS.md +9 -3
- package/template/CONTEXT.md +1 -0
- package/template/docs/api/templates/openapi-draft-review-checklist.md +3 -1
- package/template/docs/design/README.md +7 -4
- package/template/docs/design/prototypes/.gitkeep +1 -0
- package/template/docs/design/templates/interaction-spec-template.md +5 -3
- package/template/docs/design/templates/product-overview-design-template.md +34 -5
- package/template/docs/design/templates/prototype-review-checklist.md +3 -3
- package/template/docs/process/harness-executive-blueprint.md +5 -1
- package/template/docs/process/harness-process-tailoring.md +3 -3
- package/template/docs/process/harness-work-unit-map.md +1 -1
- package/template/docs/process/lifecycle-artifact-map.md +6 -5
- package/template/docs/templates/requirement-freeze-template.md +4 -3
- package/template/docs/user-guide/product-lifecycle-workflow.md +2 -2
- package/template/docs/user-guide/product-rd-lifecycle-best-practices.md +44 -19
- package/template/.codex/skills/component-story-prototype/SKILL.md +0 -55
- package/template/.codex/skills/component-story-prototype/agents/openai.yaml +0 -4
- package/template/.codex/skills/mock-api-prototype/SKILL.md +0 -48
- package/template/.codex/skills/mock-api-prototype/agents/openai.yaml +0 -4
package/package.json
CHANGED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: high-fidelity-html-prototype
|
|
3
|
+
description: Use after low-fidelity prototype review is approved and before PRD calibration, requirement freeze, OpenAPI Draft, or UI implementation when a user-facing YSS feature needs a high-fidelity interactive HTML prototype using Ant Design v6.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# High Fidelity HTML Prototype
|
|
7
|
+
|
|
8
|
+
Use this skill only after `prototype-review` approves the low-fidelity prototype / interaction design. It turns reviewed product design into a high-fidelity, browser-runnable HTML artifact for business, UX, frontend, and API review.
|
|
9
|
+
|
|
10
|
+
## Required Inputs
|
|
11
|
+
|
|
12
|
+
- PRD baseline: `docs/requirements/<feature>-prd.md`.
|
|
13
|
+
- Product overview design / functional architecture: `docs/design/<feature>-product-overview-design.md`.
|
|
14
|
+
- Interaction spec: `docs/design/<feature>-interaction-spec.md`.
|
|
15
|
+
- State matrix: `docs/design/<feature>-state-matrix.md`.
|
|
16
|
+
- Approved low-fidelity prototype review: `docs/design/<feature>-prototype-review.md` or equivalent issue comment.
|
|
17
|
+
- Project design system: `docs/design/design.md` and `docs/design/tokens/*`.
|
|
18
|
+
|
|
19
|
+
If low-fidelity `prototype-review` is blocked or missing, stop and return to `product-design-prototype` / `prototype-review`.
|
|
20
|
+
|
|
21
|
+
## Ant Design Official Agent Baseline
|
|
22
|
+
|
|
23
|
+
Use the official Ant Design agent guidance as the implementation baseline:
|
|
24
|
+
|
|
25
|
+
- Read or reference `https://ant.design/docs/react/for-agents` when the task starts.
|
|
26
|
+
- Use `@ant-design/cli` before choosing unfamiliar components, props, tokens, or migration-sensitive APIs.
|
|
27
|
+
- Prefer direct CLI subcommands because `--help` may fail in some Node environments while subcommands still work.
|
|
28
|
+
|
|
29
|
+
Recommended commands:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm view antd version
|
|
33
|
+
npm view @ant-design/cli version
|
|
34
|
+
npx -y @ant-design/cli@6.5.0 info Button
|
|
35
|
+
npx -y @ant-design/cli@6.5.0 token Button
|
|
36
|
+
npx -y @ant-design/cli@6.5.0 demo Select basic
|
|
37
|
+
npx -y @ant-design/cli@6.5.0 changelog 5.0.0 6.5.0 Table
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Use the latest verified v6.x version instead of `6.5.0` when npm reports a newer v6 release. Record the exact version and any queried components in the output.
|
|
41
|
+
|
|
42
|
+
## Core Rules
|
|
43
|
+
|
|
44
|
+
- Output is HTML: `docs/design/prototypes/<feature>/index.html`.
|
|
45
|
+
- The prototype must use Ant Design v6. Before generating or updating code, verify the current v6 package with `npm view antd version` and `npm view @ant-design/cli version`. If the latest version is not v6.x, pin the newest available v6.x version and record the choice.
|
|
46
|
+
- Use React >= 18, `antd@6.x`, and `@ant-design/icons@6.x` for interactive prototypes.
|
|
47
|
+
- Prefer Ant Design components and tokens over hand-built controls: `Layout`, `Menu`, `Breadcrumb`, `Button`, `Input`, `Select`, `Table`, `Form`, `Tabs`, `Steps`, `Drawer`, `Modal`, `Alert`, `Tooltip`, `Tag`, `Badge`, `DatePicker`, `Upload`, `Pagination`, `Empty`, `Spin`, `Result`.
|
|
48
|
+
- Do not create extra data-service or fixture artifacts. Use embedded sample data inside the HTML/JS for visual and interaction demonstration only.
|
|
49
|
+
- Mark the file clearly as `PROTOTYPE ONLY - NOT PRODUCTION CODE`.
|
|
50
|
+
- Do not treat the HTML prototype as a stable frontend implementation, generated-client contract, or OpenAPI source of truth. It informs PRD calibration and OpenAPI Draft.
|
|
51
|
+
|
|
52
|
+
## Interaction Coverage
|
|
53
|
+
|
|
54
|
+
The HTML prototype must cover, or explicitly mark not applicable:
|
|
55
|
+
|
|
56
|
+
- Primary page navigation and page-to-page return path.
|
|
57
|
+
- Main task completion flow.
|
|
58
|
+
- Search / filter / sort / pagination behavior.
|
|
59
|
+
- Form input, validation, submit, cancel, dirty-form leave prompt.
|
|
60
|
+
- Drawer / modal / confirmation interactions.
|
|
61
|
+
- loading, empty, error, readonly, disabled, no-permission, conflict, success states.
|
|
62
|
+
- Permission behavior: hidden vs disabled vs rejected action.
|
|
63
|
+
- Field-level and page-level error placement.
|
|
64
|
+
- Responsive behavior for at least desktop, tablet, and narrow mobile viewport.
|
|
65
|
+
|
|
66
|
+
## Verification
|
|
67
|
+
|
|
68
|
+
Run a local browser verification before calling the artifact ready:
|
|
69
|
+
|
|
70
|
+
- Open `docs/design/prototypes/<feature>/index.html` or run the dev server if the prototype needs one.
|
|
71
|
+
- Check that the page renders nonblank.
|
|
72
|
+
- Exercise the main flow and at least one failure / permission / conflict state.
|
|
73
|
+
- Check at least one desktop and one mobile viewport.
|
|
74
|
+
- Record verification evidence in the response or in the related review / issue.
|
|
75
|
+
|
|
76
|
+
## Output Contract
|
|
77
|
+
|
|
78
|
+
```markdown
|
|
79
|
+
### 当前阶段
|
|
80
|
+
High-fidelity HTML prototype
|
|
81
|
+
|
|
82
|
+
### 输入资产
|
|
83
|
+
- <PRD / product overview / interaction spec / state matrix / prototype review>
|
|
84
|
+
|
|
85
|
+
### 高保真产物
|
|
86
|
+
- `docs/design/prototypes/<feature>/index.html`
|
|
87
|
+
|
|
88
|
+
### Ant Design v6 依据
|
|
89
|
+
- <antd version, @ant-design/cli version, official docs checked, CLI component/token/demo queries>
|
|
90
|
+
|
|
91
|
+
### 覆盖范围
|
|
92
|
+
- <pages, flows, states, permissions, data dependencies>
|
|
93
|
+
|
|
94
|
+
### 验证证据
|
|
95
|
+
- <render command or file open path, viewport checks, interaction checks>
|
|
96
|
+
|
|
97
|
+
### 是否可进入 PRD 校准 / API 影响分析
|
|
98
|
+
- <yes/no; list blocking gaps>
|
|
99
|
+
|
|
100
|
+
### 下一步
|
|
101
|
+
- <PRD calibration / return to high-fidelity prototype / return to product-design-prototype>
|
|
102
|
+
```
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: high-fidelity-html-prototype
|
|
3
|
+
description: Use after low-fidelity prototype review is approved and before PRD calibration, requirement freeze, OpenAPI Draft, or UI implementation when a user-facing YSS feature needs a high-fidelity interactive HTML prototype using Ant Design v6.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# High Fidelity HTML Prototype
|
|
7
|
+
|
|
8
|
+
Use this skill only after `prototype-review` approves the low-fidelity prototype / interaction design. It turns reviewed product design into a high-fidelity, browser-runnable HTML artifact for business, UX, frontend, and API review.
|
|
9
|
+
|
|
10
|
+
## Required Inputs
|
|
11
|
+
|
|
12
|
+
- PRD baseline: `docs/requirements/<feature>-prd.md`.
|
|
13
|
+
- Product overview design / functional architecture: `docs/design/<feature>-product-overview-design.md`.
|
|
14
|
+
- Interaction spec: `docs/design/<feature>-interaction-spec.md`.
|
|
15
|
+
- State matrix: `docs/design/<feature>-state-matrix.md`.
|
|
16
|
+
- Approved low-fidelity prototype review: `docs/design/<feature>-prototype-review.md` or equivalent issue comment.
|
|
17
|
+
- Project design system: `docs/design/design.md` and `docs/design/tokens/*`.
|
|
18
|
+
|
|
19
|
+
If low-fidelity `prototype-review` is blocked or missing, stop and return to `product-design-prototype` / `prototype-review`.
|
|
20
|
+
|
|
21
|
+
## Ant Design Official Agent Baseline
|
|
22
|
+
|
|
23
|
+
Use the official Ant Design agent guidance as the implementation baseline:
|
|
24
|
+
|
|
25
|
+
- Read or reference `https://ant.design/docs/react/for-agents` when the task starts.
|
|
26
|
+
- Use `@ant-design/cli` before choosing unfamiliar components, props, tokens, or migration-sensitive APIs.
|
|
27
|
+
- Prefer direct CLI subcommands because `--help` may fail in some Node environments while subcommands still work.
|
|
28
|
+
|
|
29
|
+
Recommended commands:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm view antd version
|
|
33
|
+
npm view @ant-design/cli version
|
|
34
|
+
npx -y @ant-design/cli@6.5.0 info Button
|
|
35
|
+
npx -y @ant-design/cli@6.5.0 token Button
|
|
36
|
+
npx -y @ant-design/cli@6.5.0 demo Select basic
|
|
37
|
+
npx -y @ant-design/cli@6.5.0 changelog 5.0.0 6.5.0 Table
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Use the latest verified v6.x version instead of `6.5.0` when npm reports a newer v6 release. Record the exact version and any queried components in the output.
|
|
41
|
+
|
|
42
|
+
## Core Rules
|
|
43
|
+
|
|
44
|
+
- Output is HTML: `docs/design/prototypes/<feature>/index.html`.
|
|
45
|
+
- The prototype must use Ant Design v6. Before generating or updating code, verify the current v6 package with `npm view antd version` and `npm view @ant-design/cli version`. If the latest version is not v6.x, pin the newest available v6.x version and record the choice.
|
|
46
|
+
- Use React >= 18, `antd@6.x`, and `@ant-design/icons@6.x` for interactive prototypes.
|
|
47
|
+
- Prefer Ant Design components and tokens over hand-built controls: `Layout`, `Menu`, `Breadcrumb`, `Button`, `Input`, `Select`, `Table`, `Form`, `Tabs`, `Steps`, `Drawer`, `Modal`, `Alert`, `Tooltip`, `Tag`, `Badge`, `DatePicker`, `Upload`, `Pagination`, `Empty`, `Spin`, `Result`.
|
|
48
|
+
- Do not create extra data-service or fixture artifacts. Use embedded sample data inside the HTML/JS for visual and interaction demonstration only.
|
|
49
|
+
- Mark the file clearly as `PROTOTYPE ONLY - NOT PRODUCTION CODE`.
|
|
50
|
+
- Do not treat the HTML prototype as a stable frontend implementation, generated-client contract, or OpenAPI source of truth. It informs PRD calibration and OpenAPI Draft.
|
|
51
|
+
|
|
52
|
+
## Interaction Coverage
|
|
53
|
+
|
|
54
|
+
The HTML prototype must cover, or explicitly mark not applicable:
|
|
55
|
+
|
|
56
|
+
- Primary page navigation and page-to-page return path.
|
|
57
|
+
- Main task completion flow.
|
|
58
|
+
- Search / filter / sort / pagination behavior.
|
|
59
|
+
- Form input, validation, submit, cancel, dirty-form leave prompt.
|
|
60
|
+
- Drawer / modal / confirmation interactions.
|
|
61
|
+
- loading, empty, error, readonly, disabled, no-permission, conflict, success states.
|
|
62
|
+
- Permission behavior: hidden vs disabled vs rejected action.
|
|
63
|
+
- Field-level and page-level error placement.
|
|
64
|
+
- Responsive behavior for at least desktop, tablet, and narrow mobile viewport.
|
|
65
|
+
|
|
66
|
+
## Verification
|
|
67
|
+
|
|
68
|
+
Run a local browser verification before calling the artifact ready:
|
|
69
|
+
|
|
70
|
+
- Open `docs/design/prototypes/<feature>/index.html` or run the dev server if the prototype needs one.
|
|
71
|
+
- Check that the page renders nonblank.
|
|
72
|
+
- Exercise the main flow and at least one failure / permission / conflict state.
|
|
73
|
+
- Check at least one desktop and one mobile viewport.
|
|
74
|
+
- Record verification evidence in the response or in the related review / issue.
|
|
75
|
+
|
|
76
|
+
## Output Contract
|
|
77
|
+
|
|
78
|
+
```markdown
|
|
79
|
+
### 当前阶段
|
|
80
|
+
High-fidelity HTML prototype
|
|
81
|
+
|
|
82
|
+
### 输入资产
|
|
83
|
+
- <PRD / product overview / interaction spec / state matrix / prototype review>
|
|
84
|
+
|
|
85
|
+
### 高保真产物
|
|
86
|
+
- `docs/design/prototypes/<feature>/index.html`
|
|
87
|
+
|
|
88
|
+
### Ant Design v6 依据
|
|
89
|
+
- <antd version, @ant-design/cli version, official docs checked, CLI component/token/demo queries>
|
|
90
|
+
|
|
91
|
+
### 覆盖范围
|
|
92
|
+
- <pages, flows, states, permissions, data dependencies>
|
|
93
|
+
|
|
94
|
+
### 验证证据
|
|
95
|
+
- <render command or file open path, viewport checks, interaction checks>
|
|
96
|
+
|
|
97
|
+
### 是否可进入 PRD 校准 / API 影响分析
|
|
98
|
+
- <yes/no; list blocking gaps>
|
|
99
|
+
|
|
100
|
+
### 下一步
|
|
101
|
+
- <PRD calibration / return to high-fidelity prototype / return to product-design-prototype>
|
|
102
|
+
```
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
version: 1
|
|
2
|
+
interface:
|
|
3
|
+
display_name: "High Fidelity HTML Prototype"
|
|
4
|
+
short_description: "Ant Design v6 interactive HTML prototype gate"
|
|
5
|
+
default_prompt: "Use $high-fidelity-html-prototype to create an Ant Design v6 high-fidelity interactive HTML prototype after low-fidelity prototype review."
|
|
@@ -25,7 +25,7 @@ If no PRD baseline exists, route back to `yss-product-lifecycle` / `grill-with-d
|
|
|
25
25
|
5. Write the OpenAPI implication list: fields, filters, actions, errors, permissions, pagination, optimistic/concurrency states, and audit/version data.
|
|
26
26
|
6. For every primary page action, add an action-to-contract row: page/component, action label, `actionKey`, endpoint or explicit non-goal, request fields, response shape, permission behavior, state transition, idempotency/concurrency rule, and error codes.
|
|
27
27
|
7. For every P0 requirement containing verbs such as manage, maintain, configure, create, update, archive, retry, cancel, publish, export, or create draft, confirm the interaction spec either names the API implication or records that the capability is intentionally out of scope.
|
|
28
|
-
8. Hand off to `prototype-review`. Do not freeze/calibrate the PRD or enter OpenAPI Draft for UI work until prototype
|
|
28
|
+
8. Hand off to `prototype-review`. After low-fidelity review is approved, hand off to `high-fidelity-html-prototype`. Do not freeze/calibrate the PRD or enter OpenAPI Draft for UI work until the Ant Design v6 high-fidelity HTML prototype exists and has no blocking findings.
|
|
29
29
|
|
|
30
30
|
## Tool Routing
|
|
31
31
|
|
|
@@ -33,8 +33,6 @@ If no PRD baseline exists, route back to `yss-product-lifecycle` / `grill-with-d
|
|
|
33
33
|
|---|---|
|
|
34
34
|
| Low-fidelity page or flow sketch | `wireframe-prototype` |
|
|
35
35
|
| Figma work or existing Figma file | `figma` / `figma-use` |
|
|
36
|
-
| Engineering state prototype | `component-story-prototype` |
|
|
37
|
-
| API not frozen but interactions need data | `mock-api-prototype` |
|
|
38
36
|
| YSS implementation constraints | `yss-router`, then `yss-ui`, `yss-formily`, `yss-page-module-development` as needed |
|
|
39
37
|
|
|
40
38
|
## Output Contract
|
|
@@ -67,7 +65,7 @@ Product design / prototype / interaction design
|
|
|
67
65
|
- <yes/no; include whether PRD calibration is needed first>
|
|
68
66
|
|
|
69
67
|
### 下一步
|
|
70
|
-
- <prototype-review
|
|
68
|
+
- <prototype-review / high-fidelity-html-prototype / routing back to PRD/design>
|
|
71
69
|
```
|
|
72
70
|
|
|
73
71
|
## Data Modeling Example
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: prototype-review
|
|
3
|
-
description: Use when reviewing UI design, wireframes, prototype links, interaction specs, or state matrices before PRD calibration, OpenAPI Draft, vertical slicing, or implementation.
|
|
3
|
+
description: Use when reviewing low-fidelity UI design, wireframes, prototype links, interaction specs, or state matrices before high-fidelity HTML prototype work, PRD calibration, OpenAPI Draft, vertical slicing, or implementation.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Prototype Review
|
|
7
7
|
|
|
8
|
-
Use this skill as the gate between product design/prototype work and
|
|
8
|
+
Use this skill as the low-fidelity gate between product design/prototype work and high-fidelity HTML prototype work. The review is fail-closed: if the design cannot drive calibrated requirements, API, frontend acceptance, and slices, send it back to product design.
|
|
9
9
|
|
|
10
10
|
## Required Inputs
|
|
11
11
|
|
|
@@ -27,13 +27,13 @@ Use this skill as the gate between product design/prototype work and PRD calibra
|
|
|
27
27
|
| Action contract coverage | Every primary page action has an `actionKey`, endpoint or explicit non-goal, permission behavior, state transition, idempotency/concurrency rule, and error codes |
|
|
28
28
|
| P0 contract coverage | Every P0 requirement with manage/maintain/configure/create/update/archive/retry/cancel/publish/export/create-draft semantics is mapped to an API implication or an explicit non-goal |
|
|
29
29
|
| Rule/source coverage | Validation, approval, coverage, and publish gates state where rules come from, who can configure them, whether they are fixed, and how blocker/warning decisions are represented |
|
|
30
|
-
| Frontend acceptance | A frontend engineer can tell which components,
|
|
30
|
+
| Frontend acceptance | A frontend engineer can tell which components, visible states, data dependencies, and E2E paths are needed |
|
|
31
31
|
|
|
32
32
|
## Decision Rules
|
|
33
33
|
|
|
34
|
-
- If a feature has UI impact and lacks page map, user flow, prototype/wireframe, or state matrix, block PRD calibration and OpenAPI Draft.
|
|
34
|
+
- If a feature has UI impact and lacks page map, user flow, prototype/wireframe, or state matrix, block high-fidelity HTML prototype work, PRD calibration, and OpenAPI Draft.
|
|
35
35
|
- If the prototype hides business rules behind generic text such as "校验失败", require field-level errors and recovery behavior.
|
|
36
|
-
- If a page shows a user action but the OpenAPI implication list lacks endpoint/non-goal mapping, block PRD calibration or OpenAPI Draft.
|
|
36
|
+
- If a page shows a user action but the OpenAPI implication list lacks endpoint/non-goal mapping, block high-fidelity HTML prototype work, PRD calibration, or OpenAPI Draft.
|
|
37
37
|
- If PRD P0 scope says a user can manage or configure an object but the design only shows read-only data, block until the write path or scope downgrade is explicit.
|
|
38
38
|
- If a state is intentionally out of scope, record why and who owns the decision.
|
|
39
39
|
- If implementation dependencies are unclear, route to `yss-router` only after the prototype passes this review.
|
|
@@ -57,10 +57,10 @@ Use this skill as the gate between product design/prototype work and PRD calibra
|
|
|
57
57
|
- <requirements gaps, acceptance criteria updates, non-goals, pending decisions>
|
|
58
58
|
|
|
59
59
|
### Frontend Prototype Readiness
|
|
60
|
-
- <
|
|
60
|
+
- <component states, data dependencies, frontend acceptance notes>
|
|
61
61
|
|
|
62
62
|
### Next Action
|
|
63
|
-
- <
|
|
63
|
+
- <high-fidelity-html-prototype / return to product-design-prototype>
|
|
64
64
|
```
|
|
65
65
|
|
|
66
66
|
Use `docs/design/templates/prototype-review-checklist.md` when writing a persistent review artifact.
|
|
@@ -70,12 +70,14 @@ description: YSS 产品设计系统与 Ant Design 企业级 UI 风格基线。
|
|
|
70
70
|
| 场景 | 配合技能 |
|
|
71
71
|
| --- | --- |
|
|
72
72
|
| PRD 后做页面 / 原型 / 交互说明 | `product-design-prototype` |
|
|
73
|
-
|
|
|
73
|
+
| 低保真原型进入高保真前评审 | `prototype-review` |
|
|
74
|
+
| 低保真评审通过后的高保真 HTML 原型 | `high-fidelity-html-prototype` |
|
|
74
75
|
| 低保真线框或流程图 | `wireframe-prototype` / `excalidraw-diagram-generator` |
|
|
75
76
|
| 前端页面实现 | `yss-ui` / `yss-page-module-development` |
|
|
76
77
|
| 表单 schema | `yss-formily` |
|
|
77
78
|
| YTable / YTree / 高度自适应 | `yss-components` / `yss-use-table-height` / `yss-use-tree-height` |
|
|
78
|
-
|
|
|
79
|
+
| Ant Design v6 组件 / token / demo 查询 | 官方 `@ant-design/cli` / `https://ant.design/docs/react/for-agents` |
|
|
80
|
+
| API 契约 / 接入 | `api-integration` / `yss-openapi` |
|
|
79
81
|
|
|
80
82
|
## 更新设计系统
|
|
81
83
|
|
|
@@ -63,7 +63,7 @@ Architecture artifacts are produced progressively. Do not try to finish every ar
|
|
|
63
63
|
| Artifact | Lifecycle timing | Primary question | Typical outputs | Diagram support |
|
|
64
64
|
|---|---|---|---|---|
|
|
65
65
|
| Business architecture | Opportunity exploration / Discovery / product definition | Who gets value, in which workflow, and where the product boundary sits | user journey, value stream, role/ecosystem model, capability map | journey map, swimlane, capability map |
|
|
66
|
-
| Product overview design / Functional architecture | PRD baseline / product design / PRD calibration | Which product capabilities, user flows, modules, pages, APIs, and data impacts support the MVP boundary | product overview, module map, feature list, priority, dependencies, state flow, open questions, PRD gaps | feature/module map, dependency graph, user flow, page map |
|
|
66
|
+
| Product overview design / Functional architecture | PRD baseline / product design / PRD calibration | Which product capabilities, user flows, modules, pages, low-fidelity prototypes, APIs, and data impacts support the MVP boundary | product overview, module map, feature list, priority, dependencies, low-fidelity wireframe, state flow, open questions, PRD gaps | feature/module map, dependency graph, user flow, page map, low-fidelity wireframe |
|
|
67
67
|
| System overview design / System architecture | Engineering baseline / architecture review | How the product is built, deployed, integrated, operated, and safely evolved | C4/container view, service boundary, integration, deployment, NFR decisions, rollout/rollback decisions | system architecture, sequence, deployment, DFD |
|
|
68
68
|
| Data architecture | Detailed design before persistence and repository work | How domain data, metadata, versions, lineage, and queries are modeled and stored | conceptual/logical/physical model, meta-model, versioning strategy, lineage/query/index strategy | ER, class, lineage graph, DFD |
|
|
69
69
|
|
|
@@ -90,7 +90,9 @@ Use `excalidraw-diagram-generator` when diagrams will make boundaries, flows, da
|
|
|
90
90
|
- service boundary, state machine, integration, NFR, rollout, or rollback -> system / data architecture, engineering contract, and Design Review downstream gates;
|
|
91
91
|
- persistence, metadata, versioning, lineage, query, or index -> system / data architecture, engineering contract, and Design Review downstream gates.
|
|
92
92
|
4. Check whether required upstream artifacts exist.
|
|
93
|
-
- Before formal vertical slicing, verify PRD
|
|
93
|
+
- Before PRD calibration, product design, API impact analysis, OpenAPI Draft, requirement freeze, or formal vertical slicing, verify PRD baseline and product overview design / functional architecture exist. If the task does not enter the PRD lifecycle, record the not-applicable reason in the impact assessment.
|
|
94
|
+
- For UI work, before PRD calibration, API impact analysis, OpenAPI Draft, or requirement freeze, verify low-fidelity `prototype-review` is approved and `docs/design/prototypes/<feature>/index.html` exists as an Ant Design v6 high-fidelity HTML prototype.
|
|
95
|
+
- Before formal vertical slicing, verify PRD, product overview design / functional architecture, OpenAPI Freeze or no-API-impact record, architecture review as needed, and a clear issue destination.
|
|
94
96
|
- For medium/high-risk API, permission, state-machine, data-model, cross-client, new-module, or safety-sensitive changes, verify an OpenSpec-style Spec Delta exists or record why it is not needed.
|
|
95
97
|
- Before frontend/backend implementation, verify vertical slice scope, implementation repo/location, whether the impacted frontend/backend runtime projects already exist and are reusable, YSS skill routing, Build Architecture Checklist, test command, and review strategy.
|
|
96
98
|
5. Output the next action:
|
|
@@ -139,10 +141,11 @@ Default routing:
|
|
|
139
141
|
|
|
140
142
|
| Intent | Next skill / workflow |
|
|
141
143
|
|---|---|
|
|
142
|
-
| Start a new business product/module | intake -> opportunity and Discovery -> `competitive-intelligence` when market / competitor facts are needed -> `grill-with-docs` -> `to-prd` ->
|
|
144
|
+
| Start a new business product/module | intake -> opportunity and Discovery -> `competitive-intelligence` when market / competitor facts are needed -> `grill-with-docs` -> `to-prd` -> product overview design / functional architecture -> product design and requirement freeze when UI exists |
|
|
143
145
|
| Analyze competitors, substitute workflows, pricing, positioning, or market facts | `competitive-intelligence`; then feed stable findings into `grill-with-docs` and `to-prd` |
|
|
144
|
-
| Design UI flow after PRD baseline | `product-design-prototype`; add `wireframe-prototype
|
|
145
|
-
| Review prototype before
|
|
146
|
+
| Design UI flow after PRD baseline | Verify product overview design / functional architecture first, then use `product-design-prototype`; add `wireframe-prototype` only when a low-fidelity page or flow sketch is needed |
|
|
147
|
+
| Review low-fidelity prototype before high-fidelity design | `prototype-review` |
|
|
148
|
+
| Build high-fidelity interactive HTML prototype | `high-fidelity-html-prototype` with Ant Design v6 after low-fidelity prototype review is approved |
|
|
146
149
|
| Review contract draft / OpenAPI Draft inside architecture/design review | `yss-openapi-draft-review` |
|
|
147
150
|
| Record behavior deltas for medium/high-risk changes | OpenSpec-style Spec Delta at `docs/specs/<feature>-spec-delta.md` using `docs/templates/spec-delta-template.md` |
|
|
148
151
|
| Clarify architecture artifact timing or gaps | this skill plus `docs/process/lifecycle-artifact-map.md` and `references/artifact-checklist.md` |
|
|
@@ -202,10 +205,10 @@ When the user explicitly asks for a full delivery plan, include stage-by-stage t
|
|
|
202
205
|
|
|
203
206
|
- Do not skip opportunity exploration for new product/module work; use `competitive-intelligence` when market/competitor facts are needed, or record why it is not needed.
|
|
204
207
|
- Do not treat Discovery outputs as frozen downstream design. Discovery can provide product capability guidance and downstream impact signals, but PRD, functional architecture, OpenAPI, system architecture, and data architecture still require their own gates.
|
|
205
|
-
- Do not start implementation before PRD is calibrated, required architecture artifacts are explicit, product design / prototype / interaction design exists
|
|
208
|
+
- Do not start implementation before PRD is calibrated, product overview design / functional architecture exists, required architecture artifacts are explicit, product design / prototype / interaction design exists, low-fidelity `prototype-review` passes, high-fidelity Ant Design v6 HTML prototype exists when UI exists, OpenAPI Freeze decision, engineering baseline, design review, and vertical slice are clear.
|
|
206
209
|
- Do not start implementation before deciding whether the impacted frontend/backend runtime projects already exist and can be reused. Missing or conflicting runtime projects must route back to implementation routing and scaffold initialization first.
|
|
207
210
|
- Do not skip business architecture for new products unless the product boundary, users, ecosystem, and value stream are already captured elsewhere.
|
|
208
|
-
- Do not skip functional architecture before PRD calibration
|
|
211
|
+
- Do not skip product overview design / functional architecture after PRD baseline. It is a required artifact before PRD calibration, product design / prototype / interaction design, API impact analysis, OpenAPI Draft, requirement freeze, or implementation. Only tasks that do not enter the PRD lifecycle may record a not-applicable reason in the impact assessment.
|
|
209
212
|
- Do not skip system architecture when services, deployment, integrations, performance, security, reliability, or operations are affected.
|
|
210
213
|
- Do not skip data architecture before persistence / repository work. For data modeling, metadata, versioning, or lineage products, treat it as mandatory before Design Review and OpenAPI Freeze.
|
|
211
214
|
- Do not let Excalidraw diagrams invent requirements or architecture decisions; diagrams must point back to source artifacts and any findings must be written back to PRD, OpenAPI, ADR, or issues.
|
|
@@ -14,6 +14,7 @@ Use this checklist to decide whether the current request can move forward or mus
|
|
|
14
14
|
| Functional architecture | `docs/architecture/<feature>-functional-architecture.md` or PRD/design section | Product capabilities, module boundaries, priority, dependencies, and MVP scope are clear |
|
|
15
15
|
| Product overview design | `docs/design/<feature>-product-overview-design.md` | Pages, flows, states, permissions, API candidates, and PRD gaps are clear |
|
|
16
16
|
| Prototype / interaction review | `docs/design/<feature>-prototype-review.md` or issue comment | UI paths, empty/error/loading states, permission states, and API backflow list are reviewed |
|
|
17
|
+
| High-fidelity HTML prototype | `docs/design/prototypes/<feature>/index.html` | Ant Design v6 interactive HTML prototype exists after low-fidelity review and before PRD calibration / API Draft |
|
|
17
18
|
| API impact / OpenAPI Draft | `docs/api/specs/<feature>.yaml`, issue note, or API impact record | Request/response, wrappers, errors, pagination, permissions, concurrency, and contract test seams are reviewable |
|
|
18
19
|
| OpenAPI Freeze | `docs/api/<feature>-openapi-freeze.md` or issue comment | Draft has been reviewed and marked stable for frontend/backend implementation |
|
|
19
20
|
| Engineering baseline | `docs/architecture/<feature>-engineering-baseline-review.md` | YSS DDD module boundary, dependency direction, DTO/VO/CMD/Query conventions, and scaffold constraints are reviewed |
|
|
@@ -9,7 +9,7 @@ Use this reference after reading current repo context. It maps request shape to
|
|
|
9
9
|
| 1. Intake / lifecycle triage | 新需求、继续需求、Bug、小调整、流程不清、缺失资产判断 | User request, `CONTEXT.md`, docs, issues, git state | stage decision, nearest trustworthy artifact, minimal skill list | route to earliest impacted stage |
|
|
10
10
|
| 2. Opportunity and Discovery | 模糊想法、竞品/市场输入、用户痛点尚不清楚 | discovery docs, market/user facts, stakeholder notes | user, pain, why now, MVP, non-goals, success criteria, downstream impact | `competitive-intelligence` when market / competitor facts are needed, then `grill-with-docs` / PRD |
|
|
11
11
|
| 3. Business / PRD / functional architecture | 需要明确用户故事、验收标准、功能边界、模块依赖 | discovery, `CONTEXT.md`, ADRs, existing PRD | PRD, business architecture, functional architecture, PRD review notes | product design or contract design |
|
|
12
|
-
| 4. Product design and requirement freeze | 有 UI
|
|
12
|
+
| 4. Product design and requirement freeze | 有 UI、页面、交互、状态矩阵、权限状态、空/错/加载态、高保真体验 | PRD, design system, existing UI, component docs | product overview design, interaction spec, state matrix, prototype review, Ant Design v6 high-fidelity HTML prototype, requirement freeze | contract and architecture review |
|
|
13
13
|
| 5. System / data architecture, engineering contract, and Design Review | 接口、DTO、错误结构、后端新服务、新模块、DDD 分层、服务边界、部署、集成、状态机、权限、NFR、持久化、元模型、版本、血缘 | calibrated requirements, design inputs, API impact decision, engineering impact decision | API impact record; contract sketch or reviewable OpenAPI Draft marked draft-for-review; OpenAPI Draft Review; engineering baseline review; system overview; data architecture when required; ADR candidates; Design Review result | contract freeze and Issue formalization |
|
|
14
14
|
| 6. Contract freeze and Issue formalization | OpenAPI Freeze、无 API 影响记录、正式拆分垂直切片 | Design Review approval, contract draft / OpenAPI Draft, PRD/design/architecture artifacts | OpenAPI Freeze or no API impact record; GitHub/GitLab/local vertical slice Issues | vertical slices and TDD implementation |
|
|
15
15
|
| 7. Vertical slices and TDD implementation | issue、切片、实现、review、清理简化 | frozen contract / no API impact, approved slice, implementation repo/location | implementation routing, YSS skill routing, tests, review, verification evidence | verification, release, and retrospective |
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: "yss-ui"
|
|
3
|
-
description: "YSS UI 页面开发组件技能。涉及 YTable、YTree、YssFormily、useTableHeight、useTreeHeight、页面布局、Hook 抽离、API
|
|
3
|
+
description: "YSS UI 页面开发组件技能。涉及 YTable、YTree、YssFormily、useTableHeight、useTreeHeight、页面布局、Hook 抽离、API 契约接入、路由菜单约定时必须使用。组件技能可以参考 yss-components 与 yss-hooks 技能规范。"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# YSS UI 页面与 Hook 一体化标准
|
|
@@ -197,19 +197,13 @@ const { loading, run: runPage } = useRequest(pageApi, {
|
|
|
197
197
|
- 翻页仅更新 `page/pageSize`,保留筛选项
|
|
198
198
|
- 导出、刷新等动作复用 `currentParams`
|
|
199
199
|
|
|
200
|
-
## 11. API
|
|
201
|
-
|
|
202
|
-
API 层:
|
|
200
|
+
## 11. API 契约接入标准
|
|
203
201
|
|
|
204
202
|
- 接口写在 `packages/src/api/*`
|
|
205
203
|
- 复用 `mutator.ts`
|
|
206
204
|
- 避免重复拼接 `/api`
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
- 路由放 `packages/mock/api.ts`
|
|
211
|
-
- 支持筛选和分页切片
|
|
212
|
-
- 返回结构统一:`{ code, message, data: { list, total, page, pageSize } }`
|
|
205
|
+
- 请求 / 响应字段以冻结后的 OpenAPI 或明确的契约草案为准
|
|
206
|
+
- 未冻结契约不得作为稳定生成客户端或实现依据
|
|
213
207
|
|
|
214
208
|
## 12. 路由菜单标准
|
|
215
209
|
|
package/template/AGENTS.md
CHANGED
|
@@ -67,6 +67,10 @@ yss-product-lifecycle
|
|
|
67
67
|
-> competitive-intelligence (需要竞品 / 市场事实时)
|
|
68
68
|
-> grill-with-docs
|
|
69
69
|
-> to-prd
|
|
70
|
+
-> product overview design / functional architecture
|
|
71
|
+
-> product-design-prototype
|
|
72
|
+
-> prototype-review
|
|
73
|
+
-> high-fidelity-html-prototype
|
|
70
74
|
-> OpenAPI Draft
|
|
71
75
|
-> OpenSpec-style Spec Delta (中高风险行为变化时)
|
|
72
76
|
-> OpenAPI Freeze
|
|
@@ -126,9 +130,10 @@ Matt skills 与 YSS skills 产物正文默认使用中文,包括澄清记录
|
|
|
126
130
|
- 任务开始前必须先参考 `docs/process/harness-process-tailoring.md` 判断小改动 / 中等变更 / 新模块或高风险变更;裁剪只能减少不相关产物,不能裁剪安全人审、Issue 追踪、Git checkpoint 和 fresh verification。
|
|
127
131
|
- 新功能或较大改动必须先用 `grill-with-docs` 澄清需求,再用 `to-prd` 形成 PRD,并在 PRD、实施计划或 Issue 中引用澄清记录。
|
|
128
132
|
- PRD 基线阶段必须同步明确功能架构:功能域、模块边界、优先级、MVP / 非目标范围和模块依赖;不清晰时不得进入 PRD 校准。
|
|
133
|
+
- 只要进入 PRD 初稿 / 需求基线流程,产品总体设计 / 功能架构就是必要产物,默认路径为 `docs/design/<feature>-product-overview-design.md`,且必须包含低保真原型 / 页面草图。不得直接从 PRD 初稿进入页面 / 原型 / 交互设计、OpenAPI Draft、PRD 校准、需求冻结或实现;不进入 PRD 生命周期的小文案、低风险 Bug 或局部配置变更,必须在影响面评估中说明不适用原因。
|
|
129
134
|
- 涉及页面设计、原型评审、UI 实现、组件选型、主题 token、颜色排版间距或 Ant Design / YSS UI 风格一致性的任务,必须先用 `yss-design-system` 作为设计系统基线;详细规范引用 `docs/design/design-system.md`。
|
|
130
|
-
- 有用户界面的功能在 PRD
|
|
131
|
-
- 任何 API 契约变更必须先在 `docs/api/specs/*.yaml` 形成 Draft
|
|
135
|
+
- 有用户界面的功能在 PRD 初稿和产品总体设计 / 功能架构后必须先引用 `yss-design-system`,再用 `product-design-prototype` 产出页面、原型、交互状态、PRD 回填项和 OpenAPI 反推清单;低保真 `prototype-review` 通过后,必须新增 `high-fidelity-html-prototype` 产物,默认路径为 `docs/design/prototypes/<feature>/index.html`,且必须使用 Ant Design v6,之后才能进入 PRD 校准 / 需求冻结和 UI 驱动的 OpenAPI Draft。
|
|
136
|
+
- 任何 API 契约变更必须先在 `docs/api/specs/*.yaml` 形成 Draft;OpenAPI 不得只基于 PRD 反推,必须结合产品总体设计 / 功能架构;有 UI 的功能还必须结合页面/原型/交互说明、状态矩阵、`prototype-review` 结论和 Ant Design v6 高保真 HTML 原型,经工程基线(如适用)、系统 / 数据架构和设计审查后 Freeze,再实现前后端和测试。
|
|
132
137
|
- API、权限、状态机、数据模型、跨端、新模块或高风险行为变化,应在 Design Review / OpenAPI Freeze 前补充 OpenSpec-style Spec Delta,落点为 `docs/specs/<feature>-spec-delta.md`;小文案、局部样式、配置微调和低风险 Bug 默认不需要。Spec Delta 只记录行为差异、验收场景和测试映射,不恢复 OpenSpec CLI、额外变更目录或状态机。
|
|
133
138
|
- OpenAPI Freeze 后进入 `to-issues`,将冻结范围拆成端到端垂直切片 Issue;不得要求额外状态机或变更目录作为交付前置。
|
|
134
139
|
- 涉及服务边界、部署、集成、性能、安全、可靠性或运维的变更,必须在设计审查前产出系统总体架构或等价设计记录。
|
|
@@ -252,7 +257,8 @@ Web Adapter
|
|
|
252
257
|
|------|----------|------|--------|
|
|
253
258
|
| PRD Review | PRD 完成后 | Product / Domain Review Agent | 用户、痛点、非目标范围、验收标准或安全红线不清 |
|
|
254
259
|
| Grilling Review | 新功能 / 较大改动 PRD 前、Architecture Review 前 | Product / Domain / Architecture Agent with `grill-with-docs` | 用户价值、边界、状态、反例、架构约束、验收标准或安全红线经不起质询 |
|
|
255
|
-
| Prototype Review | 有 UI 的 PRD
|
|
260
|
+
| Prototype Review | 有 UI 的 PRD 初稿完成后、高保真 HTML 原型前 | Product Design / UX / Frontend / API Agent | 页面清单、原型/线框、用户流、状态矩阵、PRD 回填项、权限状态或 OpenAPI 反推清单不清 |
|
|
261
|
+
| High-fidelity HTML Prototype Review | 低保真原型评审通过后、PRD 校准前 | Product Design / UX / Frontend Agent | Ant Design v6 高保真 HTML 原型缺失、主流程/关键状态/响应式/权限体验不可审查 |
|
|
256
262
|
| API Review | OpenAPI Draft 后 | API + Frontend + Backend Agent | schema、错误结构、分页、权限、契约测试不可落地 |
|
|
257
263
|
| Architecture Review | 系统/数据架构后 | Architecture Review Agent | 业务/功能/系统/数据架构、DDD 分层、模块依赖、ADR、状态流或回滚策略不清 |
|
|
258
264
|
| Plan Review | 垂直切片生成后 | Planning / Test Agent | 切片横向拆层、缺测试命令、缺回滚点或范围过大 |
|
package/template/CONTEXT.md
CHANGED
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
| PRD | 产品需求文档,用于记录用户问题、解决方案、用户故事、关键决策和测试 seam。 | 除非作为既有参考,否则不要写入具体实现文件路径。 |
|
|
13
13
|
| OpenAPI Draft | review-only 的 OpenAPI 3.1 契约草案。 | Freeze 前不得作为前后端稳定实现契约。 |
|
|
14
14
|
| OpenAPI Freeze | 已通过评审、可作为前后端实现和契约测试输入的 OpenAPI 3.1 契约。 | Freeze 后变更必须回到 API 影响分析和设计审查。 |
|
|
15
|
+
| 高保真 HTML 原型 | 低保真原型评审通过后,用于在浏览器中审查真实视觉密度、交互状态和页面流的产品设计资产。 | 不等同于生产前端实现,也不替代 OpenAPI、PRD 校准或垂直切片。 |
|
|
15
16
|
| 垂直切片(Vertical Slice) | 贯穿所有受影响层、可独立验证的窄功能路径。 | 优先使用垂直切片,避免只按层拆分的横向任务。 |
|
|
16
17
|
| ADR | 架构决策记录,用于沉淀难以回滚、非显而易见且存在真实取舍的技术决策。 | 常规实现选择不要写 ADR。 |
|
|
17
18
|
| Fresh Verification | 完成前重新执行的验证证据,包括测试命令、契约校验、关键路径检查或人工审查结论。 | 不等同于“之前跑过”或实现者自述。 |
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
| 原型 / 线框图 | | |
|
|
17
17
|
| 状态矩阵 | `docs/design/<feature>-state-matrix.md` | |
|
|
18
18
|
| 原型评审结论 | `docs/design/<feature>-prototype-review.md` | |
|
|
19
|
+
| 高保真 HTML 原型 | `docs/design/prototypes/<feature>/index.html` | 有 UI 时必需;必须使用 Ant Design v6 |
|
|
19
20
|
| YSS 工程基线 | `.codex/skills/yss-ddd-scaffold-generator/references/yss-backend-scaffold-parent/SKILL.md` | |
|
|
20
21
|
|
|
21
22
|
## P0 追踪矩阵
|
|
@@ -31,7 +32,8 @@
|
|
|
31
32
|
| Draft 成熟度 | 明确当前仅为 review-only;实现、生成 client、契约测试固化均等待 OpenAPI Freeze | | |
|
|
32
33
|
| OpenAPI 语法 | YAML、`$ref`、path 参数、lint 通过 | | |
|
|
33
34
|
| P0 覆盖 | 每个 P0 需求有 endpoint/schema/error/test 或明确非目标 | | |
|
|
34
|
-
|
|
|
35
|
+
| 产品总体设计完整 | Draft 已依据 PRD 和产品总体设计 / 功能架构;缺产品总体设计时返回上游补齐 | | |
|
|
36
|
+
| 交互输入完整 | 有 UI 时,Draft 已同时依据交互说明、原型/线框、状态矩阵、prototype-review 和 Ant Design v6 高保真 HTML 原型;无 UI 时需说明页面 / 交互资产不适用原因 | | |
|
|
35
37
|
| DDD 契约边界 | Endpoint/schema 归属的限界上下文清楚;术语与 `CONTEXT.md` 和功能架构一致;契约不直接暴露内部聚合、Repository 或持久化表结构 | | |
|
|
36
38
|
| 页面动作覆盖 | 每个按钮 / 抽屉 / 弹窗动作有 endpoint/non-goal、`actionKey`、权限和错误码 | | |
|
|
37
39
|
| 对象生命周期 | manage/maintain/configure/create/update/archive/retry/cancel/publish/export/create-draft 语义闭环 | | |
|
|
@@ -7,7 +7,9 @@
|
|
|
7
7
|
- `docs/design/design.md`:从本地 `Product-Design-System` 引入并整理的 Ant Design 企业级设计系统说明,后续页面设计、交互说明、原型评审和前端实现默认引用该文件。
|
|
8
8
|
- `docs/design/tokens/`:随仓库保存的主题、亮色 / 暗色 / 紧凑 token 和 CSS 变量快照,后续实现不得依赖本机 Downloads 目录。
|
|
9
9
|
|
|
10
|
-
进入 API 影响分析 /
|
|
10
|
+
进入 PRD 初稿 / 需求基线流程后,必须先沉淀产品总体设计 / 功能架构,再进入页面 / 原型 / 交互设计、PRD 校准、API 影响分析 / 契约草案或实现。产品总体设计文档必须包含低保真原型 / 页面草图,用于验证页面结构、关键操作和主流程。无 UI 的功能也需要产品总体设计 / 功能架构来说明功能域、业务对象、模块边界、API / 数据影响和不适用的页面状态;只有不进入 PRD 生命周期的小改动可在影响面评估中记录不适用原因。
|
|
11
|
+
|
|
12
|
+
进入 API 影响分析 / 契约草案前,有用户界面的功能还必须沉淀:
|
|
11
13
|
|
|
12
14
|
- 页面清单和信息架构。
|
|
13
15
|
- 用户主路径和异常路径。
|
|
@@ -16,12 +18,13 @@
|
|
|
16
18
|
- 表单、表格、弹窗、抽屉、步骤流等交互说明。
|
|
17
19
|
- loading、empty、error、readonly、disabled、no-permission、conflict 等状态矩阵。
|
|
18
20
|
- 页面字段、筛选条件、操作按钮和权限规则。
|
|
21
|
+
- 低保真原型评审通过后的 Ant Design v6 高保真可交互 HTML 原型,默认路径为 `docs/design/prototypes/<feature>/index.html`。
|
|
19
22
|
|
|
20
23
|
这些资产用于反推 API 影响、契约草案、OpenAPI 请求 / 响应字段、错误结构、分页筛选、权限状态和前端验收标准。
|
|
21
24
|
|
|
22
25
|
推荐模板:
|
|
23
26
|
|
|
24
|
-
- `docs/design/templates/product-overview-design-template.md`:PRD 初稿之后、页面 / 原型 /
|
|
27
|
+
- `docs/design/templates/product-overview-design-template.md`:PRD 初稿之后、页面 / 原型 / 交互设计之前,用于团队评审产品总体设计、功能架构、低保真原型、页面/API/数据影响和 PRD 回填项;它是后续交互设计输入,不替代详细交互说明。
|
|
25
28
|
- `docs/design/templates/interaction-spec-template.md`:页面、流程、交互、PRD 回填项和 OpenAPI 反推清单。
|
|
26
29
|
- `docs/design/templates/state-matrix-template.md`:loading、empty、error、readonly、no-permission、conflict 等状态。
|
|
27
30
|
- `docs/design/templates/prototype-review-checklist.md`:进入 PRD 校准 / API 影响分析 / 契约草案前的原型评审门禁。
|
|
@@ -31,15 +34,15 @@
|
|
|
31
34
|
- `yss-design-system`:项目设计系统与 Ant Design 企业级 UI 风格基线;页面设计、原型评审、UI 实现和主题 token 落地时默认先引用。
|
|
32
35
|
- `product-design-prototype`:基于 PRD 初稿和产品总体设计 / 功能架构,产出页面 / 原型 / 交互设计资产。
|
|
33
36
|
- `wireframe-prototype`:低保真线框、Excalidraw、Figma、Penpot、tldraw、Axure 等原型链接沉淀。
|
|
34
|
-
- `component-story-prototype`:Storybook / Histoire 工程态状态原型。
|
|
35
|
-
- `mock-api-prototype`:MSW / mock fixtures 支撑未冻结 API 前的交互验证。
|
|
36
37
|
- `prototype-review`:原型阶段评审门禁;未通过则不要进入 PRD 校准 / API 影响分析 / 契约草案。
|
|
38
|
+
- `high-fidelity-html-prototype`:低保真原型评审通过后,基于官方 `@ant-design/cli` / Ant Design For Agents 指引生成 Ant Design v6 高保真可交互 HTML 原型;未产出前不要进入 PRD 校准 / API 影响分析 / 契约草案。
|
|
37
39
|
- `excalidraw-diagram-generator`:根据已形成的 Discovery、PRD、OpenAPI Draft、Architecture 或 系统 / 数据架构设计 生成 `.excalidraw` 图;用于说明和审查,不替代文本规格。
|
|
38
40
|
|
|
39
41
|
推荐目录:
|
|
40
42
|
|
|
41
43
|
```text
|
|
42
44
|
docs/design/diagrams/
|
|
45
|
+
docs/design/prototypes/
|
|
43
46
|
docs/architecture/diagrams/
|
|
44
47
|
docs/discovery/diagrams/
|
|
45
48
|
```
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -1,15 +1,17 @@
|
|
|
1
1
|
# <功能名称> 交互说明模板
|
|
2
2
|
|
|
3
|
-
> 适用时机:PRD
|
|
3
|
+
> 适用时机:PRD 初稿和产品总体设计 / 功能架构完成之后,PRD 校准 / API 影响分析 / 契约草案之前;仅用于有用户界面影响的功能。
|
|
4
4
|
|
|
5
5
|
## 1. 输入资产
|
|
6
6
|
|
|
7
7
|
| 资产 | 路径 / 链接 | 说明 |
|
|
8
8
|
|---|---|---|
|
|
9
9
|
| PRD 初稿 | `docs/requirements/<feature>-prd.md` | 原型评审后需要回填和校准 |
|
|
10
|
+
| 产品总体设计 / 功能架构 | `docs/design/<feature>-product-overview-design.md` | 必需;缺失时先返回产品总体设计阶段 |
|
|
10
11
|
| 领域术语 | `CONTEXT.md` | 核心名词、状态和业务规则 |
|
|
11
12
|
| Discovery | `docs/discovery/<feature>-discovery.md` | 可选 |
|
|
12
13
|
| 原型 / 线框图 | `<链接或导出图片路径>` | Excalidraw / Figma / Penpot / tldraw / Axure / Markdown |
|
|
14
|
+
| 高保真 HTML 原型 | `docs/design/prototypes/<feature>/index.html` | 低保真原型评审通过后补齐;必须使用 Ant Design v6 |
|
|
13
15
|
| 现有 API 草案 | `docs/api/specs/<feature>.yaml` | 可选;通常应先完成产品设计和 PRD 校准 |
|
|
14
16
|
|
|
15
17
|
## 2. 页面地图
|
|
@@ -99,9 +101,9 @@
|
|
|
99
101
|
## 8. 前端验收
|
|
100
102
|
|
|
101
103
|
- loading、empty、error、no-permission、readonly、conflict、dirty-form 状态已展示,或明确不适用。
|
|
102
|
-
-
|
|
104
|
+
- 每个表格列、筛选条件、表单字段、抽屉、弹窗和按钮都有数据来源或契约反推说明。
|
|
103
105
|
- 设计可以拆成独立可演示的垂直切片。
|
|
104
|
-
-
|
|
106
|
+
- 低保真原型评审通过后,高保真 HTML 原型使用 Ant Design v6 覆盖主流程、关键状态和响应式断点。
|
|
105
107
|
|
|
106
108
|
## 9. 决策与未决问题
|
|
107
109
|
|
|
@@ -8,7 +8,7 @@ owner: ai
|
|
|
8
8
|
# <功能名称> 产品总体设计与功能架构
|
|
9
9
|
|
|
10
10
|
> 适用时机:PRD 初稿之后、页面 / 原型 / 交互设计之前。
|
|
11
|
-
> 本文用于明确功能域、模块边界、MVP
|
|
11
|
+
> 本文用于明确功能域、模块边界、MVP 范围、页面清单、低保真原型、状态 / 权限影响、OpenAPI 反推点和 PRD 回填项;它是页面 / 原型 / 交互设计的上游输入,不替代 PRD、交互说明、契约草案 / OpenAPI Draft 或系统概要设计。
|
|
12
12
|
|
|
13
13
|
## 1. 输入资产
|
|
14
14
|
|
|
@@ -68,30 +68,59 @@ owner: ai
|
|
|
68
68
|
|------|----------|----------|----------|------------------|------|
|
|
69
69
|
| | | | | | |
|
|
70
70
|
|
|
71
|
-
## 8.
|
|
71
|
+
## 8. 低保真原型 / 页面草图
|
|
72
|
+
|
|
73
|
+
> 本节用于在产品总体设计阶段先验证页面结构、核心操作和跨页面流转,不展开到高保真视觉、组件实现或完整字段级交互;后续页面 / 原型 / 交互设计需基于本节继续细化。无 UI 功能仍保留本节,用流程 / 能力草图和“不适用原因”说明用户或系统如何完成任务。
|
|
74
|
+
|
|
75
|
+
### 8.1 页面地图
|
|
76
|
+
|
|
77
|
+
| 页面 / 区域 | 入口 | 核心任务 | 关键操作 | 下一步 |
|
|
78
|
+
|-------------|------|----------|----------|--------|
|
|
79
|
+
| | | | | |
|
|
80
|
+
|
|
81
|
+
### 8.2 低保真线框
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
页面名称:
|
|
85
|
+
|
|
86
|
+
[导航 / 面包屑]
|
|
87
|
+
[查询 / 筛选区域]
|
|
88
|
+
[主内容区域:表格 / 表单 / 画布 / 列表]
|
|
89
|
+
[操作区:主按钮 / 次按钮 / 更多操作]
|
|
90
|
+
[反馈区:校验结果 / 错误提示 / 空态]
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### 8.3 原型评审关注点
|
|
94
|
+
|
|
95
|
+
| 页面 / 流程 | 需要验证的问题 | 关联 P0 需求 | 关联 API / 数据 / 权限影响 | 后续交互设计待细化 |
|
|
96
|
+
|-------------|----------------|--------------|-----------------------------|--------------------|
|
|
97
|
+
| | | | | |
|
|
98
|
+
|
|
99
|
+
## 9. PRD 回填项
|
|
72
100
|
|
|
73
101
|
| 编号 | 回填内容 | 影响章节 | 优先级 | 状态 |
|
|
74
102
|
|------|----------|----------|--------|------|
|
|
75
103
|
| | | | | 待确认 / 已回填 |
|
|
76
104
|
|
|
77
|
-
##
|
|
105
|
+
## 10. 开放问题与决策
|
|
78
106
|
|
|
79
107
|
| 问题 / 决策 | 选项 | 建议 | 负责人 | 截止点 | 状态 |
|
|
80
108
|
|-------------|------|------|--------|--------|------|
|
|
81
109
|
| | | | | PRD 校准前 / API 影响分析前 | 待确认 |
|
|
82
110
|
|
|
83
|
-
##
|
|
111
|
+
## 11. 评审清单
|
|
84
112
|
|
|
85
113
|
- [ ] 用户主流程和异常路径已覆盖 MVP。
|
|
86
114
|
- [ ] 业务对象、状态和关系不会与 `CONTEXT.md` 术语冲突。
|
|
87
115
|
- [ ] 功能域、模块边界和优先级清楚。
|
|
88
116
|
- [ ] Strategic DDD Check 已完成,或明确说明本次变更不影响领域边界。
|
|
89
117
|
- [ ] 页面、API、数据、权限和审计影响已显式标注。
|
|
118
|
+
- [ ] 低保真原型 / 页面草图已覆盖 P0 页面、主流程和关键异常路径,并能支撑后续交互设计。
|
|
90
119
|
- [ ] PRD 回填项已列出,并分清阻断项和非阻断项。
|
|
91
120
|
- [ ] 安全红线已标记 `TODO-HUMAN-REVIEW`。
|
|
92
121
|
- [ ] 可进入页面 / 原型 / 交互设计,或明确阻断项。
|
|
93
122
|
|
|
94
|
-
##
|
|
123
|
+
## 12. 结论
|
|
95
124
|
|
|
96
125
|
- 评审结论:Approved / Blocked
|
|
97
126
|
- 阻断项:
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# <功能名称> 原型评审清单
|
|
2
2
|
|
|
3
|
-
> 适用时机:配合 `prototype-review` 使用。评审采用 fail-closed
|
|
3
|
+
> 适用时机:配合 `prototype-review` 使用。评审采用 fail-closed:有阻断项时必须回到产品设计阶段;低保真评审通过后必须进入 `high-fidelity-html-prototype`,不能直接进入 PRD 校准或 API 影响分析 / 契约草案。
|
|
4
4
|
|
|
5
5
|
## 评审输入
|
|
6
6
|
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
| 权限行为能区分隐藏、禁用和调用后拒绝 | | |
|
|
25
25
|
| 校验错误能区分模型级和字段级展示位置 | | |
|
|
26
26
|
| 能从界面需求反推出 API 影响和契约草案 | | |
|
|
27
|
-
|
|
|
27
|
+
| 前端验收、组件状态和数据依赖已明确 | | |
|
|
28
28
|
| 安全红线已标记人工审查 | | |
|
|
29
29
|
|
|
30
30
|
## PRD 校准就绪度
|
|
@@ -59,5 +59,5 @@
|
|
|
59
59
|
非阻断建议:
|
|
60
60
|
-
|
|
61
61
|
下一步:
|
|
62
|
-
-
|
|
62
|
+
- high-fidelity-html-prototype / 回到 product-design-prototype
|
|
63
63
|
```
|
|
@@ -13,7 +13,7 @@ AI 不能只作为一次性辅助工具使用。Harness 工程的目标,是把
|
|
|
13
13
|
```text
|
|
14
14
|
机会 / 问题收集
|
|
15
15
|
→ 需求澄清
|
|
16
|
-
→ PRD
|
|
16
|
+
→ PRD -> 产品总体设计 -> 原型校准
|
|
17
17
|
→ SDD 研发规范基线
|
|
18
18
|
→ DDD 领域建模
|
|
19
19
|
→ 架构设计
|
|
@@ -31,6 +31,7 @@ AI 不能只作为一次性辅助工具使用。Harness 工程的目标,是把
|
|
|
31
31
|
## 哪些门禁不能跳
|
|
32
32
|
|
|
33
33
|
- API 变化必须先有 API 影响记录和契约草案 / review-only OpenAPI Draft,并在实现或生成客户端前完成 Freeze 或记录无 API 影响。
|
|
34
|
+
- 进入 PRD 初稿 / 需求基线流程后,必须先有产品总体设计 / 功能架构,才能进入页面 / 原型 / 交互设计、OpenAPI Draft、PRD 校准、需求冻结或实现;不进入 PRD 生命周期的小改动才可记录不适用原因。
|
|
34
35
|
- 正式垂直切片前必须有 active Issue change 和完整 change 资产。
|
|
35
36
|
- 架构、数据、ADR、工程基线和安全红线必须进入 Build Architecture Checklist。
|
|
36
37
|
- 支付、迁移、认证授权、加密、SQL、公共基础库 API 等安全红线必须人工审查。
|
|
@@ -43,6 +44,9 @@ AI 不能只作为一次性辅助工具使用。Harness 工程的目标,是把
|
|
|
43
44
|
|
|
44
45
|
```text
|
|
45
46
|
PRD
|
|
47
|
+
→ 产品总体设计 / 功能架构
|
|
48
|
+
→ 页面 / 原型 / 交互设计与 prototype-review(有 UI 时)
|
|
49
|
+
→ Ant Design v6 高保真 HTML 原型(有 UI 时)
|
|
46
50
|
→ API 影响分析 / 契约草案
|
|
47
51
|
→ review-only OpenAPI Draft(如需要)
|
|
48
52
|
→ Issue Change
|
|
@@ -16,9 +16,9 @@
|
|
|
16
16
|
|
|
17
17
|
| 当前输入 / 变更事实 | 最近可信阶段 | 需要补齐的下游 |
|
|
18
18
|
|---|---|---|
|
|
19
|
-
| 只有模糊想法、业务机会或竞品输入 | 2. 机会与 Discovery | Discovery、`grill-with-docs`、PRD
|
|
20
|
-
| 已有清晰 PRD,但用户、痛点、MVP 或非目标不稳 | 3. 业务 / PRD / 功能架构 | PRD Review
|
|
21
|
-
| 有 UI
|
|
19
|
+
| 只有模糊想法、业务机会或竞品输入 | 2. 机会与 Discovery | Discovery、`grill-with-docs`、PRD、产品总体设计 / 功能架构 |
|
|
20
|
+
| 已有清晰 PRD,但用户、痛点、MVP 或非目标不稳 | 3. 业务 / PRD / 功能架构 | PRD Review、产品总体设计 / 功能架构、必要的页面 / 原型 / 交互设计 |
|
|
21
|
+
| 有 UI 变更但缺页面流、状态矩阵、原型评审或高保真 HTML 原型 | 4. 产品设计与需求冻结 | 交互说明、状态矩阵、Prototype Review、Ant Design v6 高保真 HTML 原型、PRD 回填 |
|
|
22
22
|
| API 路径、schema、错误结构、分页或权限发生变化 | 5. 系统 / 数据架构与工程契约设计审查 | API 影响记录、契约草案 / OpenAPI Draft Review、必要时 Spec Delta、系统 / 数据架构反审、Freeze、`to-issues` |
|
|
23
23
|
| 服务边界、集成、部署、性能、可靠性或运维变化 | 5. 系统 / 数据架构与工程契约设计审查 | 系统架构、Design Review、必要时 Spec Delta、Build Architecture Checklist |
|
|
24
24
|
| 持久化、元数据、版本、血缘、搜索、索引或迁移变化 | 5. 系统 / 数据架构与工程契约设计审查 | 数据架构、必要时 Spec Delta、人审点、Repository / MyBatis 前置审查 |
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
|---|---|---|---|---|---|---|
|
|
15
15
|
| 0. 机会 / 问题收集 | 1. 入口分诊;2. 机会与 Discovery | 0. 入口分诊;1. 机会探索 | 分诊结论、Discovery 收敛、MVP 边界 | `yss-product-lifecycle`、`competitive-intelligence`、Discovery 模板 | 小改动可跳过;新产品 / 新模块必需 | 半自动生成分诊清单、竞品情报简报和 Discovery 模板 |
|
|
16
16
|
| 1. 需求澄清 | 3. 业务 / PRD / 功能架构 | 3. 需求澄清 | 澄清记录、用户 / 痛点 / 验收标准 | `grill-with-docs`、`to-prd` | 小文案 / 单点 bug 可轻量化 | 半自动生成澄清问题和缺口清单 |
|
|
17
|
-
| 2. PRD
|
|
17
|
+
| 2. PRD -> 产品总体设计 -> 原型校准 | 3. 业务 / PRD / 功能架构;4. 产品设计与需求冻结 | 4. 需求基线 / 功能架构;5. 页面 / 原型 / 交互设计;6. 原型评审;7. PRD 校准 / 需求冻结 | PRD、产品总体设计 / 功能架构、低保真原型、页面清单、状态矩阵、原型评审、Ant Design v6 高保真 HTML 原型、需求冻结 | `yss-design-system`、`product-design-prototype`、`prototype-review`、`high-fidelity-html-prototype` | 无 UI 可省略后续交互原型;进入 PRD 初稿 / 需求基线流程时不得省略产品总体设计及其低保真原型;有 UI 时低保真评审通过后不得省略高保真 HTML 原型;中等变更只补受影响页面 | 半自动检查 PRD 字段、产品总体设计、低保真原型、状态矩阵、原型评审和高保真 HTML 原型 |
|
|
18
18
|
| 3. SDD 研发规范基线 | 5. 系统 / 数据架构与工程契约设计审查;6. 契约冻结与 Issue | 8. API 影响分析 / 契约草案;9. 工程基线;13. 契约冻结;14. Issue formalization | API 影响记录、契约草案 / OpenAPI Draft / Freeze、Spec Delta、工程基线、垂直切片 Issue、实施路由、验证证据 | `to-issues`、`yss-router` | 无 API / 无工程边界变化时记录无影响结论;低风险小改动跳过 Spec Delta | 自动检查 OpenAPI Freeze / no API impact / Spec Delta / vertical slice Issue / implementation routing |
|
|
19
19
|
| 4. DDD 领域建模 | 3. 业务 / PRD / 功能架构;5. 系统 / 数据架构与工程契约设计审查 | 2. 业务架构;10. 系统总体架构;11. 数据架构 | CONTEXT 术语、业务能力、领域边界、聚合 / 状态规则 | `domain-modeling`、`yss-domain-modeling`、`yss-domain` | 小改动只校验是否影响既有术语或边界 | 半自动检查术语回填和领域边界审查项 |
|
|
20
20
|
| 5. 架构设计 | 5. 系统 / 数据架构与工程契约设计审查 | 8. API 影响分析 / 契约草案;9. 工程基线;10. 系统总体架构;11. 数据架构;12. 设计审查 | API 影响记录、工程基线、系统概要设计、数据架构、ADR 候选、架构评审 | `codebase-design`、`improve-codebase-architecture`、YSS 架构模板 | 不触碰 API、工程边界、服务边界、数据、NFR、部署时可轻量记录无影响 | 半自动生成 Architecture Review checklist |
|
|
@@ -22,8 +22,8 @@ owner: ai
|
|
|
22
22
|
|---|---|---|---|---|
|
|
23
23
|
| 1. 入口分诊 | 判断任务类型、风险等级、最近可信阶段和最小技能集 | 分诊结论或 issue 备注 | `yss-product-lifecycle` 路由结果、Git checkpoint 判断 | 是否需要 Discovery / PRD / API / 架构 / Issue |
|
|
24
24
|
| 2. 机会与 Discovery | 收敛用户、痛点、为什么现在做、MVP、非目标、成功标准、产品功能指引和下游影响信号 | `docs/discovery/<feature>-discovery.md` 或等价说明 | `competitive-intelligence` 竞品情报、竞品矩阵、机会说明、产品功能指引、下游影响清单、市场分析、用户痛点文档 | 是否足以进入业务架构和 PRD |
|
|
25
|
-
| 3. 业务 / PRD / 功能架构 |
|
|
26
|
-
| 4. 产品设计与需求冻结 |
|
|
25
|
+
| 3. 业务 / PRD / 功能架构 | 明确产品边界、用户旅程、功能域、模块边界、优先级、低保真原型和验收标准 | `docs/requirements/<feature>-prd.md`;`docs/design/<feature>-product-overview-design.md` | `grill-with-docs` 澄清记录、业务架构、CONTEXT 术语回填;不进入 PRD 生命周期的小改动可记录不适用原因 | PRD Review / 产品总体设计评审 / 产品设计准备度 |
|
|
26
|
+
| 4. 产品设计与需求冻结 | 基于 PRD 初稿和产品总体设计,对 UI、页面流、状态矩阵、异常路径、高保真体验和 PRD 回填做闭环 | 有 UI 时:交互说明、低保真原型评审结论、Ant Design v6 高保真 HTML 原型;无 UI 时:需求冻结记录 | 状态矩阵、页面地图、原型链接 | PRD 校准 / 工程契约与架构设计准备度 |
|
|
27
27
|
| 5. 系统 / 数据架构与工程契约设计审查 | 合并 API 影响分析、契约草案、工程基线、系统架构、数据架构和 Design Review;Draft 仅用于评审,Freeze 前不得作为实现或生成客户端契约 | 系统概要设计或等价架构记录;Design Review 结论;有 API 时:API 影响记录和契约草案 / review-only OpenAPI Draft;有后端结构影响时:工程基线审查 | OpenAPI Draft Review、OpenSpec-style Spec Delta、工程基线审查、无 API 影响记录、数据架构、ADR、架构图 | OpenAPI Freeze 准备度 |
|
|
28
28
|
| 6. 契约冻结与 Issue formalization | 冻结契约并把交付范围转成可执行 Issue,并明确受影响前后端工程是否已存在 | OpenAPI Freeze 记录或无 API 影响记录;垂直切片 Issue 入口 | `to-issues` 输出、实施路由记录、实现仓库 / 脚手架判定、Issue tracker 同步 | 垂直切片准备度 |
|
|
29
29
|
| 7. 垂直切片与 TDD 实现 | 将冻结范围拆成端到端切片并按 TDD 实现 | 垂直切片 Issue、实施计划、Build Architecture Checklist、测试 / 验证记录 | YSS skill routing、前后端脚手架初始化记录、`implement` / `tdd` 证据、`code-review` 报告、清理简化记录、Architecture Re-check | Fresh verification / Release Review |
|
|
@@ -37,9 +37,9 @@ owner: ai
|
|
|
37
37
|
| 1. 机会探索 | 2. 机会与 Discovery | 机会输入、MVP 边界、非目标范围 | 新产品 / 新模块必需 |
|
|
38
38
|
| 2. 业务架构 | 3. 业务 / PRD / 功能架构 | 业务架构或 PRD 中等价章节 | 新产品 / 新业务域必需 |
|
|
39
39
|
| 3. 需求澄清 | 3. 业务 / PRD / 功能架构 | `grill-with-docs` 结论或等价澄清记录 | 新功能 / 较大改动必需 |
|
|
40
|
-
| 4. 需求基线 / 功能架构 | 3. 业务 / PRD / 功能架构 | PRD
|
|
41
|
-
| 5. 页面 / 原型 / 交互设计 | 4. 产品设计与需求冻结 |
|
|
42
|
-
| 6. 原型评审 | 4. 产品设计与需求冻结 | Prototype Review
|
|
40
|
+
| 4. 需求基线 / 功能架构 | 3. 业务 / PRD / 功能架构 | PRD;产品总体设计 / 功能架构资产;功能域、模块边界、低保真原型、验收标准 | 进入 PRD 初稿 / 需求基线流程时必需 |
|
|
41
|
+
| 5. 页面 / 原型 / 交互设计 | 4. 产品设计与需求冻结 | 基于 PRD 初稿和产品总体设计 / 功能架构产出的交互说明、页面清单、状态矩阵 | 有 UI 时必需;缺产品总体设计时阻断 |
|
|
42
|
+
| 6. 原型评审 | 4. 产品设计与需求冻结 | Prototype Review 结论;通过后必须产出 Ant Design v6 高保真 HTML 原型 | 有 UI 时必需 |
|
|
43
43
|
| 7. PRD 校准 / 需求冻结 | 4. 产品设计与需求冻结 | 需求冻结记录或校准后的 PRD | 必需;无 UI 可轻量化 |
|
|
44
44
|
| 8. API 影响分析 / 契约草案 | 5. 系统 / 数据架构与工程契约设计审查 | API 影响记录、契约草案 / OpenAPI Draft 或无 API 影响记录;Draft 在 Freeze 前仅可评审;中高风险变更补 OpenSpec-style Spec Delta | 有 API 影响时必需;Spec Delta 条件必需 |
|
|
45
45
|
| 9. 工程基线 | 5. 系统 / 数据架构与工程契约设计审查 | 工程基线 / YSS DDD Review | 新服务 / 新模块 / 后端结构变化时必需 |
|
|
@@ -69,6 +69,7 @@ owner: ai
|
|
|
69
69
|
| 交互说明 | `docs/design/<feature>-interaction-spec.md` | `docs/design/templates/interaction-spec-template.md` |
|
|
70
70
|
| 状态矩阵 | `docs/design/<feature>-state-matrix.md` | `docs/design/templates/state-matrix-template.md` |
|
|
71
71
|
| 原型评审 | `docs/design/<feature>-prototype-review.md` | `docs/design/templates/prototype-review-checklist.md` |
|
|
72
|
+
| 高保真 HTML 原型 | `docs/design/prototypes/<feature>/index.html` | `high-fidelity-html-prototype` |
|
|
72
73
|
| 需求冻结 | `docs/requirements/<feature>-requirement-freeze.md` | `docs/templates/requirement-freeze-template.md` |
|
|
73
74
|
| API 影响分析 / 契约草案 / OpenAPI Draft | API 影响记录、issue note 或 `docs/api/specs/<feature>.yaml` | `docs/templates/openapi-spec-template.yaml` |
|
|
74
75
|
| OpenSpec-style Spec Delta | `docs/specs/<feature>-spec-delta.md` | `docs/templates/spec-delta-template.md` |
|
|
@@ -7,7 +7,7 @@ owner: ai
|
|
|
7
7
|
|
|
8
8
|
# <功能名称>需求冻结记录
|
|
9
9
|
|
|
10
|
-
> 适用场景:PRD
|
|
10
|
+
> 适用场景:PRD 初稿经过产品总体设计 / 功能架构、产品设计 / 原型评审后,需要冻结可进入 API 影响分析 / 契约草案和工程设计的范围。
|
|
11
11
|
> 本文记录最终范围、回填项、非目标和开放问题,不替代 PRD。
|
|
12
12
|
|
|
13
13
|
## 1. 输入材料
|
|
@@ -15,8 +15,9 @@ owner: ai
|
|
|
15
15
|
| 资产 | 路径 / 链接 | 状态 | 备注 |
|
|
16
16
|
|------|-------------|------|------|
|
|
17
17
|
| PRD 初稿 | | | |
|
|
18
|
-
|
|
|
18
|
+
| 产品总体设计 / 功能架构 | | | 必需 |
|
|
19
19
|
| 产品设计 / 交互说明 | | | |
|
|
20
|
+
| 高保真 HTML 原型 | `docs/design/prototypes/<feature>/index.html` | | 有 UI 时必需;Ant Design v6 |
|
|
20
21
|
| Prototype Review | | | |
|
|
21
22
|
| CONTEXT 术语 | | | |
|
|
22
23
|
|
|
@@ -50,7 +51,7 @@ owner: ai
|
|
|
50
51
|
|
|
51
52
|
## 6. 完成标准
|
|
52
53
|
|
|
53
|
-
- [ ] PRD
|
|
54
|
+
- [ ] PRD 已吸收产品总体设计 / 功能架构、产品设计、低保真原型评审和高保真 HTML 原型暴露的阻断项。
|
|
54
55
|
- [ ] 本轮做什么、不做什么、延后什么已经明确。
|
|
55
56
|
- [ ] OpenAPI、工程基线、系统架构、数据架构、安全红线影响已有明确结论。
|
|
56
57
|
- [ ] 可进入 API 影响分析 / 契约草案 / 工程基线,或阻断项已列出。
|
|
@@ -172,7 +172,7 @@ docs/process/lifecycle-artifact-map.md
|
|
|
172
172
|
|
|
173
173
|
### 6.3 设计产品和契约
|
|
174
174
|
|
|
175
|
-
有 UI
|
|
175
|
+
有 UI 时先走设计系统、产品设计、低保真原型评审和 Ant Design v6 高保真 HTML 原型。涉及 API 时,先生成 review-only OpenAPI Draft:
|
|
176
176
|
|
|
177
177
|
```text
|
|
178
178
|
基于 PRD 和产品设计,生成 OpenAPI 3.1 Draft。
|
|
@@ -206,7 +206,7 @@ OpenAPI Freeze 或无 API 影响记录完成后使用 `to-issues`:
|
|
|
206
206
|
|
|
207
207
|
- Draft 阶段允许调整接口,但不能被当成稳定实现契约。
|
|
208
208
|
- Freeze 后的契约变更必须回到 API 影响分析、架构 / 数据设计和 Design Review,不能边写代码边悄悄改接口。
|
|
209
|
-
-
|
|
209
|
+
- OpenAPI 不得只基于 PRD 反推:必须结合产品总体设计 / 功能架构;有 UI 时还必须结合页面 / 原型 / 交互说明、状态矩阵、低保真原型评审和 Ant Design v6 高保真 HTML 原型。
|
|
210
210
|
- OpenAPI Freeze 后进入 `to-issues`,再进入前后端实现和契约测试。
|
|
211
211
|
|
|
212
212
|
## 8. 验证、发布和复盘
|
|
@@ -146,8 +146,10 @@ skills 是让 AI 按规程工作的“操作手册”,不是关键词装饰。
|
|
|
146
146
|
| 不知道当前该做什么 | `yss-product-lifecycle` | 先阶段判断和资产检查,不写业务代码 |
|
|
147
147
|
| 模糊需求追问 | `grill-with-docs` | 先问清,不让 AI 猜规则;稳定术语写 `CONTEXT.md` |
|
|
148
148
|
| 生成 PRD 初稿 / 需求基线 | `to-prd` 或 PRD 模板 | 只基于已确认事实,不把待确认项写成需求 |
|
|
149
|
-
|
|
|
150
|
-
|
|
|
149
|
+
| 产品总体设计 / 功能架构 | `docs/design/templates/product-overview-design-template.md` | PRD 初稿后的必要产物;必须包含低保真原型 / 页面草图;进入页面 / 原型 / 交互设计、PRD 校准或 OpenAPI Draft 前必须完成 |
|
|
150
|
+
| 页面和交互设计 | `product-design-prototype`、`wireframe-prototype`、`docs/design/` | 基于 PRD 初稿和产品总体设计细化页面流、状态和交互,再回填 PRD 并反推 API |
|
|
151
|
+
| 原型评审 | `prototype-review` | 未通过时回到产品设计;通过后进入高保真 HTML 原型,不直接进入 PRD 校准 / API 影响分析 / 契约草案 |
|
|
152
|
+
| 高保真 HTML 原型 | `high-fidelity-html-prototype` | 低保真评审通过后的强制产物;必须使用 Ant Design v6,并基于官方 `@ant-design/cli` / Ant Design For Agents 指引,输出 `docs/design/prototypes/<feature>/index.html` |
|
|
151
153
|
| API 契约 | API 影响分析 / 契约草案 / OpenAPI Freeze 流程 | Draft 可讨论,Freeze 才可开发 |
|
|
152
154
|
| 正式变更设计 | `to-issues` / Matt skills | 复用 PRD,聚焦技术方案、风险和测试 seam |
|
|
153
155
|
| 拆切片 | `to-issues` | 必须是端到端垂直切片 |
|
|
@@ -208,7 +210,7 @@ Agent brief 最少包含:
|
|
|
208
210
|
适合并行:
|
|
209
211
|
|
|
210
212
|
- Discovery Agent 做竞品矩阵,Ideation Agent 基于同一主题做机会假设,最后由主 Agent 收敛。
|
|
211
|
-
- API Contract Agent 和 Architecture Agent 分别审查 Draft 与 DDD 边界,前提是校准后的 PRD
|
|
213
|
+
- API Contract Agent 和 Architecture Agent 分别审查 Draft 与 DDD 边界,前提是校准后的 PRD、产品总体设计 / 功能架构已稳定;有 UI 时,页面 / 原型 / 交互设计也已评审,或已明确无 UI 影响。
|
|
212
214
|
- 多个独立垂直切片,且不会修改同一批文件。
|
|
213
215
|
|
|
214
216
|
不适合并行:
|
|
@@ -363,7 +365,7 @@ docs/discovery/data-modeling-opportunity.md
|
|
|
363
365
|
|
|
364
366
|
## 6. 阶段 3:PRD 初稿 / 需求基线
|
|
365
367
|
|
|
366
|
-
PRD 把追问结论变成可交付需求,不写实现代码。这里的 PRD
|
|
368
|
+
PRD 把追问结论变成可交付需求,不写实现代码。这里的 PRD 先形成“需求基线”,不等于最终冻结版本;进入 PRD 初稿 / 需求基线流程后,必须先形成产品总体设计 / 功能架构,再按是否有 UI 决定是否进入页面 / 原型 / 交互设计,最后回填 PRD 并进入 API 影响分析 / 契约草案。
|
|
367
369
|
|
|
368
370
|
建议资产:
|
|
369
371
|
|
|
@@ -408,17 +410,17 @@ PRD 片段示例:
|
|
|
408
410
|
- [ ] 非目标范围清晰。
|
|
409
411
|
- [ ] 测试 seam 已明确。
|
|
410
412
|
- [ ] 待人工确认问题没有伪装成已确认需求。
|
|
411
|
-
- [ ]
|
|
413
|
+
- [ ] 产品总体设计 / 功能架构已作为 PRD 初稿后的必要产物进入下一阶段;不进入 PRD 生命周期的小文案、低风险 Bug 或局部配置变更已记录不适用原因。
|
|
412
414
|
|
|
413
415
|
## 7. 阶段 4:产品总体设计 / 功能架构
|
|
414
416
|
|
|
415
|
-
产品总体设计 / 功能架构是 PRD
|
|
417
|
+
产品总体设计 / 功能架构是 PRD 初稿到页面 / 原型 / 交互设计之间的过渡层。它回答“产品由哪些功能域和业务对象支撑”“MVP 做什么和不做什么”“哪些页面、状态、权限、API、数据会被影响”,并用低保真原型 / 页面草图先验证页面结构、关键操作和主流程。它不是详细交互说明,也不替代后续交互设计,而是页面 / 原型 / 交互设计的上游输入。
|
|
416
418
|
|
|
417
419
|
正确关系是先结构化、再原型化:
|
|
418
420
|
|
|
419
421
|
```text
|
|
420
422
|
PRD 初稿定义目标、范围、用户故事和验收
|
|
421
|
-
-> 产品总体设计 /
|
|
423
|
+
-> 产品总体设计 / 功能架构明确功能域、模块边界、低保真原型、页面/API/数据影响和 PRD 回填项
|
|
422
424
|
-> 页面 / 原型 / 交互设计验证用户如何完成任务
|
|
423
425
|
-> 交互发现遗漏后回填 PRD
|
|
424
426
|
-> PRD、产品总体设计和交互设计一起作为 API 影响分析 / 契约草案输入
|
|
@@ -440,6 +442,7 @@ docs/design/templates/product-overview-design-template.md
|
|
|
440
442
|
|
|
441
443
|
- [ ] 用户主流程、异常路径、业务对象和状态已足以支撑原型设计。
|
|
442
444
|
- [ ] 功能域、模块边界、优先级、依赖和非目标范围清楚。
|
|
445
|
+
- [ ] 低保真原型 / 页面草图已覆盖 P0 页面、主流程、关键操作和关键异常路径。
|
|
443
446
|
- [ ] 页面、API、数据、权限、审计影响已显式标注。
|
|
444
447
|
- [ ] PRD 回填项、开放问题和阻断项已记录。
|
|
445
448
|
- [ ] 可进入页面 / 原型 / 交互设计,或明确阻断原因。
|
|
@@ -475,12 +478,11 @@ docs/design/data-modeling-prototype-review.md
|
|
|
475
478
|
| 页面清单、用户流、状态矩阵、PRD 回填项、OpenAPI 反推 | `product-design-prototype` | 基于 PRD 初稿和产品总体设计后的原型入口 |
|
|
476
479
|
| 低保真线框、流程草图 | `wireframe-prototype`;Excalidraw / Markdown wireframe | 适合快速讨论,不绑定工程依赖 |
|
|
477
480
|
| 高保真或设计系统协作 | Figma / Penpot,必要时使用 `figma` / `figma-use` | 适合设计团队和组件规范沉淀 |
|
|
478
|
-
|
|
|
479
|
-
| API 未冻结前的交互数据 | `mock-api-prototype`;MSW / JSON fixtures | 适合支撑 Storybook 或前端原型 |
|
|
481
|
+
| 高保真可交互 HTML 原型 | `high-fidelity-html-prototype`;Ant Design v6 | 低保真原型评审通过后的必需产物,用于 PRD 校准和 API 反推前的体验确认 |
|
|
480
482
|
| 图谱、血缘、流程编排画布 | tldraw / xyflow | 适合数据血缘、任务流、关系图等画布型体验 |
|
|
481
|
-
|
|
|
483
|
+
| 进入高保真前门禁 | `prototype-review` | 未通过则回到原型阶段 |
|
|
482
484
|
|
|
483
|
-
如果团队使用 Figma、即时设计、Axure 或其它原型工具,可以在 `docs/design/data-modeling-interaction-spec.md` 中保存链接、版本、评审记录和关键截图说明。第一版不强制引入
|
|
485
|
+
如果团队使用 Figma、即时设计、Axure 或其它原型工具,可以在 `docs/design/data-modeling-interaction-spec.md` 中保存链接、版本、评审记录和关键截图说明。第一版不强制引入 Excalidraw、Figma、Penpot、tldraw 或 xyflow 作为项目依赖。
|
|
484
486
|
|
|
485
487
|
数据建模 MVP 的页面清单示例:
|
|
486
488
|
|
|
@@ -1006,11 +1008,23 @@ docs/user-guide/
|
|
|
1006
1008
|
最后输出:已确认、待确认、非目标、建议写入 CONTEXT 的术语、需要 ADR 的取舍。
|
|
1007
1009
|
```
|
|
1008
1010
|
|
|
1009
|
-
### 20.3
|
|
1011
|
+
### 20.3 产品总体设计 / 功能架构
|
|
1012
|
+
|
|
1013
|
+
```text
|
|
1014
|
+
基于 <PRD 路径>,为 <功能名> 生成产品总体设计 / 功能架构。
|
|
1015
|
+
请使用 docs/design/templates/product-overview-design-template.md。
|
|
1016
|
+
重点输出:设计目标、用户主流程、业务对象与状态、功能域与模块边界、Strategic DDD Check、低保真原型 / 页面草图、页面/API/数据/权限/审计影响、PRD 回填项、开放问题和评审结论。
|
|
1017
|
+
边界:不要写交互细节、不要生成 OpenAPI Draft、不要实现代码;只判断是否足以进入页面 / 原型 / 交互设计。
|
|
1018
|
+
保存到 docs/design/<feature>-product-overview-design.md。
|
|
1019
|
+
结论必须明确:Approved 可进入页面 / 原型 / 交互设计或 PRD 校准;Blocked 需先补齐产品边界、业务对象、模块边界、低保真原型、页面/API/数据/权限影响或 PRD 回填项。
|
|
1020
|
+
```
|
|
1021
|
+
|
|
1022
|
+
### 20.4 页面 / 原型 / 交互设计
|
|
1010
1023
|
|
|
1011
1024
|
```text
|
|
1012
1025
|
使用 product-design-prototype。
|
|
1013
|
-
基于 <PRD
|
|
1026
|
+
基于 <PRD 路径> 和 docs/design/<feature>-product-overview-design.md,为 <功能名> 输出页面 / 原型 / 交互设计资产。
|
|
1027
|
+
如果缺少产品总体设计 / 功能架构,先阻断并要求补齐;不要直接继续生成交互设计。
|
|
1014
1028
|
请生成页面清单、用户主路径、异常路径、低保真线框说明、交互状态矩阵、权限状态、空态/加载态/错误态。
|
|
1015
1029
|
请明确这些设计如何反推 OpenAPI 字段、错误结构、分页筛选、权限和前端验收标准。
|
|
1016
1030
|
请同时列出需要回填 PRD 的需求缺口、验收标准或非目标范围。
|
|
@@ -1018,24 +1032,35 @@ docs/user-guide/
|
|
|
1018
1032
|
完成后输出 prototype-review 评审输入清单。
|
|
1019
1033
|
```
|
|
1020
1034
|
|
|
1021
|
-
### 20.
|
|
1035
|
+
### 20.5 原型评审
|
|
1022
1036
|
|
|
1023
1037
|
```text
|
|
1024
1038
|
使用 prototype-review。
|
|
1025
|
-
输入资产:<PRD 路径>、docs/design/<feature>-interaction-spec.md、docs/design/<feature>-state-matrix.md、<原型链接或线框说明>。
|
|
1039
|
+
输入资产:<PRD 路径>、docs/design/<feature>-product-overview-design.md、docs/design/<feature>-interaction-spec.md、docs/design/<feature>-state-matrix.md、<原型链接或线框说明>。
|
|
1026
1040
|
请审查页面覆盖、主路径、异常路径、loading/empty/error/no-permission/readonly/conflict/dirty-form 状态、权限行为、字段级错误、PRD 回填项和 OpenAPI 反推清单。
|
|
1027
|
-
|
|
1041
|
+
输出:通过/阻断、阻断项、非阻断建议、高保真 HTML 原型输入就绪度、Contract Draft / OpenAPI Draft 输入风险和下一步。
|
|
1042
|
+
```
|
|
1043
|
+
|
|
1044
|
+
### 20.6 高保真 HTML 原型
|
|
1045
|
+
|
|
1046
|
+
```text
|
|
1047
|
+
使用 high-fidelity-html-prototype。
|
|
1048
|
+
基于 <PRD 路径>、docs/design/<feature>-product-overview-design.md、docs/design/<feature>-interaction-spec.md、docs/design/<feature>-state-matrix.md 和 docs/design/<feature>-prototype-review.md,
|
|
1049
|
+
为 <功能名> 生成 Ant Design v6 高保真可交互 HTML 原型。
|
|
1050
|
+
输出路径必须是 docs/design/prototypes/<feature>/index.html。
|
|
1051
|
+
请覆盖主流程、关键异常、loading/empty/error/no-permission/readonly/disabled/conflict/success 状态、表单校验、弹窗/抽屉、响应式断点。
|
|
1052
|
+
完成后给出 Ant Design v6 版本依据、`@ant-design/cli` 查询过的组件 / token / demo 和本地浏览器验证证据。
|
|
1028
1053
|
```
|
|
1029
1054
|
|
|
1030
|
-
### 20.
|
|
1055
|
+
### 20.7 PRD 校准 / 需求冻结
|
|
1031
1056
|
|
|
1032
1057
|
```text
|
|
1033
|
-
基于 <PRD
|
|
1058
|
+
基于 <PRD 路径>、<产品总体设计路径>、<交互设计路径> 和 <高保真 HTML 原型路径>,执行 PRD 校准。
|
|
1034
1059
|
请检查页面流、状态矩阵、异常路径、权限状态和验收标准是否已经回填 PRD。
|
|
1035
1060
|
输出:需要更新的 PRD 条目、仍待确认的问题、可以冻结的范围、不能进入 API 影响分析 / 契约草案的风险。
|
|
1036
1061
|
```
|
|
1037
1062
|
|
|
1038
|
-
### 20.
|
|
1063
|
+
### 20.8 技能路由
|
|
1039
1064
|
|
|
1040
1065
|
```text
|
|
1041
1066
|
使用 yss-router。
|
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: component-story-prototype
|
|
3
|
-
description: Use when Storybook, Histoire, component stories, page-state demos, or engineering prototypes are needed to validate UI states before full frontend implementation.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Component Story Prototype
|
|
7
|
-
|
|
8
|
-
Use this skill when design decisions need executable UI states. It plans engineering prototypes; it does not require adding Storybook or Histoire to a repo unless the frontend project chooses that dependency.
|
|
9
|
-
|
|
10
|
-
## When To Use
|
|
11
|
-
|
|
12
|
-
- Page behavior depends on many states: loading, empty, error, permission, conflict, readonly, dirty form.
|
|
13
|
-
- Product/design review needs a clickable or inspectable UI before API Freeze.
|
|
14
|
-
- Existing frontend already uses Storybook/Histoire, or the team wants a temporary engineering prototype.
|
|
15
|
-
|
|
16
|
-
If the repo has no story tooling and the task only needs low-fidelity flow decisions, use `wireframe-prototype` instead.
|
|
17
|
-
|
|
18
|
-
## Story Plan
|
|
19
|
-
|
|
20
|
-
For each page or interaction, define:
|
|
21
|
-
|
|
22
|
-
- Component/page name and route context.
|
|
23
|
-
- Mock inputs and visible data.
|
|
24
|
-
- Actions demonstrated.
|
|
25
|
-
- State variants.
|
|
26
|
-
- OpenAPI or mock fixture dependency.
|
|
27
|
-
- Acceptance notes that later become frontend tests or E2E paths.
|
|
28
|
-
|
|
29
|
-
Recommended variants:
|
|
30
|
-
|
|
31
|
-
```text
|
|
32
|
-
Default
|
|
33
|
-
Loading
|
|
34
|
-
Empty
|
|
35
|
-
ValidationError
|
|
36
|
-
NoPermission
|
|
37
|
-
ReadonlyPublishedVersion
|
|
38
|
-
ConflictOnPublish
|
|
39
|
-
DirtyFormLeavePrompt
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
## Data Modeling Example
|
|
43
|
-
|
|
44
|
-
For model field editing, plan stories for:
|
|
45
|
-
|
|
46
|
-
- `ModelList.Default`, `ModelList.Empty`, `ModelList.NoPermission`.
|
|
47
|
-
- `ModelDetail.DraftFields`, `ModelDetail.PublishedReadonly`.
|
|
48
|
-
- `FieldEditor.Valid`, `FieldEditor.FieldLevelErrors`.
|
|
49
|
-
- `PublishModel.ValidationFailed`, `PublishModel.Success`, `PublishModel.Conflict`.
|
|
50
|
-
|
|
51
|
-
Use `mock-api-prototype` when these stories need stable mock responses before OpenAPI Freeze.
|
|
52
|
-
|
|
53
|
-
## Handoff
|
|
54
|
-
|
|
55
|
-
Record the story plan in the interaction spec. Do not treat stories as a replacement for PRD, OpenAPI, or design review.
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: mock-api-prototype
|
|
3
|
-
description: Use when MSW, mock service worker, mock fixtures, fake API responses, or prototype data contracts are needed before OpenAPI Freeze or generated API clients are available.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Mock API Prototype
|
|
7
|
-
|
|
8
|
-
Use this skill to make prototypes exercise realistic data and error states before the formal API contract is frozen.
|
|
9
|
-
|
|
10
|
-
## Guardrail
|
|
11
|
-
|
|
12
|
-
Mock contracts are provisional. They may inform OpenAPI Draft, but they are not the source of truth after OpenAPI Freeze. Once the API is frozen, regenerate or align mocks from the frozen contract.
|
|
13
|
-
|
|
14
|
-
## Fixture Contract
|
|
15
|
-
|
|
16
|
-
For each mocked interaction, capture:
|
|
17
|
-
|
|
18
|
-
- Operation name and screen/action that uses it.
|
|
19
|
-
- Request params/body fields.
|
|
20
|
-
- Success response shape.
|
|
21
|
-
- Error response shape, including field-level validation errors when relevant.
|
|
22
|
-
- Permission and conflict responses.
|
|
23
|
-
- Pagination/filtering/sorting behavior when present.
|
|
24
|
-
|
|
25
|
-
## Tool Choices
|
|
26
|
-
|
|
27
|
-
| Situation | Suggested approach |
|
|
28
|
-
|---|---|
|
|
29
|
-
| Frontend prototype with network-like behavior | MSW handlers |
|
|
30
|
-
| Storybook/Histoire state-only demo | JSON fixtures or static module mocks |
|
|
31
|
-
| API design discussion | Markdown examples in interaction spec |
|
|
32
|
-
| Contract has been frozen | Generate or align from OpenAPI via `api-integration` / `yss-openapi` |
|
|
33
|
-
|
|
34
|
-
## Data Modeling Example
|
|
35
|
-
|
|
36
|
-
Prototype these responses:
|
|
37
|
-
|
|
38
|
-
- Model list success with draft/published statuses.
|
|
39
|
-
- Empty model list.
|
|
40
|
-
- Field editor save success.
|
|
41
|
-
- Field editor validation error with `fieldCode`, `message`, and `severity`.
|
|
42
|
-
- Publish validation failed with model-level and field-level errors.
|
|
43
|
-
- Publish conflict when version changed since page load.
|
|
44
|
-
- No-permission response for publish action.
|
|
45
|
-
|
|
46
|
-
## Handoff
|
|
47
|
-
|
|
48
|
-
Write mock examples into `docs/design/<feature>-interaction-spec.md` or the story plan. Then use `prototype-review` to confirm the mock data can drive PRD calibration and OpenAPI Draft.
|