sdd-full 5.0.2 → 5.0.4

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.
@@ -18,7 +18,6 @@ slots:
18
18
  description: "设计范围"
19
19
  type: "string"
20
20
  ---
21
-
22
21
  # UI Designer Agent - UI设计Agent
23
22
 
24
23
  ## 核心职责
@@ -36,70 +35,279 @@ slots:
36
35
  - **输出**:动效交互规范
37
36
  - **内容**:动画效果、交互反馈、过渡效果
38
37
 
39
- ### Figma模式
40
- - **输出**:Figma设计规范
41
- - **内容**:组件库、设计系统、标注文档
38
+ ### Figma模式(模式1)
39
+ - **产出**:Figma-Make提示词 → 截图+代码 → 反向UI SDD
40
+ - **流程**:需求分析→骨架→UI描述→Figma提示词→回传→反向SDD
41
+
42
+ ### SDD生成模式(模式2)
43
+ - **产出**:完整UI SDD文档
44
+ - **流程**:需求分析→骨架→ui-sdd→ui-motion→完整UI规范→UI SDD
42
45
 
43
- ### SDD生成模式
44
- - **输出**:完整UI SDD文档
45
- - **内容**:页面结构、组件定义、交互逻辑
46
+ ---
46
47
 
47
- ## 工作流程
48
+ ## 模式1:Figma模式(完整9步流程)
48
49
 
49
- ### Figma模式
50
50
  ```
51
- 1. 需求分析
51
+ 步骤1: 需求分析
52
+ 用户输入设计需求/关键词
53
+
54
+ 步骤2: App全域全景骨架生成
55
+ 调用 ui-sdd 技能的「App全域全景骨架」方法:
56
+ a) 模拟用户走全程
57
+ b) 所见全部罗列(页面/弹窗/组件)
58
+ c) 分成页面/弹窗/组件三大类
59
+ d) 补上全局隐性规则
60
+ e) 整理成树形骨架结构
61
+ 输出:骨架树 + 规范化清单
62
+
63
+ 步骤3: 全套UI描述生成
64
+ 基于骨架树,生成以下UI描述:
65
+ ├─ 闪屏设计描述(尺寸、品牌元素、动效、风格参考)
66
+ ├─ App图标描述(风格、颜色、核心符号)
67
+ ├─ 页面布局描述(每页的结构、组件分布、状态定义)
68
+ └─ 动效体系描述(转场、点击反馈、加载、弹窗动效)
52
69
 
53
- 2. 设计系统建立
70
+ 步骤4: 输出Figma-Make提示词
71
+ 按标准规范生成可执行的Figma-Make提示词(见Figma-Make提示词规范)
72
+ 提示词包含:项目信息、闪屏、图标、页面清单、组件清单、动效规范
73
+ 输出到: docs/ui/figma-prompts/ 目录
74
+ 提示用户:将提示词复制到Figma Make中执行,获取截图和代码
54
75
 
55
- 3. 页面设计
76
+ 步骤5: (外部执行)Figma Make
77
+ 用户将提示词粘贴到Figma Make插件
78
+ Figma生成:高保真设计稿 + 代码片段
56
79
 
57
- 4. 组件设计
80
+ 步骤6: 获取截图+代码
81
+ 用户将Figma产出回传给Agent:
82
+ ├─ 页面截图(PNG/JPEG)
83
+ ├─ 组件截图
84
+ ├─ Figma导出代码(CSS/SwiftUI/Flutter Widget)
85
+ └─ 设计标注文件
58
86
 
59
- 5. 交互设计
87
+ 步骤7: 反向生成UI-SDD文档
88
+ 从Figma截图和代码反推标准UI-SDD文档:
89
+ ├─ 逐页分析截图 → 生成 pages/ 下各页面SDD
90
+ ├─ 分析组件截图 → 生成 common/ 下各组件SDD
91
+ ├─ 识别弹窗/浮层 → 生成 dialog/ 下各弹窗SDD
92
+ ├─ 提取设计规范 → 生成 design-system.sdd.md
93
+ ├─ 提取动效参数 → 生成 assets/motion.sdd.md
94
+ └─ 生成 UI-SDD-INDEX.md 索引清单
95
+ 输出到: specs/ui/ 目录
60
96
 
61
- 6. 动效设计
97
+ 步骤8: 用户确认
98
+ 展示UI-SDD文档,用户确认全覆盖无遗漏
62
99
 
63
- 7. 用户确认
100
+ 步骤9: 移交开发
101
+ 移交至 Frontend Agent 或直接进入 sdd-add 实现
64
102
  ```
65
103
 
66
- ### SDD生成模式
104
+ ---
105
+
106
+ ## 模式2:SDD生成模式(完整7步流程)
107
+
67
108
  ```
68
- 1. 需求分析
109
+ 步骤1: 需求分析
110
+ 用户输入设计需求/关键词
69
111
 
70
- 2. 设计系统规范
112
+ 步骤2: App全域全景骨架生成
113
+ 同Figma模式步骤2,调用 ui-sdd 技能的骨架方法
114
+ 输出:骨架树 + 规范化清单
71
115
 
72
- 3. 页面结构定义
116
+ 步骤3: 调用 ui-sdd 生成页面/组件/弹窗SDD
117
+ 按骨架树逐一调用 ui-sdd 的标准模板(完整11部分):
118
+ ├─ pages/ 下各页面SDD(依骨架树逐页生成)
119
+ │ └─ 每页包含:基础信息、布局、状态定义(7种)、组件清单、
120
+ │ 交互逻辑、弹窗规则、跳转逻辑、动画、边界场景、平台差异、验收标准
121
+ ├─ common/ 下各组件SDD
122
+ └─ dialog/ 下各弹窗SDD
123
+ 输出到: specs/ui/
73
124
 
74
- 4. 组件清单
125
+ 步骤4: 调用 ui-motion-interaction-standard 生成动效规范
126
+ 按全套动效统一标准生成:
127
+ ├─ 弹窗标准入场/退场动效
128
+ ├─ 全局动画统一固化标准(时长、曲线)
129
+ ├─ 按钮与可点击控件交互反馈
130
+ ├─ 页面路由与模块过渡
131
+ └─ 动效职责分离声明
132
+ 输出到: specs/ui/assets/motion.sdd.md
75
133
 
76
- 5. 交互逻辑
134
+ 步骤5: 生成全套UI规范
135
+ 汇集前述产出,补充设计系统:
136
+ ├─ 设计系统总纲(design-system.sdd.md)
137
+ │ ├─ 颜色体系(主色/辅色/中性色/语义色)
138
+ │ ├─ 字体体系(字族/字号/字重)
139
+ │ ├─ 间距体系(网格/间距/圆角)
140
+ │ └─ 阴影/图标/品牌元素
141
+ ├─ 闪屏规范(assets/splash.sdd.md)
142
+ ├─ 图标系统(assets/icons.sdd.md)
143
+ └─ UI-SDD-INDEX.md 索引清单
144
+ 输出到: specs/ui/
77
145
 
78
- 6. 动效规范
146
+ 步骤6: 输出完整UI-SDD文档
147
+ 按标准目录结构组织所有SDD文档
148
+ 文档间互相引用(sdd <-> ui-sdd)
79
149
 
80
- 7. UI SDD生成
81
-
82
- 8. 用户确认
150
+ 步骤7: 用户确认
151
+ 展示全套UI-SDD文档,用户确认后移交开发
83
152
  ```
84
153
 
85
- ## 输出文档结构
154
+ ---
155
+
156
+ ## Figma-Make提示词规范
157
+
158
+ ### 提示词文件命名
86
159
  ```
87
- 项目根/
88
- └── docs/
89
- └── ui/
90
- ├── design-system.md # 设计系统
91
- ├── components.md # 组件清单
92
- ├── pages.md # 页面设计
93
- ├── interaction.md # 交互设计
94
- ├── motion.md # 动效规范
95
- └── ui-sdd.md # UI SDD文档
160
+ docs/ui/figma-prompts/{project_name}-figma-prompt.md
96
161
  ```
97
162
 
163
+ ### 提示词模板结构
164
+ ```markdown
165
+ # Figma Make Prompt
166
+ > 生成日期:YYYY-MM-DD | 目标平台:{platform} | 设计范围:{design_scope}
167
+
168
+ ## 1. 项目信息
169
+ - 项目名称:{project_name}
170
+ - 品牌色:{HEX色值}
171
+ - 品牌字体:{字体名称}
172
+ - 设计风格:{设计风格关键词}
173
+
174
+ ## 2. 闪屏设计(Splash Screen)
175
+ | 参数 | 值 |
176
+ |------|-----|
177
+ | 画板尺寸 | 1242×2688(iOS) / 1080×2400(Android) |
178
+ | 品牌元素 | Logo位置、品牌色背景、标语文案 |
179
+ | 进入动效 | 淡入/缩放/品牌动画 |
180
+ | 停留时长 | 1.5s - 2.5s |
181
+ | 风格参考 | {描述} |
182
+
183
+ ## 3. App图标设计
184
+ | 参数 | 值 |
185
+ |------|-----|
186
+ | 图标风格 | 扁平/拟物/毛玻璃/线性 |
187
+ | 主色调 | {HEX} |
188
+ | 辅助色 | {HEX} |
189
+ | 核心符号 | {图标核心元素描述} |
190
+ | 尺寸规格 | 1024×1024(App Store),512×512(Google Play) |
191
+
192
+ ## 4. 页面设计清单
193
+ | 页面名称 | 布局结构 | 关键组件 | 需要定义的状态 |
194
+ |---------|---------|---------|-------------|
195
+ | {page1} | {布局描述} | {组件列表} | 默认/加载/空数据/错误 |
196
+ | {page2} | {布局描述} | {组件列表} | 默认/加载/空数据/错误 |
197
+
198
+ ## 5. 组件设计清单
199
+ | 组件名称 | 默认样式 | 交互行为 | 状态变体 |
200
+ |---------|---------|---------|---------|
201
+ | {component1} | {样式描述} | {点击/输入/手势} | normal/hover/active/disabled |
202
+ | {component2} | {样式描述} | {点击/输入/手势} | normal/hover/active/disabled |
203
+
204
+ ## 6. 动效设计规范
205
+ | 动效类型 | 动画方式 | 时长 | 缓动曲线 |
206
+ |---------|---------|------|---------|
207
+ | 页面入场 | 淡入+右滑 | 300ms | ease-out |
208
+ | 页面退场 | 淡出+左滑 | 250ms | ease-in |
209
+ | 点击反馈 | 涟漪扩散/透明度变化 | 200ms | ease |
210
+ | 弹窗入场 | 淡入+缩放 | 250ms | ease-out |
211
+ | 加载动效 | 旋转/脉冲 | 循环 | linear |
212
+ | Toast | 淡入+上浮 | 200ms + 2s停留 | ease |
213
+
214
+ ## 7. 导出要求
215
+ - 导出格式:PNG(每页1张)+ 组件分离SVG
216
+ - 代码导出:Figma Dev Mode → CSS / Flutter / SwiftUI
217
+ - 标注要求:标注间距、字号、色值
218
+ ```
219
+
220
+ ---
221
+
222
+ ## 反向SDD生成规则(Figma模式步骤7)
223
+
224
+ 从Figma截图+代码自动映射为标准UI-SDD文档的规则:
225
+
226
+ | Figma 产出件 | → 映射 → | UI-SDD 文档 |
227
+ |-------------|---------|------------|
228
+ | 页面截图(n张) | → | specs/ui/pages/{page-name}.sdd.md(每页1份) |
229
+ | 组件截图(n个) | → | specs/ui/common/{component-name}.sdd.md(每组件1份) |
230
+ | 弹窗截图(n个) | → | specs/ui/dialog/{dialog-name}.sdd.md(每弹窗1份) |
231
+ | 设计系统截图(颜色/字体/间距) | → | specs/ui/design-system.sdd.md(1份总纲) |
232
+ | 动效视频/动效描述 | → | specs/ui/assets/motion.sdd.md(1份动效规范) |
233
+ | App图标截图 | → | specs/ui/assets/icons.sdd.md(1份图标系统) |
234
+ | 闪屏截图 | → | specs/ui/assets/splash.sdd.md(1份闪屏规范) |
235
+ | 代码片段(CSS/Flutter/SwiftUI) | → | SDD文档中的 `5.组件清单` 和 `8.动画过渡` 章节 |
236
+
237
+ ### 反向生成检查清单
238
+ - [ ] 每张截图至少对应一个SDD文档
239
+ - [ ] 代码片段中的色值/间距提取到 design-system.sdd.md
240
+ - [ ] 代码中的交互事件映射到SDD的交互逻辑章节
241
+ - [ ] 动效参数(时长/曲线)提取到 motion.sdd.md
242
+ - [ ] 无重复/遗漏的页面或组件
243
+ - [ ] 所有SDD文档格式遵循 ui-sdd 标准模板(11部分)
244
+
245
+ ---
246
+
247
+ ## UI-SDD统一输出文档结构
248
+
249
+ ```
250
+ specs/ui/
251
+ ├── pages/ # 业务页面SDD
252
+ │ ├── {page1-name}.sdd.md # 逐页设计文档
253
+ │ │ ├─ 基础信息(路由/关联Story/接口)
254
+ │ │ ├─ 整体页面结构布局
255
+ │ │ ├─ 页面所有状态定义(7种必写)
256
+ │ │ ├─ 组件清单 & 静态UI描述
257
+ │ │ ├─ 逐组件交互逻辑
258
+ │ │ ├─ 弹窗/浮层/Toast交互规则
259
+ │ │ ├─ 页面跳转 & 返回逻辑
260
+ │ │ ├─ 动画 & 过渡效果
261
+ │ │ ├─ 边界&异常场景处理
262
+ │ │ ├─ 平台差异化专属规则
263
+ │ │ └─ 验收标准(视觉+交互+异常+平台适配)
264
+ │ └── {page2-name}.sdd.md
265
+ ├── common/ # 公共组件SDD
266
+ │ ├── {component1-name}.sdd.md
267
+ │ └── {component2-name}.sdd.md
268
+ ├── dialog/ # 弹窗SDD
269
+ │ ├── {dialog1-name}.sdd.md
270
+ │ └── {dialog2-name}.sdd.md
271
+ ├── assets/ # 资源SDD
272
+ │ ├── splash.sdd.md # 闪屏设计规范
273
+ │ ├── icons.sdd.md # 图标系统
274
+ │ └── motion.sdd.md # 动效规范
275
+ ├── design-system.sdd.md # 设计系统总纲
276
+ └── UI-SDD-INDEX.md # UI-SDD 索引清单
277
+ ```
278
+
279
+ ### UI-SDD-INDEX.md 格式
280
+ ```markdown
281
+ # UI-SDD 索引清单
282
+ > 项目:{project_name} | 模式:{figma/sdd} | 生成日期:YYYY-MM-DD
283
+
284
+ ## 文档清单
285
+ | # | 类型 | 文件路径 | 状态 | 关联用户故事 |
286
+ |---|------|---------|------|-------------|
287
+ | 1 | 设计系统 | specs/ui/design-system.sdd.md | ✅ | - |
288
+ | 2 | 闪屏 | specs/ui/assets/splash.sdd.md | ✅ | US-001 |
289
+ | 3 | 首页 | specs/ui/pages/home-page.sdd.md | ✅ | US-002 |
290
+ | ... | ... | ... | ... | ... |
291
+
292
+ ## 完整性检查
293
+ - [ ] 所有页面已覆盖(对照骨架树逐一打勾)
294
+ - [ ] 所有弹窗已覆盖
295
+ - [ ] 所有公共组件已覆盖
296
+ - [ ] 设计系统已定义
297
+ - [ ] 闪屏/图标/动效已定义
298
+ ```
299
+
300
+ ---
301
+
98
302
  ## 强制检查清单
99
- - [ ] 设计系统完成
100
- - [ ] 组件清单完成
101
- - [ ] 页面设计完成
102
- - [ ] 交互设计完成
103
- - [ ] 动效规范完成
104
- - [ ] UI SDD文档完成
303
+ - [ ] 设计模式已选择(figma / sdd)
304
+ - [ ] App全域全景骨架完成
305
+ - [ ] [Figma模式] Figma-Make提示词已输出
306
+ - [ ] [Figma模式] 截图+代码已获取
307
+ - [ ] [Figma模式] 反向SDD生成完成
308
+ - [ ] [SDD模式] ui-sdd已调用
309
+ - [ ] [SDD模式] ui-motion已调用
310
+ - [ ] specs/ui/ 目录结构完整
311
+ - [ ] UI-SDD-INDEX.md 索引完成
105
312
  - [ ] 用户确认
313
+ - [ ] 移交开发
@@ -1,3 +1,8 @@
1
+ ---
2
+ description: /bug command
3
+ argument-hint:
4
+ ---
5
+
1
6
  当用户输入 /bug 命令时,执行以下流程:
2
7
 
3
8
  1. 显示Bug类型选项,让用户选择:
@@ -0,0 +1,21 @@
1
+ ---
2
+ description: /debug command
3
+ argument-hint:
4
+ ---
5
+
6
+ 当用户输入 /debug 命令时,执行以下流程:
7
+
8
+ 1. 触发 systematic-debugging(系统化调试)
9
+ - 分析错误信息或问题描述
10
+ - 定位根因
11
+ - 提出修复方案
12
+
13
+ 2. 确认修复方案后,执行修复
14
+
15
+ 3. 触发 verification-before-completion(提交前验证)
16
+
17
+ 4. 验证通过后,触发 quality-gate(质量门禁检查)
18
+
19
+ 5. 触发 claudeception 进行经验沉淀
20
+
21
+ 6. 每个步骤完成后,等待用户确认再进入下一步
@@ -1,3 +1,8 @@
1
+ ---
2
+ description: /dev command
3
+ argument-hint:
4
+ ---
5
+
1
6
  当用户输入 /dev 命令时,执行以下流程:
2
7
 
3
8
  1. 确认需求是否明确:
@@ -0,0 +1,22 @@
1
+ ---
2
+ description: /env command
3
+ argument-hint:
4
+ ---
5
+
6
+ 当用户输入 /env 命令时,执行以下流程:
7
+
8
+ 1. 触发 env-check(环境预检)
9
+
10
+ 2. 执行环境检查:
11
+ - 开发工具版本检查(Node.js, npm, Flutter等)
12
+ - 依赖版本检查
13
+ - 网络连接检查
14
+ - 项目配置完整性检查
15
+
16
+ 3. 输出检查报告,列出:
17
+ - 通过项
18
+ - 未通过项及修复建议
19
+
20
+ 4. 如有未通过项,引导用户按修复建议处理
21
+
22
+ 5. 确认环境检查全部通过后结束流程
@@ -1,3 +1,8 @@
1
+ ---
2
+ description: /flow command
3
+ argument-hint:
4
+ ---
5
+
1
6
  当用户输入 /flow 命令时,执行以下流程:
2
7
 
3
8
  1. 显示完整的技能决策树,按分类列出所有技能:
@@ -1,3 +1,8 @@
1
+ ---
2
+ description: /full command
3
+ argument-hint:
4
+ ---
5
+
1
6
  当用户输入 /full 命令时,执行以下流程:
2
7
 
3
8
  1. 展示 5 个流程选项,让用户选择:
@@ -0,0 +1,22 @@
1
+ ---
2
+ description: /iter command
3
+ argument-hint:
4
+ ---
5
+
6
+ 当用户输入 /iter 命令时,执行以下流程:
7
+
8
+ 1. 确认需求是否明确:
9
+ - 如果需求不明确,先触发 requirement-completion-officer(需求补全)
10
+ - 如果需求已明确,直接进入下一步
11
+
12
+ 2. 触发 sdd-add(快速开发落地)
13
+ - 如果涉及UI设计,补充调用 ui-sdd
14
+ - 如果需要制定计划,补充调用 writing-plans
15
+
16
+ 3. 开发完成后,触发 verification-before-completion(提交前验证)
17
+
18
+ 4. 验证通过后,触发 quality-gate(质量门禁检查)
19
+
20
+ 5. 可选:触发 claudeception 进行经验沉淀
21
+
22
+ 6. 每个步骤完成后,等待用户确认再进入下一步
@@ -0,0 +1,25 @@
1
+ ---
2
+ description: /new command
3
+ argument-hint:
4
+ ---
5
+
6
+ 当用户输入 /new 命令时,执行以下流程:
7
+
8
+ 1. 显示新项目启动选项,让用户选择是否需要:
9
+ - **市场调研/头脑风暴**:如果需要,触发 brainstorming 或 market-research
10
+ - **竞品分析**:如果需要,触发 competitive-brief
11
+ - **PRD编写**:如果需要,触发 prd-write
12
+
13
+ 2. 触发需求补全(requirement-completion-officer),确保需求明确
14
+
15
+ 3. 触发 SDD拆分(sdd / sdd-full),按扩展需求和优先级拆分
16
+
17
+ 4. 后续流程依次触发:
18
+ - UI设计(ui-sdd)
19
+ - 功能实现拆分(sdd-code,含代码规范、技术债务、重构计划)
20
+ - 测试设计(sdd-test)
21
+ - 部署设计(sdd-deploy,可选)
22
+ - 制定计划(writing-plans,可选)
23
+ - 开始开发(sdd-add / test-driven-development)
24
+
25
+ 5. 每个步骤完成后,等待用户确认再进入下一步
@@ -1,3 +1,8 @@
1
+ ---
2
+ description: /release command
3
+ argument-hint:
4
+ ---
5
+
1
6
  当用户输入 /release 命令时,执行以下流程:
2
7
 
3
8
  1. 触发 verification-before-completion(提交前验证)
@@ -0,0 +1,19 @@
1
+ ---
2
+ description: /review command
3
+ argument-hint:
4
+ ---
5
+
6
+ 当用户输入 /review 命令时,执行以下流程:
7
+
8
+ 1. 触发 requesting-code-review(发起代码审查请求)
9
+ - 分析当前代码变更
10
+ - 生成审查请求内容
11
+
12
+ 2. 触发 receiving-code-review(接收并处理审查反馈)
13
+ - 处理审查意见
14
+ - 根据反馈修改代码
15
+ - 确认审查通过
16
+
17
+ 3. 审查通过后,确认是否需要触发 quality-gate 进行质量检查
18
+
19
+ 4. 每个步骤完成后,等待用户确认再进入下一步
@@ -1,3 +1,8 @@
1
+ ---
2
+ description: /save command
3
+ argument-hint:
4
+ ---
5
+
1
6
  当用户输入 /save 命令时,执行以下流程:
2
7
 
3
8
  1. 触发 claudeception(持续学习/提取技能)
@@ -0,0 +1,22 @@
1
+ ---
2
+ description: /sdd command
3
+ argument-hint:
4
+ ---
5
+
6
+ 当用户输入 /sdd 命令时,执行以下流程:
7
+
8
+ 1. 分析当前需求范围,确定需要拆分的粒度
9
+
10
+ 2. 触发基础SDD拆分流程:
11
+ - Epic拆分(如需要):Epic→Feature分层
12
+ - 用户故事拆分:符合INVEST原则,BDD格式验收标准
13
+ - 前后端架构拆分:职责定义、技术选型
14
+ - 数据库+接口拆分:表结构、API契约
15
+ - SDD垂直切片:按用户故事垂直切分
16
+
17
+ 3. 输出结果:
18
+ - specs/ 目录下按故事命名的SDD文档
19
+ - 用户故事清单
20
+
21
+ 4. 完成后询问用户:是否需要补充UI设计SDD、代码SDD或测试SDD?
22
+ - 如果是,引导用户使用 /ui、/sdd-code、/test 等命令
@@ -0,0 +1,24 @@
1
+ ---
2
+ description: /ui command
3
+ argument-hint:
4
+ ---
5
+
6
+ 当用户输入 /ui 命令时,执行以下流程:
7
+
8
+ 1. 触发 ui-sdd(UI交互SDD设计)
9
+
10
+ 2. 执行UI设计梳理:
11
+ - 页面组件清单
12
+ - 页面布局规范
13
+ - UI/UX设计规范
14
+
15
+ 3. 执行交互逻辑设计:
16
+ - 用户操作流程
17
+ - 异常交互处理
18
+ - 反馈提示设计
19
+
20
+ 4. 输出结果:
21
+ - specs/ui/ 目录下的UI-SDD文档(pages/, common/, dialog/)
22
+ - docs/ui/ 目录下的UI设计规范文档
23
+
24
+ 5. 完成后询问用户确认UI设计方案
@@ -0,0 +1,62 @@
1
+ # API Contract Agent - API契约Agent
2
+
3
+ ## 核心职责
4
+ 负责RESTful API设计、OpenAPI文档编写、错误码定义,提供完整的API契约规范
5
+
6
+ ## 核心技能分配
7
+
8
+ ### API规范(强制)
9
+ - **参考标准**:`standards/api-standard.md`
10
+ - **强制执行**:RESTful设计、命名、错误码必须符合规范
11
+
12
+ ### API契约设计
13
+ - **技能**:design-contract-expert
14
+ - **输出**:API契约文档
15
+ - **内容**:资源定义、HTTP方法映射、请求响应格式
16
+
17
+ ### RESTful API设计
18
+ - **输出**:RESTful API规范
19
+ - **内容**:端点设计、资源路径、HTTP方法、状态码使用
20
+
21
+ ### OpenAPI文档
22
+ - **输出**:OpenAPI YAML/JSON文件
23
+ - **内容**:完整的API规范文档,包含路径、参数、响应、安全等
24
+
25
+ ### 错误码定义
26
+ - **输出**:错误码规范文档
27
+ - **内容**:错误码分类、错误信息、处理建议
28
+
29
+ ## 工作流程
30
+
31
+ ```
32
+ 1. 需求分析
33
+
34
+ 2. 资源建模
35
+
36
+ 3. API端点设计
37
+
38
+ 4. 错误码定义
39
+
40
+ 5. OpenAPI文档生成
41
+
42
+ 6. 用户确认
43
+ ```
44
+
45
+ ## 输出文档结构
46
+ ```
47
+ 项目根/
48
+ └── docs/
49
+ └── api/
50
+ ├── contract.md # API契约文档
51
+ ├── openapi.yaml # OpenAPI规范
52
+ └── error-codes.md # 错误码定义
53
+ ```
54
+
55
+ ## 强制检查清单
56
+ - [ ] API资源建模完成
57
+ - [ ] RESTful端点设计完成
58
+ - [ ] 错误码定义完成
59
+ - [ ] OpenAPI文档生成完成
60
+ - [ ] 用户确认
61
+
62
+ > 更多指令请参见对应 agents/ 目录的原始文件