@llryiop/avatar-boot-cli 1.0.0

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.
Files changed (77) hide show
  1. package/README.md +309 -0
  2. package/bin/cli.js +3 -0
  3. package/docs/plans/2026-03-12-avatar-boot-cli-design.md +73 -0
  4. package/docs/plans/2026-03-12-avatar-boot-cli-plan.md +681 -0
  5. package/package.json +28 -0
  6. package/src/index.js +78 -0
  7. package/src/prompts.js +78 -0
  8. package/src/template.js +37 -0
  9. package/src/transform.js +172 -0
  10. package/src/utils.js +34 -0
  11. package/templates/.claude/rules/architecture-redlines.md +146 -0
  12. package/templates/.claude/rules/code-review-standards.md +137 -0
  13. package/templates/.claude/rules/coding-standards.md +56 -0
  14. package/templates/.claude/rules/git-commit.md +59 -0
  15. package/templates/.claude/rules/layered-architecture.md +201 -0
  16. package/templates/.claude/rules/mybatis-plus.md +263 -0
  17. package/templates/.claude/rules/tech-stack.md +41 -0
  18. package/templates/.claude/rules/version.md +467 -0
  19. package/templates/.claude/settings.local.json +18 -0
  20. package/templates/.claude/skills/ai-tool-guide/SKILL.md +314 -0
  21. package/templates/.claude/skills/api-design/SKILL.md +200 -0
  22. package/templates/.claude/skills/api-doc-generator/SKILL.md +380 -0
  23. package/templates/.claude/skills/api-service-module-creator/SKILL.md +1114 -0
  24. package/templates/.claude/skills/avatar-boot-starter-feign/SKILL.md +243 -0
  25. package/templates/.claude/skills/avatar-boot-starter-job/SKILL.md +437 -0
  26. package/templates/.claude/skills/avatar-boot-starter-kafka/SKILL.md +580 -0
  27. package/templates/.claude/skills/avatar-boot-starter-mysql/SKILL.md +572 -0
  28. package/templates/.claude/skills/avatar-boot-starter-nacos/SKILL.md +901 -0
  29. package/templates/.claude/skills/avatar-boot-starter-oss/SKILL.md +594 -0
  30. package/templates/.claude/skills/avatar-boot-starter-redis/SKILL.md +586 -0
  31. package/templates/.claude/skills/avatar-boot-starter-rocketmq/SKILL.md +662 -0
  32. package/templates/.claude/skills/avatar-boot-starter-web/SKILL.md +1007 -0
  33. package/templates/.claude/skills/changelog-generator/SKILL.md +114 -0
  34. package/templates/.claude/skills/code-review/SKILL.md +239 -0
  35. package/templates/.claude/skills/crud-generator/SKILL.md +824 -0
  36. package/templates/.claude/skills/database-design/SKILL.md +377 -0
  37. package/templates/.claude/skills/deployment-config/SKILL.md +277 -0
  38. package/templates/.claude/skills/incident-analysis/SKILL.md +241 -0
  39. package/templates/.claude/skills/integration-test-generator/SKILL.md +496 -0
  40. package/templates/.claude/skills/prompt-engineering/SKILL.md +249 -0
  41. package/templates/.claude/skills/requirement-management/SKILL.md +244 -0
  42. package/templates/.claude/skills/security-audit/SKILL.md +330 -0
  43. package/templates/.claude/skills/test-case-design/SKILL.md +257 -0
  44. package/templates/.claude/skills/testing-workflow/SKILL.md +68 -0
  45. package/templates/.claude/skills/troubleshooting/SKILL.md +240 -0
  46. package/templates/CLAUDE.md +173 -0
  47. package/templates/README.md +303 -0
  48. package/templates/avatar-scaffold-api/pom.xml +41 -0
  49. package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/api/LoginFeignClient.java +40 -0
  50. package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/constant/LoginConstant.java +21 -0
  51. package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/dto/request/LoginRequest.java +17 -0
  52. package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/dto/request/RefreshTokenRequest.java +14 -0
  53. package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/dto/response/LoginResponse.java +31 -0
  54. package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/dto/response/TokenInfoResponse.java +25 -0
  55. package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/enums/LoginTypeEnum.java +23 -0
  56. package/templates/avatar-scaffold-api/src/main/java/com/iflytek/avatar/login/exception/LoginException.java +23 -0
  57. package/templates/avatar-scaffold-service/k8s-app/Dockerfile +14 -0
  58. package/templates/avatar-scaffold-service/k8s-app/Dockerfile-arm64 +14 -0
  59. package/templates/avatar-scaffold-service/packaging/assembly.xml +16 -0
  60. package/templates/avatar-scaffold-service/pom.xml +150 -0
  61. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/Application.java +21 -0
  62. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/login/config/LoginConfig.java +20 -0
  63. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/login/controller/LoginController.java +37 -0
  64. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/login/converter/LoginConverter.java +54 -0
  65. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/login/feign/DemoFeign.java +21 -0
  66. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/login/repository/entity/UserLoginEntity.java +33 -0
  67. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/login/repository/entity/UserTokenEntity.java +39 -0
  68. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/login/repository/mapper/UserLoginMapper.java +20 -0
  69. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/login/service/LoginService.java +22 -0
  70. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/login/service/impl/LoginServiceImpl.java +43 -0
  71. package/templates/avatar-scaffold-service/src/main/java/com/iflytek/avatar/login/utils/LoginUtils.java +31 -0
  72. package/templates/avatar-scaffold-service/src/main/resources/application-dev.yaml +29 -0
  73. package/templates/avatar-scaffold-service/src/main/resources/application-local.yaml +61 -0
  74. package/templates/avatar-scaffold-service/src/main/resources/application-prod.yaml +28 -0
  75. package/templates/avatar-scaffold-service/src/main/resources/application-test.yaml +28 -0
  76. package/templates/avatar-scaffold-service/src/main/resources/application.yaml +12 -0
  77. package/templates/pom.xml +98 -0
@@ -0,0 +1,249 @@
1
+ ---
2
+ name: prompt-engineering
3
+ description: |
4
+ Avatar Boot 项目 Prompt 模板库 — 提供 Java 开发各场景的即用 Prompt 模板和上下文片段。
5
+ 触发条件:Prompt模板, prompt template, 提示词模板, prompt engineering
6
+ 通用 Prompt 技巧请参考 ai-tool-guide Skill。
7
+ ---
8
+
9
+ # Prompt 模板库
10
+
11
+ > Avatar Boot 项目专用 — 各场景可直接复用的 Prompt 模板
12
+
13
+ ---
14
+
15
+ ## 1. 代码生成 — CRUD 模块
16
+
17
+ ```
18
+ ## 任务
19
+ 为 [模块名] 模块生成完整的 CRUD 代码。
20
+
21
+ ## 技术栈
22
+ - Java 21, Spring Boot 3.5.3, Avatar Boot 框架
23
+ - 持久层:MyBatis-Plus
24
+ - 数据库:MySQL 8.0
25
+
26
+ ## 数据库表结构
27
+ [粘贴 CREATE TABLE 语句]
28
+
29
+ ## 要求
30
+ 1. 分层架构:Controller → Service(接口+实现) → Mapper
31
+ 2. 统一返回 Result<T>
32
+ 3. 参数校验使用 Jakarta Validation
33
+ 4. 分页查询使用 MyBatis-Plus 的 Page<T>
34
+ 5. Entity 使用 @TableName 注解
35
+ 6. DTO 用于接收请求参数,VO 用于返回响应数据
36
+ 7. Service 实现类添加 @Transactional 注解(写操作)
37
+
38
+ ## 输出
39
+ 按文件逐个输出完整代码,包含 package 声明和 import 语句。
40
+ ```
41
+
42
+ ## 2. 代码生成 — Service 方法
43
+
44
+ ```
45
+ ## 任务
46
+ 在 [ServiceName] 中添加 [方法描述] 方法。
47
+
48
+ ## 现有代码
49
+ [粘贴 Service 接口和相关 Entity/DTO]
50
+
51
+ ## 业务逻辑
52
+ 1. [步骤1]
53
+ 2. [步骤2]
54
+ 3. [步骤3]
55
+
56
+ ## 约束
57
+ - 使用 Result<T> 返回
58
+ - 异常使用 BizException 抛出
59
+ - 需要事务控制的操作添加 @Transactional
60
+ - 遵循现有代码的风格和命名规范
61
+ ```
62
+
63
+ ## 3. 代码审查
64
+
65
+ ```
66
+ ## 任务
67
+ 请对以下代码进行全面审查。
68
+
69
+ ## 审查维度
70
+ 1. **安全性**:SQL注入、XSS、权限校验、敏感数据处理
71
+ 2. **性能**:N+1查询、不必要的循环、大对象创建、缓存使用
72
+ 3. **规范性**:命名规范、代码结构、注释完整性、异常处理
73
+ 4. **可维护性**:代码重复、方法长度、圈复杂度、依赖关系
74
+
75
+ ## 代码
76
+ [粘贴待审查代码]
77
+
78
+ ## 输出格式
79
+ 按审查维度分类,每个问题包含:
80
+ - 问题位置(行号或方法名)
81
+ - 问题描述
82
+ - 严重程度(Critical / Major / Minor)
83
+ - 修复建议(含代码示例)
84
+ ```
85
+
86
+ ## 4. Bug 修复
87
+
88
+ ```
89
+ ## 问题描述
90
+ [简要描述问题现象]
91
+
92
+ ## 异常堆栈
93
+ [粘贴完整堆栈信息]
94
+
95
+ ## 相关代码
96
+ [粘贴出错的类和方法]
97
+
98
+ ## 期望行为
99
+ [描述正确的行为应该是什么]
100
+
101
+ ## 请分析
102
+ 1. 根本原因是什么
103
+ 2. 修复方案(给出修改后的代码)
104
+ 3. 是否有类似问题需要排查
105
+ 4. 如何添加测试防止回归
106
+ ```
107
+
108
+ ## 5. 重构
109
+
110
+ ```
111
+ ## 任务
112
+ 重构以下代码,目标是 [重构目标]。
113
+
114
+ ## 当前代码
115
+ [粘贴待重构代码]
116
+
117
+ ## 问题
118
+ - [问题1:如方法过长]
119
+ - [问题2:如代码重复]
120
+ - [问题3:如职责不清]
121
+
122
+ ## 重构方向
123
+ - [如:提取方法、引入策略模式、消除重复等]
124
+
125
+ ## 约束
126
+ - 保持外部接口不变(方法签名、返回类型)
127
+ - 保持现有测试通过
128
+ - 遵循 Avatar Boot 架构规范
129
+ ```
130
+
131
+ ## 6. 测试生成
132
+
133
+ ```
134
+ ## 任务
135
+ 为 [类名.方法名] 生成单元测试。
136
+
137
+ ## 被测代码
138
+ [粘贴被测类代码]
139
+
140
+ ## 测试要求
141
+ - 使用 JUnit 5 + Mockito
142
+ - 覆盖以下场景:
143
+ 1. 正常流程
144
+ 2. [边界场景1]
145
+ 3. [边界场景2]
146
+ 4. [异常场景1]
147
+ 5. [异常场景2]
148
+ - Mock 外部依赖(Service、Mapper 等)
149
+ - 使用 @DisplayName 描述测试意图
150
+ - 遵循 Given-When-Then 结构
151
+ ```
152
+
153
+ ## 7. SQL 编写
154
+
155
+ ```
156
+ ## 任务
157
+ 编写 [查询描述] 的 SQL。
158
+
159
+ ## 表结构
160
+ [粘贴相关表的 CREATE TABLE 语句]
161
+
162
+ ## 查询需求
163
+ - 查询条件:[条件描述]
164
+ - 排序规则:[排序描述]
165
+ - 分页要求:[是否需要分页]
166
+ - 关联关系:[表之间的关联]
167
+
168
+ ## 输出格式
169
+ - MyBatis XML Mapper 格式
170
+ - 包含动态条件(<if> 标签)
171
+ - 添加 SQL 注释说明
172
+ ```
173
+
174
+ ## 8. 需求分析
175
+
176
+ ```
177
+ ## 任务
178
+ 基于以下产品需求,输出技术设计方案。
179
+
180
+ ## 产品需求
181
+ [粘贴 PRD 或需求描述]
182
+
183
+ ## 技术栈
184
+ Java 21, Spring Boot 3.5.3, Avatar Boot 框架, MyBatis-Plus, MySQL 8.0
185
+
186
+ ## 输出要求
187
+ 1. 需求拆解:拆分为可执行的技术任务
188
+ 2. 数据模型设计:表结构 + ER 图描述
189
+ 3. 接口设计:REST API 列表 + 请求响应格式
190
+ 4. 核心流程:关键业务流程的时序描述
191
+ 5. 技术方案:核心实现思路 + 技术选型
192
+ 6. 工作量评估:按任务粒度估算开发天数
193
+ ```
194
+
195
+ ---
196
+
197
+ ## 可复用上下文片段
198
+
199
+ 以下片段可直接嵌入任何 Prompt 中:
200
+
201
+ ### 技术栈上下文
202
+
203
+ ```
204
+ ## 技术栈
205
+ - 语言:Java 21
206
+ - 框架:Spring Boot 3.5.3 + Avatar Boot
207
+ - 持久层:MyBatis-Plus 3.5.x
208
+ - 数据库:MySQL 8.0
209
+ - 缓存:Redis 7.x
210
+ - 构建工具:Maven 3.9+
211
+ - API 风格:RESTful
212
+ - 文档:SpringDoc OpenAPI 3
213
+ ```
214
+
215
+ ### 架构约束上下文
216
+
217
+ ```
218
+ ## 架构约束
219
+ - 分层架构:Controller → Service(接口+实现) → Mapper
220
+ - 统一返回格式:Result<T>,包含 code、message、data
221
+ - 统一异常处理:GlobalExceptionHandler 捕获 BizException
222
+ - 参数校验:Jakarta Validation 注解(@NotNull, @Size 等)
223
+ - 分页查询:MyBatis-Plus Page<T>,Controller 接收 PageQuery 参数
224
+ - DTO/VO 分离:DTO 用于接收请求参数,VO 用于返回响应数据
225
+ - Entity 映射:使用 @TableName 注解,字段使用 @TableField
226
+ ```
227
+
228
+ ### 编码规范上下文
229
+
230
+ ```
231
+ ## 编码规范
232
+ - 类名:大驼峰(UserService, OrderController)
233
+ - 方法名:小驼峰(getUserById, createOrder)
234
+ - 常量:全大写下划线(MAX_RETRY_COUNT)
235
+ - 包结构:com.iflytek.avatar.[模块].[层次]
236
+ - 异常:业务异常使用 BizException,携带错误码
237
+ - 日志:使用 @Slf4j + log.info/warn/error
238
+ ```
239
+
240
+ ### 反面示例约束(防止常见错误)
241
+
242
+ ```
243
+ ## 请勿生成以下风格的代码:
244
+ - Controller 直接返回 Entity(应使用 VO)
245
+ - Controller 中写业务逻辑(应在 Service 层)
246
+ - 使用 RuntimeException(应使用 BizException)
247
+ - 在 Controller 中直接注入 Mapper
248
+ - 使用 ${} 拼接 SQL(应使用 #{})
249
+ ```
@@ -0,0 +1,244 @@
1
+ ---
2
+ name: requirement-management
3
+ description: |
4
+ 需求分析、评审与技术方案设计技能。当用户提到以下关键词时触发:
5
+ requirement, PRD, 需求分析, 技术方案, 需求拆解, 需求评审,
6
+ 技术设计, 方案设计, 技术评审, PRD review, 需求检查
7
+
8
+ 本技能覆盖两个阶段:
9
+ 1. 需求评审 — 对 PRD 进行多维度检查,输出 pass/warn/fail 结论
10
+ 2. 技术方案设计 — 从 PRD 到技术方案的完整拆解流程
11
+ globs:
12
+ - "docs/**/*.md"
13
+ - "docs/**/*.txt"
14
+ ---
15
+
16
+ # 需求管理技能(评审 + 技术方案)
17
+
18
+ ---
19
+
20
+ ## 第一阶段:需求评审
21
+
22
+ 对产品需求文档 (PRD) 进行系统化评审,覆盖六大维度,输出 pass / warn / fail 结论。
23
+
24
+ ### 评审维度与检查项
25
+
26
+ #### 1. 完整性 (Completeness)
27
+
28
+ | 检查项 | 说明 |
29
+ |--------|------|
30
+ | 业务场景覆盖 | 是否涵盖所有主流程与分支流程 |
31
+ | 异常流程 | 是否描述了异常 / 边界场景的处理方式 |
32
+ | 数据字典 | 关键字段是否给出类型、长度、枚举值 |
33
+ | 依赖说明 | 上下游系统、中间件、第三方服务是否列出 |
34
+ | 验收标准 | 是否提供可量化的验收条件 (AC) |
35
+
36
+ #### 2. 清晰度 (Clarity)
37
+
38
+ | 检查项 | 说明 |
39
+ |--------|------|
40
+ | 术语一致性 | 同一概念是否使用统一术语,无歧义 |
41
+ | 流程图 / 时序图 | 复杂交互是否配有图示 |
42
+ | 优先级标注 | 功能是否标注 P0 / P1 / P2 等优先级 |
43
+ | 角色定义 | 操作角色与权限是否明确 |
44
+
45
+ #### 3. 可测试性 (Testability)
46
+
47
+ | 检查项 | 说明 |
48
+ |--------|------|
49
+ | 输入输出定义 | 接口入参、出参是否明确 |
50
+ | 预期结果 | 每个场景是否有预期输出或状态变更 |
51
+ | 测试数据 | 是否提供或可推导出测试数据 |
52
+ | 边界值 | 是否标注数值范围、字符串长度等边界 |
53
+
54
+ #### 4. 安全性 (Security)
55
+
56
+ | 检查项 | 说明 |
57
+ |--------|------|
58
+ | 认证授权 | 是否说明鉴权方式 (JWT / OAuth2 等) |
59
+ | 敏感数据 | 个人信息、密码等是否标注脱敏 / 加密要求 |
60
+ | 输入校验 | 是否要求对用户输入进行校验与过滤 |
61
+ | 审计日志 | 关键操作是否需要记录审计日志 |
62
+
63
+ #### 5. 性能 (Performance)
64
+
65
+ | 检查项 | 说明 |
66
+ |--------|------|
67
+ | 并发量预估 | 是否给出 QPS / TPS 预期 |
68
+ | 响应时间 | 是否定义接口 RT 上限 (如 P99 < 200ms) |
69
+ | 数据量级 | 是否说明初始与增长数据量 |
70
+ | 降级方案 | 高负载时是否有降级 / 限流策略 |
71
+
72
+ #### 6. 兼容性 (Compatibility)
73
+
74
+ | 检查项 | 说明 |
75
+ |--------|------|
76
+ | 版本兼容 | 接口变更是否向后兼容 |
77
+ | 多端适配 | 是否说明支持的客户端类型与版本 |
78
+ | 数据迁移 | 数据库变更是否有迁移方案 |
79
+ | 灰度策略 | 是否支持按比例 / 按用户灰度发布 |
80
+
81
+ ### 评审输出格式
82
+
83
+ ```markdown
84
+ ## 需求评审报告
85
+
86
+ | 维度 | 结论 | 关键发现 |
87
+ |------|------|----------|
88
+ | 完整性 | pass / warn / fail | 具体说明 |
89
+ | 清晰度 | pass / warn / fail | 具体说明 |
90
+ | 可测试性 | pass / warn / fail | 具体说明 |
91
+ | 安全性 | pass / warn / fail | 具体说明 |
92
+ | 性能 | pass / warn / fail | 具体说明 |
93
+ | 兼容性 | pass / warn / fail | 具体说明 |
94
+
95
+ ### 综合结论: pass / warn / fail
96
+
97
+ ### 建议改进项
98
+ 1. ...
99
+ 2. ...
100
+ ```
101
+
102
+ ---
103
+
104
+ ## 第二阶段:技术方案设计
105
+
106
+ 评审通过后,从 PRD 拆解为完整的技术方案。
107
+
108
+ ### 拆解工作流
109
+
110
+ ```
111
+ 1. 需求理解
112
+ ├── 阅读 PRD,提取核心业务需求
113
+ ├── 识别用户角色和使用场景
114
+ ├── 明确功能边界(做什么、不做什么)
115
+ └── 标记不明确的需求点,准备确认清单
116
+
117
+ 2. 模块识别
118
+ ├── 拆分功能模块
119
+ ├── 确定模块间依赖关系
120
+ ├── 映射到现有系统架构
121
+ └── 识别需要新增的模块
122
+
123
+ 3. 技术设计
124
+ ├── API 接口设计
125
+ ├── 数据库表设计
126
+ ├── 核心业务流程设计
127
+ └── 技术选型(如有新技术引入)
128
+
129
+ 4. 风险评估
130
+ ├── 技术风险识别
131
+ ├── 资源风险评估
132
+ ├── 时间风险分析
133
+ └── 制定应对措施
134
+
135
+ 5. 任务分解
136
+ ├── 拆分开发任务
137
+ ├── 评估工时
138
+ ├── 确定优先级和依赖
139
+ └── 制定开发计划
140
+ ```
141
+
142
+ ### 模块识别 — 映射到 Avatar Boot 架构
143
+
144
+ ```
145
+ avatar-xxx-api (接口层)
146
+ ├── controller/
147
+ │ ├── XxxController.java
148
+ │ └── YyyController.java
149
+ └── dto/
150
+ ├── xxx/
151
+ └── yyy/
152
+
153
+ avatar-xxx-service (业务层)
154
+ ├── service/
155
+ │ ├── XxxService.java
156
+ │ └── YyyService.java
157
+ ├── mapper/
158
+ │ ├── XxxMapper.java
159
+ │ └── YyyMapper.java
160
+ └── entity/
161
+ ├── Xxx.java
162
+ └── Yyy.java
163
+ ```
164
+
165
+ ### 从需求提取 API 设计
166
+
167
+ 1. 识别 PRD 中的用户操作(动词 + 名词)
168
+ 2. 映射为 RESTful 接口
169
+ 3. 确定输入输出,使用 `Result<T>` 统一返回
170
+
171
+ ### 风险识别模板
172
+
173
+ | 分类 | 风险项 | 概率 | 影响 | 应对措施 |
174
+ |------|--------|------|------|----------|
175
+ | 技术 | 并发数据不一致 | 高 | 高 | Redis 分布式锁 + 乐观锁 |
176
+ | 技术 | 外部服务超时 | 中 | 中 | Feign 超时 + 熔断降级 |
177
+ | 资源 | 开发人员不足 | 中 | 中 | 按优先级分批交付 |
178
+ | 时间 | 需求变更频繁 | 高 | 中 | 冻结需求节点,变更走评审 |
179
+
180
+ ### 技术方案输出模板
181
+
182
+ ```markdown
183
+ # 技术方案 — [需求名称]
184
+
185
+ ## 1. 需求概述
186
+ [简要描述需求背景和目标]
187
+
188
+ ## 2. 功能模块拆分
189
+ | 模块 | 功能点 | 优先级 | 负责人 |
190
+ |------|--------|--------|--------|
191
+ | [模块名] | [功能描述] | P0/P1 | [人员] |
192
+
193
+ ## 3. 系统架构
194
+ [描述整体架构和模块关系]
195
+
196
+ ## 4. API 接口设计
197
+ | 接口 | 方法 | 描述 | 入参 | 出参 |
198
+ |------|------|------|------|------|
199
+ | /api/xxx | POST | [描述] | XxxCreateDTO | Result<Long> |
200
+
201
+ ## 5. 数据库设计
202
+ ### 新增表
203
+ [表结构 DDL]
204
+
205
+ ### 变更表
206
+ [ALTER 语句]
207
+
208
+ ## 6. 核心流程
209
+ [关键业务流程描述]
210
+
211
+ ## 7. 依赖分析
212
+ ### 内部依赖
213
+ [列出依赖的内部模块]
214
+
215
+ ### 外部依赖
216
+ [列出依赖的外部服务和中间件]
217
+
218
+ ## 8. 风险评估
219
+ | 风险 | 概率 | 影响 | 应对措施 |
220
+ |------|------|------|----------|
221
+ | [风险描述] | 高 | 高 | [措施] |
222
+
223
+ ## 9. 开发计划
224
+ | 阶段 | 任务 | 工时 | 起止时间 |
225
+ |------|------|------|----------|
226
+ | 开发 | [任务描述] | X 人天 | MM-DD ~ MM-DD |
227
+
228
+ ## 10. 待确认事项
229
+ - [ ] [需与产品确认的问题]
230
+ - [ ] [需与其他团队确认的问题]
231
+ ```
232
+
233
+ ---
234
+
235
+ ## 最佳实践
236
+
237
+ 1. **评审先行** — 先完成需求评审,通过后再进入技术方案设计
238
+ 2. **逐项对照** — 按维度逐条检查,避免遗漏
239
+ 3. **引用原文** — 评审结论附上需求文档原文片段,便于定位
240
+ 4. **先理解再拆解** — 充分理解业务需求后再进行技术设计
241
+ 5. **渐进式设计** — 先设计核心流程,再补充边界和异常情况
242
+ 6. **评审驱动** — 技术方案完成后组织评审,收集反馈
243
+ 7. **风险前置** — 高风险项优先处理
244
+ 8. **文档先行** — API 接口设计先于编码,便于前后端并行开发