@specpow/framework 0.5.22 → 0.5.23

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.
@@ -0,0 +1,162 @@
1
+ # 实施任务: <功能名称>
2
+
3
+ > 输入: 技术设计文档 (tech-design.md)
4
+ > 创建日期: <日期>
5
+ >
6
+ > 这些任务由 SDD 引擎逐个执行。
7
+ > 每个任务包含完整代码,可直接写入文件。
8
+
9
+ ---
10
+
11
+ ## 数据库任务
12
+
13
+ - [ ] **Task-001**: 创建数据库表 <table_name>
14
+ - **文件**: SQL 脚本 / dbx MCP
15
+ - **操作**:
16
+ ```sql
17
+ CREATE TABLE <table_name> (
18
+ ...
19
+ );
20
+ ```
21
+ - **验证**: 表创建成功,字段和约束正确
22
+ - **依赖**: 无
23
+
24
+ ---
25
+
26
+ ## 后端任务
27
+
28
+ - [ ] **Task-002**: 创建 Entity 实体类
29
+ - **文件**: `modules-center/{module}-center/{module}-service/src/main/java/com/twsz/mom/{module}/{sub}/model/{Entity}.java`
30
+ - **代码**:
31
+ ```java
32
+ <完整 Entity 代码>
33
+ ```
34
+ - **验证**: 编译通过
35
+ - **依赖**: Task-001
36
+
37
+ - [ ] **Task-003**: 创建 Mapper 接口
38
+ - **文件**: `.../{module}/mapper/{Entity}Mapper.java`
39
+ - **代码**:
40
+ ```java
41
+ <完整 Mapper 接口代码>
42
+ ```
43
+ - **验证**: 编译通过
44
+ - **依赖**: Task-002
45
+
46
+ - [ ] **Task-004**: 创建 Mapper XML
47
+ - **文件**: `resources/mapper/{module}/{Entity}Mapper.xml`
48
+ - **代码**:
49
+ ```xml
50
+ <完整 Mapper XML 代码>
51
+ ```
52
+ - **验证**: XML 格式正确,SQL 语法正确
53
+ - **依赖**: Task-003
54
+
55
+ - [ ] **Task-005**: 创建 Service 接口
56
+ - **文件**: `.../{module}/service/{Entity}Service.java`
57
+ - **代码**:
58
+ ```java
59
+ <完整 Service 接口代码>
60
+ ```
61
+ - **验证**: 编译通过
62
+ - **依赖**: Task-002
63
+
64
+ - [ ] **Task-006**: 创建 ServiceImpl 实现
65
+ - **文件**: `.../{module}/service/impl/{Entity}ServiceImpl.java`
66
+ - **代码**:
67
+ ```java
68
+ <完整 ServiceImpl 代码,含业务逻辑>
69
+ ```
70
+ - **验证**: 编译通过,单元测试通过
71
+ - **依赖**: Task-004, Task-005
72
+
73
+ - [ ] **Task-007**: 创建 Controller
74
+ - **文件**: `.../{module}/controller/{Entity}Controller.java`
75
+ - **代码**:
76
+ ```java
77
+ <完整 Controller 代码>
78
+ ```
79
+ - **验证**: 编译通过,接口可访问
80
+ - **依赖**: Task-006
81
+
82
+ ---
83
+
84
+ ## 前端任务
85
+
86
+ - [ ] **Task-008**: 创建 API 文件
87
+ - **文件**: `src/api/{domain}/{entity}.js`
88
+ - **代码**:
89
+ ```javascript
90
+ <完整 API 文件代码>
91
+ ```
92
+ - **验证**: 语法检查通过
93
+ - **依赖**: Task-007
94
+
95
+ - [ ] **Task-009**: 创建列表页
96
+ - **文件**: `src/views/{domain}/{entity}/index.vue`
97
+ - **代码**:
98
+ ```vue
99
+ <完整列表页代码>
100
+ ```
101
+ - **验证**: 页面可渲染,查询功能正常
102
+ - **依赖**: Task-008
103
+
104
+ - [ ] **Task-010**: 创建表单页
105
+ - **文件**: `src/views/{domain}/{entity}/{entity}-form.vue`
106
+ - **代码**:
107
+ ```vue
108
+ <完整表单页代码>
109
+ ```
110
+ - **验证**: 新增/编辑/查看功能正常
111
+ - **依赖**: Task-009
112
+
113
+ ---
114
+
115
+ ## 配置任务
116
+
117
+ - [ ] **Task-011**: 菜单注册
118
+ - **文件**: SQL 脚本
119
+ - **代码**:
120
+ ```sql
121
+ <c_sys_resource INSERT 语句>
122
+ ```
123
+ - **验证**: 菜单可见,权限生效
124
+ - **依赖**: Task-007
125
+
126
+ ---
127
+
128
+ ## 任务依赖图
129
+
130
+ ```
131
+ Task-001 (建表)
132
+
133
+
134
+ Task-002 (Entity)
135
+
136
+ ├──→ Task-003 (Mapper接口) ──→ Task-004 (Mapper XML)
137
+ │ │
138
+ ├──→ Task-005 (Service接口) │
139
+ │ │ │
140
+ │ ▼ ▼
141
+ │ Task-006 (ServiceImpl) ◄────────┘
142
+ │ │
143
+ │ ▼
144
+ │ Task-007 (Controller)
145
+ │ │
146
+ │ ├──→ Task-008 (API JS) ──→ Task-009 (列表页) ──→ Task-010 (表单页)
147
+ │ │
148
+ │ └──→ Task-011 (菜单注册)
149
+
150
+ ```
151
+
152
+ ---
153
+
154
+ ## 任务统计
155
+
156
+ | 类型 | 数量 |
157
+ |------|:----:|
158
+ | 数据库 | 1 |
159
+ | 后端 | 6 |
160
+ | 前端 | 3 |
161
+ | 配置 | 1 |
162
+ | **合计** | **11** |
@@ -0,0 +1,310 @@
1
+ # 技术设计: <功能名称>
2
+
3
+ > 输入: 解析报告 (parse.md) + 确认结果 (confirm-scope)
4
+ > 设计日期: <日期>
5
+ > 版本: v1.0
6
+
7
+ ---
8
+
9
+ ## 0. 确认结果
10
+
11
+ | 维度 | 确认值 |
12
+ |------|--------|
13
+ | 项目根目录 | <绝对路径> |
14
+ | 实施范围 | <模块列表> |
15
+ | 后端 center | modules-center/{module}-center |
16
+ | 后端包路径 | com.twsz.mom.{module}.{sub} |
17
+ | 前端 API 目录 | src/api/{domain}/ |
18
+ | 前端页面目录 | src/views/{domain}/{entity}/ |
19
+ | 编号生成 | @AutoGenCode / 无 |
20
+ | 状态流转 | 有(审核/弃审) / 无 |
21
+ | 已有代码影响 | <列表或无> |
22
+
23
+ ---
24
+
25
+ ## 1. 数据库设计
26
+
27
+ ### 1.1 新建表
28
+
29
+ #### 表: <table_name>
30
+
31
+ ```sql
32
+ CREATE TABLE <table_name> (
33
+ id NUMBER(19) NOT NULL,
34
+ -- 业务字段
35
+ <column_name> <oracle_type> <constraint>,
36
+ -- 审计字段
37
+ created_by VARCHAR2(64),
38
+ created_date DATE DEFAULT SYSDATE,
39
+ last_updated_by VARCHAR2(64),
40
+ last_updated_date DATE DEFAULT SYSDATE,
41
+ CONSTRAINT pk_<table_name> PRIMARY KEY (id)
42
+ );
43
+
44
+ COMMENT ON TABLE <table_name> IS '<表中文名>';
45
+ COMMENT ON COLUMN <table_name>.id IS '主键';
46
+ -- 其他字段注释
47
+ ```
48
+
49
+ **索引**:
50
+
51
+ | 索引名 | 字段 | 类型 | 说明 |
52
+ |--------|------|------|------|
53
+ | | | UNIQUE / NORMAL | |
54
+
55
+ **建表方式**:
56
+ - [ ] dbx MCP 工具(优先)
57
+ - [ ] SQL 脚本执行
58
+
59
+ ### 1.2 修改表(如有)
60
+
61
+ #### 表: <existing_table_name>
62
+
63
+ ```sql
64
+ ALTER TABLE <existing_table_name> ADD (
65
+ <new_column> <oracle_type> <constraint>
66
+ );
67
+
68
+ COMMENT ON COLUMN <existing_table_name>.<new_column> IS '<说明>';
69
+ ```
70
+
71
+ ---
72
+
73
+ ## 2. API 接口设计
74
+
75
+ ### 2.1 标准 CRUD 接口
76
+
77
+ > 完整路径前缀: `/api/<api-path>/<entity>`
78
+
79
+ | # | Method | Path | 描述 | 请求体 | 响应体 |
80
+ |:-:|--------|------|------|--------|--------|
81
+ | 1 | POST | `/{entity}/search` | 分页查询 | PageForm<Entity> | Page<Entity> |
82
+ | 2 | POST | `/{entity}/add` | 新增 | Entity | — |
83
+ | 3 | PUT | `/{entity}/update` | 修改 | Entity | — |
84
+ | 4 | DELETE | `/{entity}/delete` | 批量删除 | Long[] ids | — |
85
+ | 5 | POST | `/{entity}/export` | 导出 Excel | Entity | file |
86
+ | 6 | POST | `/{entity}/uploadExcel` | 导入 Excel | MultipartFile | — |
87
+
88
+ ### 2.2 外部接口(如有)
89
+
90
+ | # | Method | Path | 调用方 | 描述 |
91
+ |:-:|--------|------|--------|------|
92
+ | E-1 | | | | |
93
+
94
+ ### 2.3 接口详情
95
+
96
+ #### API-1: 分页查询
97
+
98
+ - **路径**: `POST /api/<api-path>/<entity>/search`
99
+ - **请求体**:
100
+ ```json
101
+ {
102
+ "size": 20,
103
+ "current": 1,
104
+ "condition": {}
105
+ }
106
+ ```
107
+ - **响应体**:
108
+ ```json
109
+ {
110
+ "code": 200,
111
+ "message": "success",
112
+ "data": {
113
+ "records": [],
114
+ "total": 0,
115
+ "size": 20,
116
+ "current": 1
117
+ }
118
+ }
119
+ ```
120
+
121
+ <!-- 按需补充其他接口详情 -->
122
+
123
+ ---
124
+
125
+ ## 3. 后端代码结构
126
+
127
+ ### 3.1 Entity
128
+
129
+ **路径**: `modules-center/{module}-center/{module}-service/src/main/java/com/twsz/mom/{module}/{sub}/model/{Entity}.java`
130
+
131
+ ```java
132
+ @Data
133
+ @EqualsAndHashCode(callSuper = false)
134
+ @JsonInclude(JsonInclude.Include.NON_NULL)
135
+ @TableName("<table_name>")
136
+ public class {Entity} extends BaseModel implements Serializable {
137
+
138
+ private static final long serialVersionUID = 1L;
139
+
140
+ @TableId(type = IdType.ASSIGN_ID)
141
+ @JsonSerialize(using = ToStringSerializer.class)
142
+ private Long id;
143
+
144
+ // === 业务字段 ===
145
+ // <从功能文档字段表映射,每个字段含 @ExcelProperty>
146
+ }
147
+ ```
148
+
149
+ ### 3.2 Mapper
150
+
151
+ **接口**: `.../{module}/mapper/{Entity}Mapper.java`
152
+ **XML**: `resources/mapper/{module}/{Entity}Mapper.xml`
153
+
154
+ ```java
155
+ @Mapper
156
+ public interface {Entity}Mapper extends BaseMapper<{Entity}> {
157
+ IPage<{Entity}> pageSearch(Page<{Entity}> p, @Param("entity") {Entity} entity);
158
+ List<{Entity}> list(@Param("entity") {Entity} entity);
159
+ }
160
+ ```
161
+
162
+ **XML 关键片段**:
163
+ ```xml
164
+ <sql id="Columns">
165
+ id, <业务字段>, created_by, created_date, last_updated_by, last_updated_date
166
+ </sql>
167
+
168
+ <sql id="Where">
169
+ <where>
170
+ <if test="entity.xxx != null and entity.xxx != ''">
171
+ AND xxx = #{entity.xxx}
172
+ </if>
173
+ </where>
174
+ </sql>
175
+ ```
176
+
177
+ ### 3.3 Service
178
+
179
+ **接口**: `.../{module}/service/{Entity}Service.java`
180
+
181
+ ```java
182
+ public interface {Entity}Service extends IService<{Entity}> {
183
+ // <方法签名>
184
+ }
185
+ ```
186
+
187
+ **关键业务逻辑**:
188
+
189
+ ```
190
+ insert({Entity} entity):
191
+ 1. <校验规则描述>
192
+ 2. <校验通过> → baseMapper.insert(entity)
193
+
194
+ uploadExcel(List<{Entity}> list):
195
+ @Transactional(rollbackFor = Exception.class)
196
+ 1. <导入校验描述>
197
+ 2. 逐行 insert
198
+ ```
199
+
200
+ ### 3.4 Controller
201
+
202
+ **路径**: `.../{module}/controller/{Entity}Controller.java`
203
+
204
+ ```java
205
+ @RestController
206
+ @RequestMapping("/api/<api-path>/<entity>")
207
+ public class {Entity}Controller {
208
+
209
+ @PostMapping("/search")
210
+ public ResponseWrapper<Page<{Entity}>> search(@RequestBody PageForm<{Entity}> pageForm) { ... }
211
+
212
+ // <其他方法>
213
+ }
214
+ ```
215
+
216
+ ---
217
+
218
+ ## 4. 前端代码结构
219
+
220
+ ### 4.1 API 文件
221
+
222
+ **路径**: `src/api/{domain}/{entity}.js`
223
+
224
+ ```javascript
225
+ import axios from '@/libs/request'
226
+ import { exportExcel } from '../file'
227
+ const root = '/<gateway-prefix>/api'
228
+
229
+ // <API 方法列表>
230
+ ```
231
+
232
+ ### 4.2 列表页
233
+
234
+ **路径**: `src/views/{domain}/{entity}/index.vue`
235
+
236
+ - **Mixin**: `indexPage`
237
+ - **搜索条件**:
238
+
239
+ | 字段 | 控件 | 说明 |
240
+ |------|------|------|
241
+ | | Input / Select / DatePicker | |
242
+
243
+ - **表格列**:
244
+
245
+ | 列名 | key | slot | 说明 |
246
+ |------|-----|------|------|
247
+ | ☐ | selection | — | 复选框 |
248
+ | | | | |
249
+ | 操作 | — | operate | 编辑/查看/删除 |
250
+
251
+ - **工具栏**: 新增 ✅ | 编辑 ✅ | 查看 ✅ | 删除 ✅ | 导出 ✅ | 导入 ✅
252
+
253
+ ### 4.3 表单页
254
+
255
+ **路径**: `src/views/{domain}/{entity}/{entity}-form.vue`
256
+
257
+ - **组件**: `master-sub`
258
+ - **表单字段**:
259
+
260
+ | 字段 | 控件 | 必填 | 校验规则 | 说明 |
261
+ |------|------|:----:|----------|------|
262
+ | | Input / Select / iSwitch / DatePicker | | | |
263
+
264
+ - **提交逻辑**: 判断新增/编辑 → 调用 add/update API
265
+
266
+ ---
267
+
268
+ ## 5. 业务逻辑流程
269
+
270
+ ### 5.1 核心操作流程
271
+
272
+ ```
273
+ <ASCII 流程图>
274
+ ```
275
+
276
+ ### 5.2 校验规则汇总
277
+
278
+ | 编号 | 校验项 | 规则 | 错误提示 | 校验位置 |
279
+ |:----:|--------|------|----------|----------|
280
+ | V-01 | | | | 前端 + 后端 |
281
+
282
+ ### 5.3 状态流转(如有)
283
+
284
+ ```
285
+ <状态机图>
286
+ ```
287
+
288
+ ---
289
+
290
+ ## 6. 集成点
291
+
292
+ ### 6.1 被调用方
293
+
294
+ | 调用方 | 接口方式 | 说明 |
295
+ |--------|----------|------|
296
+ | | | |
297
+
298
+ ### 6.2 菜单权限
299
+
300
+ | 菜单名 | 权限标识 | 类型 |
301
+ |--------|----------|------|
302
+ | | | 路由 / 按钮 / API |
303
+
304
+ ---
305
+
306
+ ## 7. 设计决策记录
307
+
308
+ | 决策 | 选项 | 结论 | 原因 |
309
+ |------|------|------|------|
310
+ | | | | |
@@ -0,0 +1,161 @@
1
+ # PRD to Tech Doc Schema
2
+ # 将需求文档(PRD)转换为技术文档
3
+ # 工件流: analysis → tech-design → tech-tasks
4
+
5
+ name: prd-to-tech-doc
6
+ description: |
7
+ 需求文档转技术文档工作流。
8
+ 输入一份业务需求文档(PRD),输出结构化的技术设计文档和实施任务清单。
9
+ 适用于:已有功能需求文档,需要转化为开发团队可执行的技术方案。
10
+
11
+ 与 mes-crud-module 的区别:
12
+ - mes-crud-module:从零生成 CRUD 模块代码(模板化)
13
+ - prd-to-tech-doc:从需求文档出发,分析现有代码,产出技术方案(定制化)
14
+
15
+ apply:
16
+ requires:
17
+ - tech-tasks # 实施前必须完成所有工件
18
+
19
+ artifacts:
20
+ - id: analysis
21
+ name: 需求分析
22
+ description: 解析 PRD,识别功能点、影响范围和技术约束
23
+ requires: []
24
+ template: analysis.md
25
+ instruction: |
26
+ 读取用户提供的需求文档(PRD),完成以下分析:
27
+
28
+ 1. 功能点提取
29
+ - 从 PRD 中提取所有功能点,编号列出
30
+ - 区分:CRUD 操作 / 业务规则 / 导入导出 / 状态流转 等类型
31
+ - 标注每个功能点的优先级(P0=必须 / P1=重要 / P2=可选)
32
+
33
+ 2. 数据模型分析
34
+ - 根据 PRD 中的字段说明,推断数据库表结构
35
+ - 识别:实体名、表名、字段列表、字段类型、约束
36
+ - 识别外键关系(如有关联表)
37
+ - 标注审计字段(created_by, created_date, last_updated_by, last_updated_date)
38
+
39
+ 3. 现有代码扫描
40
+ - 搜索项目中是否已有相关代码(实体、表、接口、页面)
41
+ - 如果已有:标注哪些可以直接复用,哪些需要修改
42
+ - 如果没有:标注需要新建
43
+ - 使用 codegraph_explore 查找相关符号
44
+
45
+ 4. 技术约束识别
46
+ - 项目技术栈约束(Spring Boot 2.7 / MyBatis-Plus / Oracle / Vue2 / ViewUI)
47
+ - 编码规范约束(BaseModel 继承、ResponseWrapper 响应、LambdaQueryWrapper 等)
48
+ - 与现有模块的集成点(如本功能被哪些模块消费)
49
+
50
+ 5. 影响范围
51
+ - 受影响的后端模块(modules-center 下的哪个 center)
52
+ - 受影响的前端目录(views/ 和 api/ 下的路径)
53
+ - 受影响的数据库 schema
54
+
55
+ 输出格式:结构化的分析报告,包含以上 5 个部分。
56
+ output: analysis.md
57
+
58
+ - id: tech-design
59
+ name: 技术设计
60
+ description: 数据库设计 + API 设计 + 代码结构设计 + 业务逻辑流程
61
+ requires: [analysis]
62
+ template: tech-design.md
63
+ instruction: |
64
+ 基于需求分析报告,生成完整的技术设计文档。
65
+
66
+ 1. 数据库设计
67
+ - 表结构 DDL(Oracle 语法)
68
+ - 字段类型映射规则:
69
+ - 文本 → VARCHAR2(n)
70
+ - 数字(整数)→ NUMBER(19) 或 NUMBER(10)
71
+ - 数字(小数)→ NUMBER(19,4)
72
+ - 日期 → DATE 或 TIMESTAMP
73
+ - 开关 → NUMBER(1) DEFAULT 1
74
+ - 主键: id NUMBER(19) 雪花算法(ASSIGN_ID)
75
+ - 审计字段: created_by, created_date, last_updated_by, last_updated_date
76
+ - 索引建议
77
+ - 如使用 dbx MCP 工具,优先通过 dbx 建表
78
+
79
+ 2. API 接口设计
80
+ - 接口清单表(Method / Path / 描述 / 请求体 / 响应体)
81
+ - MES 项目标准接口模式:
82
+ - POST /{entity}/search — 分页查询(PageForm<Entity>)
83
+ - POST /{entity}/add — 新增(或 POST /{entity}/save 统一保存)
84
+ - PUT /{entity}/update — 修改
85
+ - DELETE /{entity}/delete — 批量删除
86
+ - POST /{entity}/export — Excel 导出
87
+ - POST /{entity}/uploadExcel — Excel 导入(如有)
88
+ - 响应统一使用 ResponseWrapper<T>
89
+ - 每个接口给出请求示例和响应示例(JSON)
90
+
91
+ 3. 后端代码结构
92
+ - Entity 类设计(继承 BaseModel,字段注解)
93
+ - Mapper 接口 + XML 设计(resultMap/resultType、查询条件)
94
+ - Service 接口设计(方法签名、返回值)
95
+ - ServiceImpl 关键逻辑(校验、唯一性、事务)
96
+ - Controller 设计(路径、方法、参数校验)
97
+ - 给出每个类的关键代码模板
98
+
99
+ 4. 前端代码结构
100
+ - API 文件(src/api/{domain}/{entity}.js)
101
+ - 列表页(index.vue — search-table + indexPage mixin)
102
+ - 表单页({entity}-form.vue — master-sub + Form)
103
+ - 给出关键配置(表格列定义、表单字段、校验规则)
104
+
105
+ 5. 业务逻辑流程
106
+ - 用流程图(ASCII)描述核心业务流程
107
+ - 标注校验点和异常处理
108
+ - 如有状态流转,画出状态机
109
+
110
+ 6. 集成点
111
+ - 本模块被哪些其他模块调用
112
+ - 需要暴露哪些 Feign 接口
113
+ - 需要注册哪些菜单权限
114
+
115
+ 注意:
116
+ - 代码模板必须匹配 MES 项目的真实编码规范
117
+ - 实体继承 BaseModel,使用 @Data + @TableName
118
+ - Mapper XML 位于 resources/mapper/{module}/ 目录
119
+ - 前端组件使用 View Design 4 组件库
120
+ output: tech-design.md
121
+
122
+ - id: tech-tasks
123
+ name: 实施任务
124
+ description: 可执行的技术实施任务清单(SDD 引擎可逐个执行)
125
+ requires: [analysis, tech-design]
126
+ template: tech-tasks.md
127
+ instruction: |
128
+ 基于技术设计文档,拆分为可执行的实施任务列表。
129
+
130
+ 任务拆分原则:
131
+ 1. 每个任务足够小(2-5 分钟完成)
132
+ 2. 包含精确的文件路径
133
+ 3. 包含完整的代码或明确的修改指令
134
+ 4. 包含验证步骤
135
+ 5. 任务之间尽量独立(便于 SDD 并行)
136
+
137
+ 任务顺序约定:
138
+ 1. 数据库建表(DDL)
139
+ 2. 后端 Entity
140
+ 3. 后端 Mapper + XML
141
+ 4. 后端 Service 接口
142
+ 5. 后端 ServiceImpl
143
+ 6. 后端 Controller
144
+ 7. 前端 API 文件
145
+ 8. 前端列表页
146
+ 9. 前端表单页
147
+ 10. 菜单注册 SQL
148
+
149
+ 每个任务格式:
150
+ - [ ] Task N: <标题>
151
+ 文件: <精确路径>
152
+ 描述: <具体实现指令,包含代码模板>
153
+ 验证: <如何验证>
154
+ 依赖: Task-X(如有)
155
+
156
+ 注意:
157
+ - 如果需求文档中有导入功能,增加 uploadExcel 相关任务
158
+ - 如果需求文档中有导出功能,增加 export 相关任务
159
+ - 如果有状态流转,增加状态操作接口任务
160
+ - 使用 dbx MCP 建表时,在建表任务中标注
161
+ output: tech-tasks.md