@zeyue0329/xiaoma-cli 1.0.43 → 1.0.45

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,949 @@
1
+ template:
2
+ id: rag-questions-template-v2
3
+ name: 知识库问题生成模板
4
+ version: 2.0
5
+ description: 基于需求文档(req.txt)生成知识库MCP查询问题,包含详细的技术架构、编码规范、中间件、业务流程等维度
6
+ output:
7
+ format: markdown
8
+ filename: docs/rag-questions.md
9
+ title: "知识库查询问题清单"
10
+
11
+ workflow:
12
+ mode: interactive
13
+ phases:
14
+ - 需求解析
15
+ - 问题生成
16
+ - 问题确认
17
+ - 知识库查询
18
+ - 知识落地
19
+
20
+ sections:
21
+ - id: requirement-parsing
22
+ title: 第一阶段:需求文档深度解析
23
+ instruction: |
24
+ 读取并深度分析 req.txt 文档,提取以下要素:
25
+
26
+ 1. **业务领域识别**
27
+ - 这个需求属于什么业务领域?(如:订单管理、用户管理、支付系统等)
28
+ - 涉及哪些子领域或模块?
29
+
30
+ 2. **功能点提取**
31
+ - 需求描述了哪些具体功能?
32
+ - 每个功能的输入、处理、输出是什么?
33
+
34
+ 3. **用户角色识别**
35
+ - 涉及哪些用户角色?(如:管理员、普通用户、访客)
36
+ - 每个角色在此需求中的操作是什么?
37
+
38
+ 4. **数据实体识别**
39
+ - 涉及哪些数据对象?(如:订单、商品、用户)
40
+ - 数据之间的关系是什么?(一对一、一对多、多对多)
41
+
42
+ 5. **业务流程识别**
43
+ - 描述了什么业务流程?
44
+ - 流程的起点、终点、关键步骤是什么?
45
+ - 每个步骤之间的触发条件和数据传递是什么?
46
+
47
+ 6. **技术关键词识别**
48
+ - 需求中提及了哪些技术组件?(如:消息队列、缓存、定时任务)
49
+ - 涉及哪些外部系统集成?
50
+
51
+ 7. **模糊点标记**
52
+ - 哪些描述不够清晰?
53
+ - 哪些内容有多种理解方式?
54
+ output:
55
+ format: yaml
56
+ template: |
57
+ 需求解析结果:
58
+ 业务领域: {{domain}}
59
+ 子领域: [{{sub_domains}}]
60
+
61
+ 功能点:
62
+ {{#each features}}
63
+ - 名称: {{name}}
64
+ 描述: {{description}}
65
+ 输入: {{input}}
66
+ 输出: {{output}}
67
+ 涉及实体: [{{entities}}]
68
+ {{/each}}
69
+
70
+ 用户角色:
71
+ {{#each roles}}
72
+ - 角色: {{name}}
73
+ 操作: [{{actions}}]
74
+ 权限级别: {{permission_level}}
75
+ {{/each}}
76
+
77
+ 数据实体:
78
+ {{#each entities}}
79
+ - 实体: {{name}}
80
+ 属性: [{{attributes}}]
81
+ 关系:
82
+ {{#each relationships}}
83
+ - 目标实体: {{target}}
84
+ 关系类型: {{type}} # 一对一/一对多/多对一/多对多
85
+ 关联字段: {{field}}
86
+ {{/each}}
87
+ {{/each}}
88
+
89
+ 业务流程:
90
+ {{#each processes}}
91
+ - 流程名称: {{name}}
92
+ 触发条件: {{trigger}}
93
+ 步骤:
94
+ {{#each steps}}
95
+ - 序号: {{index}}
96
+ 名称: {{name}}
97
+ 执行者: {{actor}}
98
+ 前置步骤: {{previous_step}}
99
+ 触发条件: {{trigger_from_previous}}
100
+ 输入数据: {{input_data}}
101
+ 输出数据: {{output_data}}
102
+ 数据变更: {{data_changes}}
103
+ {{/each}}
104
+ 异常分支: [{{exception_branches}}]
105
+ {{/each}}
106
+
107
+ 技术组件:
108
+ {{#each tech_components}}
109
+ - 组件: {{name}}
110
+ 用途: {{purpose}}
111
+ {{/each}}
112
+
113
+ 模糊点:
114
+ {{#each ambiguities}}
115
+ - 位置: {{location}}
116
+ 内容: {{content}}
117
+ 可能理解: [{{interpretations}}]
118
+ {{/each}}
119
+
120
+ - id: question-generation
121
+ title: 第二阶段:问题生成
122
+ instruction: |
123
+ 基于解析结果,为每个要素生成具体的知识库查询问题。
124
+
125
+ **问题生成原则**:
126
+ 1. 每个问题必须具体、可回答
127
+ 2. 优先生成阻塞性问题(缺失会导致无法继续)
128
+ 3. 问题应覆盖:业务、技术、历史、约束 四个维度
129
+ 4. 避免开放性过强的问题
130
+ 5. 技术问题需要求提供代码示例
131
+ 6. 业务流程问题需要追问每个节点的详细信息
132
+ sections:
133
+
134
+ # ==================== A. 业务知识问题(增强版)====================
135
+ - id: business-questions
136
+ title: A. 业务知识问题
137
+ instruction: |
138
+ 针对业务领域和流程生成问题,重点关注:
139
+ - 业务规则和约束的完整定义
140
+ - 业务流程的每个步骤详情
141
+ - 步骤间的关联关系和数据流转
142
+ - 数据实体间的关联关系
143
+ - 边界情况和异常处理
144
+ - 用户权限和角色
145
+ question_templates:
146
+
147
+ - category: A1-业务规则详解
148
+ priority: P0
149
+ description: 深入了解业务规则的完整定义
150
+ templates:
151
+ - question: "[{entity}]实体有哪些业务规则?请详细说明:"
152
+ sub_questions:
153
+ - "状态有哪些?状态流转规则是什么?哪些状态可以互相转换?"
154
+ - "必填字段有哪些?每个必填字段的校验规则是什么?"
155
+ - "字段的取值范围和格式要求是什么?"
156
+ - "是否有唯一性约束?唯一性的范围是什么(全局/租户/用户)?"
157
+ - "是否有软删除?软删除的业务规则是什么?"
158
+ - "创建/修改/删除操作的前置条件是什么?"
159
+
160
+ - question: "[{entity}]和[{related_entity}]之间的业务关联规则是什么?"
161
+ sub_questions:
162
+ - "关联关系的业务含义是什么?"
163
+ - "关联是否必须存在?可以为空吗?"
164
+ - "删除主实体时,关联实体如何处理?(级联删除/置空/禁止删除)"
165
+ - "关联实体的生命周期如何与主实体绑定?"
166
+
167
+ - question: "[{role}]角色在[{operation}]操作上的权限规则是什么?"
168
+ sub_questions:
169
+ - "该角色可以操作哪些数据范围?(全部/本部门/本人)"
170
+ - "操作需要哪些前置审批或确认?"
171
+ - "操作是否有时间窗口限制?"
172
+ - "操作失败时的提示信息应该是什么?"
173
+
174
+ - category: A2-业务流程详解
175
+ priority: P0
176
+ description: 深入了解业务流程的每个步骤和节点间关系
177
+ templates:
178
+ - question: "[{process}]业务流程的完整定义是什么?"
179
+ sub_questions:
180
+ - "流程的触发条件是什么?由谁/什么事件触发?"
181
+ - "流程的正常结束条件是什么?"
182
+ - "流程的异常结束条件有哪些?"
183
+ - "流程是否支持取消/撤销?取消后如何回滚?"
184
+ - "流程的超时处理机制是什么?"
185
+
186
+ - question: "[{process}]流程中,步骤[{step_a}]到步骤[{step_b}]的详细信息?"
187
+ sub_questions:
188
+ - "从[{step_a}]到[{step_b}]的触发条件是什么?"
189
+ - "[{step_a}]完成后,需要传递哪些数据给[{step_b}]?"
190
+ - "数据传递的格式和校验规则是什么?"
191
+ - "[{step_a}]失败时,是否阻塞[{step_b}]?还是走其他分支?"
192
+ - "这两个步骤之间是否有时间约束?(如必须在N分钟内完成)"
193
+
194
+ - question: "[{process}]流程的第[{n}]个步骤[{step_name}]的详细执行逻辑是什么?"
195
+ sub_questions:
196
+ - "该步骤的执行者是谁?(系统自动/人工操作/外部系统)"
197
+ - "该步骤的输入数据有哪些?数据来源是什么?"
198
+ - "该步骤的处理逻辑是什么?涉及哪些业务规则?"
199
+ - "该步骤会产生/修改哪些数据?"
200
+ - "该步骤完成的标志是什么?如何判定成功/失败?"
201
+ - "该步骤失败后的重试机制是什么?"
202
+ - "该步骤是否需要记录日志/审计?记录哪些信息?"
203
+
204
+ - question: "[{process}]流程中有哪些并行/分支节点?"
205
+ sub_questions:
206
+ - "哪些步骤可以并行执行?并行执行的条件是什么?"
207
+ - "并行步骤的汇合点在哪里?汇合的条件是什么(全部完成/任一完成)?"
208
+ - "有哪些条件分支?每个分支的触发条件是什么?"
209
+ - "分支是否会重新汇合?汇合点在哪里?"
210
+
211
+ - question: "[{process}]流程的异常处理机制是什么?"
212
+ sub_questions:
213
+ - "每个步骤可能出现的异常有哪些?"
214
+ - "异常发生后的处理策略是什么?(重试/跳过/终止/人工处理)"
215
+ - "异常是否需要通知?通知谁?通知方式是什么?"
216
+ - "流程中断后如何恢复?是否支持断点续传?"
217
+
218
+ - category: A3-数据关联关系详解
219
+ priority: P0
220
+ description: 深入了解数据实体间的关联关系
221
+ templates:
222
+ - question: "[{entity_a}]和[{entity_b}]的数据关联关系详情?"
223
+ sub_questions:
224
+ - "关联类型是什么?(一对一/一对多/多对一/多对多)"
225
+ - "关联是通过什么字段建立的?外键在哪一方?"
226
+ - "关联是否必须?能否存在孤立记录?"
227
+ - "关联的建立时机是什么?创建时/后续关联?"
228
+ - "关联可以修改吗?修改的业务场景是什么?"
229
+ - "解除关联的条件是什么?解除后数据如何处理?"
230
+
231
+ - question: "[{entity}]的一对多关联详情?"
232
+ sub_questions:
233
+ - "一个[{entity}]最多可以关联多少个[{related_entity}]?"
234
+ - "是否有最小关联数量要求?"
235
+ - "关联顺序是否重要?如何维护顺序?"
236
+ - "批量添加/删除关联的业务规则是什么?"
237
+
238
+ - question: "[{entity}]涉及的多对多关联详情?"
239
+ sub_questions:
240
+ - "多对多关联是否有中间表?中间表存储哪些额外信息?"
241
+ - "关联的创建和删除权限由谁控制?"
242
+ - "关联是否有时效性?过期如何处理?"
243
+
244
+ - category: A4-边界情况与异常处理
245
+ priority: P1
246
+ description: 深入了解边界情况的处理逻辑
247
+ templates:
248
+ - question: "[{operation}]操作的边界情况有哪些?"
249
+ sub_questions:
250
+ - "并发执行时如何处理?是否需要加锁?锁的粒度是什么?"
251
+ - "数据不存在时如何处理?"
252
+ - "数据已被其他操作锁定时如何处理?"
253
+ - "操作超时时如何处理?"
254
+ - "部分成功时如何处理?是否支持事务回滚?"
255
+
256
+ - question: "[{entity}]数据量很大时的处理规则?"
257
+ sub_questions:
258
+ - "列表查询的分页规则是什么?默认每页多少条?最大每页多少条?"
259
+ - "是否支持批量操作?批量操作的最大数量是多少?"
260
+ - "大数据量导出的限制是什么?是否需要异步处理?"
261
+ - "历史数据的归档策略是什么?"
262
+
263
+ # ==================== B. 技术知识问题(增强版)====================
264
+ - id: technical-questions
265
+ title: B. 技术知识问题
266
+ instruction: |
267
+ 针对技术实现生成问题,重点关注:
268
+ - 整体项目技术架构
269
+ - 中间件使用规范和代码示例
270
+ - Java编码规范
271
+ - SQL规范
272
+ - 数据模型设计
273
+ - 接口规范
274
+ - 代码实现模式
275
+ question_templates:
276
+
277
+ - category: B1-整体项目技术架构
278
+ priority: P0
279
+ description: 了解项目的整体技术架构和技术栈
280
+ templates:
281
+ - question: "项目的整体技术架构是什么?"
282
+ sub_questions:
283
+ - "项目采用什么架构模式?(单体/微服务/SOA/DDD)"
284
+ - "系统分为哪些层次?每层的职责是什么?"
285
+ - "各层之间如何交互?调用方式是什么?"
286
+ - "请提供架构图或架构说明文档"
287
+
288
+ - question: "项目的技术栈详情是什么?"
289
+ sub_questions:
290
+ - "后端框架:使用什么框架?版本是多少?(如Spring Boot版本)"
291
+ - "数据库:使用什么数据库?版本是多少?是否有读写分离?"
292
+ - "缓存:使用什么缓存?(Redis/Memcached等)版本是多少?"
293
+ - "消息队列:使用什么MQ?(RabbitMQ/Kafka/RocketMQ等)版本是多少?"
294
+ - "搜索引擎:是否使用?使用什么?(Elasticsearch等)"
295
+ - "文件存储:使用什么存储?(本地/OSS/MinIO等)"
296
+ - "日志系统:使用什么日志框架和日志收集系统?"
297
+ - "监控系统:使用什么监控?(Prometheus/Grafana等)"
298
+
299
+ - question: "项目的模块划分是什么?"
300
+ sub_questions:
301
+ - "项目包含哪些Maven/Gradle模块?各模块的职责是什么?"
302
+ - "模块之间的依赖关系是什么?"
303
+ - "公共模块有哪些?提供什么能力?"
304
+ - "请提供模块结构图或模块说明"
305
+
306
+ - question: "项目的包结构规范是什么?"
307
+ sub_questions:
308
+ - "Controller层的包路径和命名规范?"
309
+ - "Service层的包路径和命名规范?"
310
+ - "DAO/Repository层的包路径和命名规范?"
311
+ - "Entity/Model层的包路径和命名规范?"
312
+ - "DTO/VO层的包路径和命名规范?"
313
+ - "工具类的包路径和命名规范?"
314
+ - "配置类的包路径和命名规范?"
315
+ - "请提供包结构示例"
316
+
317
+ - category: B2-中间件使用规范
318
+ priority: P0
319
+ description: 了解各中间件的使用规范和代码示例
320
+ templates:
321
+ - question: "项目中Redis的使用规范是什么?"
322
+ sub_questions:
323
+ - "Redis的连接配置在哪里?如何获取RedisTemplate?"
324
+ - "Key的命名规范是什么?前缀规则是什么?"
325
+ - "不同业务场景使用哪种数据结构?(String/Hash/List/Set/ZSet)"
326
+ - "缓存的过期时间策略是什么?"
327
+ - "如何处理缓存穿透、缓存击穿、缓存雪崩?"
328
+ - "分布式锁如何实现?使用什么工具?(Redisson等)"
329
+ - "请提供Redis操作的代码示例,包括:"
330
+ - " - 字符串缓存的存取示例"
331
+ - " - Hash结构的存取示例"
332
+ - " - 分布式锁的使用示例"
333
+ - " - 缓存注解(@Cacheable等)的使用示例"
334
+
335
+ - question: "项目中消息队列的使用规范是什么?"
336
+ sub_questions:
337
+ - "使用什么消息队列?配置在哪里?"
338
+ - "Exchange/Topic的命名规范是什么?"
339
+ - "Queue的命名规范是什么?"
340
+ - "消息体的格式规范是什么?(JSON结构定义)"
341
+ - "消息的可靠性如何保证?(确认机制、持久化、重试)"
342
+ - "消费者的幂等性如何保证?"
343
+ - "死信队列如何处理?"
344
+ - "请提供消息队列的代码示例,包括:"
345
+ - " - 生产者发送消息的示例"
346
+ - " - 消费者接收消息的示例"
347
+ - " - 延迟消息的发送示例"
348
+ - " - 消息确认和重试的示例"
349
+
350
+ - question: "项目中定时任务的使用规范是什么?"
351
+ sub_questions:
352
+ - "使用什么定时任务框架?(Spring @Scheduled/XXL-Job/Quartz等)"
353
+ - "定时任务的配置在哪里?"
354
+ - "分布式环境下如何保证任务只执行一次?"
355
+ - "任务执行失败如何处理?是否有重试机制?"
356
+ - "任务执行日志如何记录?"
357
+ - "请提供定时任务的代码示例,包括:"
358
+ - " - 简单定时任务的定义示例"
359
+ - " - 带参数定时任务的示例"
360
+ - " - 分布式锁定时任务的示例"
361
+
362
+ - question: "项目中Elasticsearch的使用规范是什么?(如果使用)"
363
+ sub_questions:
364
+ - "ES的连接配置在哪里?"
365
+ - "索引的命名规范是什么?"
366
+ - "Mapping的定义规范是什么?"
367
+ - "数据同步策略是什么?(同步/异步/Canal等)"
368
+ - "请提供ES操作的代码示例,包括:"
369
+ - " - 索引创建的示例"
370
+ - " - 文档的CRUD示例"
371
+ - " - 复杂查询的示例"
372
+
373
+ - question: "项目中文件存储的使用规范是什么?"
374
+ sub_questions:
375
+ - "使用什么文件存储?配置在哪里?"
376
+ - "文件路径/Key的命名规范是什么?"
377
+ - "文件大小限制是什么?"
378
+ - "支持哪些文件类型?"
379
+ - "文件访问权限如何控制?"
380
+ - "请提供文件上传/下载的代码示例"
381
+
382
+ - question: "项目中是否使用其他中间件?使用规范是什么?"
383
+ sub_questions:
384
+ - "是否使用分布式配置中心?(Nacos/Apollo等)如何使用?"
385
+ - "是否使用服务注册发现?如何使用?"
386
+ - "是否使用链路追踪?如何使用?"
387
+ - "是否使用限流熔断?(Sentinel等)如何使用?"
388
+ - "请提供相关代码示例"
389
+
390
+ - category: B3-Java编码规范
391
+ priority: P0
392
+ description: 了解项目的Java编码规范和最佳实践
393
+ templates:
394
+ - question: "项目的Java编码规范是什么?"
395
+ sub_questions:
396
+ - "遵循什么编码规范?(阿里巴巴规范/Google规范/自定义)"
397
+ - "是否有规范文档?请提供链接或内容"
398
+
399
+ - question: "类和接口的命名规范是什么?"
400
+ sub_questions:
401
+ - "Controller类的命名规范?后缀是什么?"
402
+ - "Service接口和实现类的命名规范?"
403
+ - "DAO/Mapper/Repository的命名规范?"
404
+ - "Entity/PO的命名规范?"
405
+ - "DTO的命名规范?请求和响应如何区分?"
406
+ - "VO的命名规范?"
407
+ - "枚举类的命名规范?"
408
+ - "常量类的命名规范?"
409
+ - "工具类的命名规范?"
410
+ - "异常类的命名规范?"
411
+ - "请提供各类型的命名示例"
412
+
413
+ - question: "方法的命名规范是什么?"
414
+ sub_questions:
415
+ - "查询单个对象的方法命名?(get/find/query/select)"
416
+ - "查询列表的方法命名?"
417
+ - "查询分页的方法命名?"
418
+ - "新增的方法命名?(add/insert/create/save)"
419
+ - "修改的方法命名?(update/modify/edit)"
420
+ - "删除的方法命名?(delete/remove)"
421
+ - "批量操作的方法命名?"
422
+ - "布尔判断的方法命名?(is/has/can/should)"
423
+ - "请提供方法命名示例"
424
+
425
+ - question: "注释规范是什么?"
426
+ sub_questions:
427
+ - "类注释的格式要求?必须包含哪些内容?"
428
+ - "方法注释的格式要求?参数和返回值如何描述?"
429
+ - "字段注释的格式要求?"
430
+ - "是否使用Swagger注解?格式要求是什么?"
431
+ - "TODO/FIXME注释的格式要求?"
432
+ - "请提供注释示例"
433
+
434
+ - question: "异常处理规范是什么?"
435
+ sub_questions:
436
+ - "项目有哪些自定义异常类?何时使用?"
437
+ - "异常应该在哪一层捕获和处理?"
438
+ - "业务异常和系统异常如何区分?"
439
+ - "异常信息如何记录日志?"
440
+ - "全局异常处理器是如何实现的?"
441
+ - "请提供异常处理的代码示例"
442
+
443
+ - question: "日志打印规范是什么?"
444
+ sub_questions:
445
+ - "使用什么日志框架?(SLF4J+Logback等)"
446
+ - "不同级别日志(DEBUG/INFO/WARN/ERROR)的使用场景?"
447
+ - "日志内容应该包含哪些信息?"
448
+ - "敏感信息如何脱敏?"
449
+ - "请求入参出参如何记录?"
450
+ - "请提供日志打印的代码示例"
451
+
452
+ - question: "Controller层的编码规范是什么?"
453
+ sub_questions:
454
+ - "URL路径的命名规范?RESTful还是其他风格?"
455
+ - "请求方法的使用规范?(GET/POST/PUT/DELETE)"
456
+ - "参数接收方式的规范?(@RequestParam/@RequestBody/@PathVariable)"
457
+ - "响应格式的统一规范?"
458
+ - "参数校验如何实现?使用什么注解?"
459
+ - "请提供Controller的代码模板"
460
+
461
+ - question: "Service层的编码规范是什么?"
462
+ sub_questions:
463
+ - "是否必须定义接口?接口和实现类的关系?"
464
+ - "事务注解如何使用?事务传播行为如何选择?"
465
+ - "Service之间如何调用?是否允许循环依赖?"
466
+ - "复杂业务逻辑如何拆分?"
467
+ - "请提供Service的代码模板"
468
+
469
+ - question: "DAO层的编码规范是什么?"
470
+ sub_questions:
471
+ - "使用什么ORM框架?(MyBatis/MyBatis-Plus/JPA等)"
472
+ - "Mapper接口的编写规范?"
473
+ - "XML文件还是注解方式?"
474
+ - "动态SQL的编写规范?"
475
+ - "请提供DAO的代码模板"
476
+
477
+ - category: B4-SQL规范
478
+ priority: P0
479
+ description: 了解项目的SQL编写规范
480
+ templates:
481
+ - question: "项目的SQL编写规范是什么?"
482
+ sub_questions:
483
+ - "是否有SQL规范文档?请提供链接或内容"
484
+
485
+ - question: "表设计规范是什么?"
486
+ sub_questions:
487
+ - "表名的命名规范?前缀规则?"
488
+ - "字段名的命名规范?(驼峰/下划线)"
489
+ - "主键的设计规范?(自增/UUID/雪花ID)"
490
+ - "是否必须有创建时间/更新时间/创建人/更新人字段?"
491
+ - "是否必须有逻辑删除字段?"
492
+ - "是否必须有版本号字段(乐观锁)?"
493
+ - "字段类型的选择规范?"
494
+ - "字段长度的设计规范?"
495
+ - "索引的命名和设计规范?"
496
+ - "请提供建表语句的模板"
497
+
498
+ - question: "SQL查询规范是什么?"
499
+ sub_questions:
500
+ - "SELECT是否禁止使用*?"
501
+ - "WHERE条件的编写规范?"
502
+ - "JOIN的使用规范?最多允许关联几张表?"
503
+ - "子查询的使用规范?"
504
+ - "ORDER BY的使用规范?"
505
+ - "LIMIT的使用规范?深分页如何处理?"
506
+ - "请提供查询SQL的示例"
507
+
508
+ - question: "SQL更新规范是什么?"
509
+ sub_questions:
510
+ - "UPDATE是否必须带WHERE条件?"
511
+ - "批量更新的写法规范?"
512
+ - "是否使用乐观锁?如何使用?"
513
+ - "请提供更新SQL的示例"
514
+
515
+ - question: "SQL性能规范是什么?"
516
+ sub_questions:
517
+ - "索引的使用规范?如何避免索引失效?"
518
+ - "大表查询的规范?"
519
+ - "慢SQL的定义标准?如何优化?"
520
+ - "EXPLAIN的使用规范?"
521
+ - "请提供SQL优化的示例"
522
+
523
+ - category: B5-数据模型
524
+ priority: P0
525
+ description: 了解数据库表结构和数据模型
526
+ templates:
527
+ - question: "[{entity}]对应的数据库表结构是什么?"
528
+ sub_questions:
529
+ - "表名是什么?"
530
+ - "包含哪些字段?每个字段的类型、长度、约束?"
531
+ - "主键是什么?主键生成策略是什么?"
532
+ - "有哪些索引?索引类型是什么?"
533
+ - "有哪些外键约束?(如果有)"
534
+ - "请提供完整的DDL语句"
535
+
536
+ - question: "[{entity_a}]和[{entity_b}]的数据库关联设计是什么?"
537
+ sub_questions:
538
+ - "关联类型是什么?(一对一/一对多/多对多)"
539
+ - "外键在哪张表?外键字段名是什么?"
540
+ - "是否有中间表?中间表结构是什么?"
541
+ - "关联查询的SQL怎么写?"
542
+ - "请提供关联查询的示例SQL"
543
+
544
+ - question: "[{domain}]领域的ER图是什么?"
545
+ sub_questions:
546
+ - "涉及哪些表?"
547
+ - "表之间的关系是什么?"
548
+ - "请提供ER图或表关系说明"
549
+
550
+ - category: B6-接口规范
551
+ priority: P1
552
+ description: 了解API接口设计规范
553
+ templates:
554
+ - question: "项目的API接口规范是什么?"
555
+ sub_questions:
556
+ - "API风格是什么?(RESTful/RPC/GraphQL)"
557
+ - "URL设计规范是什么?"
558
+ - "版本控制如何实现?"
559
+ - "认证授权如何实现?"
560
+ - "请提供API设计规范文档"
561
+
562
+ - question: "接口请求规范是什么?"
563
+ sub_questions:
564
+ - "请求头的规范?必须包含哪些Header?"
565
+ - "请求体的格式?(JSON/Form)"
566
+ - "分页参数的规范?参数名是什么?"
567
+ - "排序参数的规范?"
568
+ - "请提供请求示例"
569
+
570
+ - question: "接口响应规范是什么?"
571
+ sub_questions:
572
+ - "统一响应格式是什么?包含哪些字段?"
573
+ - "成功响应的格式?"
574
+ - "错误响应的格式?"
575
+ - "分页响应的格式?"
576
+ - "错误码的设计规范?"
577
+ - "请提供响应示例"
578
+
579
+ - question: "现有的[{module}]模块提供了哪些API接口?"
580
+ sub_questions:
581
+ - "接口列表是什么?"
582
+ - "每个接口的URL、方法、参数、响应是什么?"
583
+ - "请提供Swagger文档或接口文档链接"
584
+
585
+ - category: B7-代码实现模式
586
+ priority: P1
587
+ description: 了解项目中的通用代码实现模式
588
+ templates:
589
+ - question: "项目中通用的CRUD实现模式是什么?"
590
+ sub_questions:
591
+ - "是否有通用的BaseController/BaseService?"
592
+ - "是否使用代码生成器?如何使用?"
593
+ - "请提供标准CRUD的代码示例"
594
+
595
+ - question: "项目中分页查询的实现模式是什么?"
596
+ sub_questions:
597
+ - "使用什么分页插件?(PageHelper/MyBatis-Plus等)"
598
+ - "分页参数如何接收?"
599
+ - "分页结果如何封装?"
600
+ - "请提供分页查询的代码示例"
601
+
602
+ - question: "项目中复杂查询的实现模式是什么?"
603
+ sub_questions:
604
+ - "多条件动态查询如何实现?"
605
+ - "多表关联查询如何实现?"
606
+ - "请提供复杂查询的代码示例"
607
+
608
+ - question: "项目中事务处理的实现模式是什么?"
609
+ sub_questions:
610
+ - "本地事务如何使用?"
611
+ - "分布式事务如何处理?使用什么方案?"
612
+ - "请提供事务处理的代码示例"
613
+
614
+ - question: "项目中有哪些通用工具类?"
615
+ sub_questions:
616
+ - "日期时间处理工具类?"
617
+ - "字符串处理工具类?"
618
+ - "JSON处理工具类?"
619
+ - "加密解密工具类?"
620
+ - "文件处理工具类?"
621
+ - "HTTP请求工具类?"
622
+ - "请提供工具类的使用示例"
623
+
624
+ # ==================== C. 历史追溯问题 ====================
625
+ - id: history-questions
626
+ title: C. 历史追溯问题
627
+ instruction: |
628
+ 针对历史需求和决策生成问题,重点关注:
629
+ - 相关历史需求
630
+ - 技术决策记录
631
+ - 已知问题和债务
632
+ question_templates:
633
+ - category: C1-历史需求
634
+ priority: P1
635
+ templates:
636
+ - question: "之前有没有类似[{feature}]的需求?"
637
+ sub_questions:
638
+ - "实现情况如何?是否上线?"
639
+ - "实现过程中遇到了什么问题?"
640
+ - "有什么经验教训可以借鉴?"
641
+ - "相关代码在哪里?"
642
+
643
+ - question: "[{module}]模块最近有什么变更?"
644
+ sub_questions:
645
+ - "变更的内容是什么?"
646
+ - "变更的原因是什么?"
647
+ - "变更后是否有问题?"
648
+
649
+ - category: C2-决策记录
650
+ priority: P2
651
+ templates:
652
+ - question: "[{technical_choice}]为什么选择当前的实现方式?"
653
+ sub_questions:
654
+ - "决策的背景是什么?"
655
+ - "考虑过哪些备选方案?"
656
+ - "选择当前方案的理由是什么?"
657
+ - "这个决策有什么限制或trade-off?"
658
+
659
+ - category: C3-已知问题
660
+ priority: P1
661
+ templates:
662
+ - question: "[{module}]模块有哪些已知的问题或技术债务?"
663
+ sub_questions:
664
+ - "问题的具体描述是什么?"
665
+ - "问题的影响范围是什么?"
666
+ - "是否有计划修复?"
667
+ - "新功能开发需要注意什么?"
668
+
669
+ # ==================== D. 约束条件问题 ====================
670
+ - id: constraint-questions
671
+ title: D. 约束条件问题
672
+ instruction: |
673
+ 针对项目和技术约束生成问题,重点关注:
674
+ - 技术栈限制
675
+ - 安全合规要求
676
+ - 性能要求
677
+ - 团队规范
678
+ question_templates:
679
+ - category: D1-技术约束
680
+ priority: P1
681
+ templates:
682
+ - question: "项目的技术栈限制有哪些?"
683
+ sub_questions:
684
+ - "必须使用什么框架/库?不能使用什么?"
685
+ - "JDK版本要求是什么?"
686
+ - "是否有第三方库的版本要求?"
687
+ - "是否有禁止使用的技术或方案?"
688
+
689
+ - question: "[{technical_approach}]方案在当前技术栈下是否可行?"
690
+ sub_questions:
691
+ - "是否与现有技术兼容?"
692
+ - "是否需要引入新的依赖?"
693
+ - "团队是否有相关经验?"
694
+
695
+ - category: D2-安全合规
696
+ priority: P0
697
+ templates:
698
+ - question: "[{data_type}]数据的安全要求是什么?"
699
+ sub_questions:
700
+ - "数据的敏感级别是什么?"
701
+ - "存储时是否需要加密?用什么算法?"
702
+ - "传输时是否需要加密?"
703
+ - "是否需要脱敏?脱敏规则是什么?"
704
+ - "数据的访问权限如何控制?"
705
+ - "数据的保留期限是多久?"
706
+
707
+ - question: "项目的安全规范是什么?"
708
+ sub_questions:
709
+ - "SQL注入如何防范?"
710
+ - "XSS如何防范?"
711
+ - "CSRF如何防范?"
712
+ - "接口防刷如何实现?"
713
+ - "敏感操作是否需要二次确认?"
714
+
715
+ - question: "项目需要满足哪些合规要求?"
716
+ sub_questions:
717
+ - "是否需要满足等保要求?什么级别?"
718
+ - "是否涉及个人隐私数据?需要满足什么要求?"
719
+ - "是否有审计日志要求?记录哪些内容?"
720
+
721
+ - category: D3-性能要求
722
+ priority: P1
723
+ templates:
724
+ - question: "项目的性能要求是什么?"
725
+ sub_questions:
726
+ - "接口响应时间要求?P99要求?"
727
+ - "并发量要求?峰值并发是多少?"
728
+ - "吞吐量要求?"
729
+ - "可用性要求?99.9%还是99.99%?"
730
+
731
+ - question: "[{interface}]接口的性能要求是什么?"
732
+ sub_questions:
733
+ - "响应时间要求是多少?"
734
+ - "预期的调用频率是多少?"
735
+ - "是否需要限流?限流规则是什么?"
736
+
737
+ - category: D4-团队规范
738
+ priority: P2
739
+ templates:
740
+ - question: "团队的开发流程是什么?"
741
+ sub_questions:
742
+ - "分支管理策略是什么?(GitFlow等)"
743
+ - "代码审查流程是什么?"
744
+ - "上线流程是什么?"
745
+ - "环境有哪些?(dev/test/staging/prod)"
746
+
747
+ - question: "团队的测试要求是什么?"
748
+ sub_questions:
749
+ - "单元测试覆盖率要求?"
750
+ - "是否需要集成测试?"
751
+ - "是否需要性能测试?"
752
+ - "测试用例的编写规范?"
753
+
754
+ - id: question-prioritization
755
+ title: 第三阶段:问题优先级排序
756
+ instruction: |
757
+ 对生成的问题进行优先级排序:
758
+
759
+ **P0 - 阻塞级**(必须回答)
760
+ - 缺失会导致完全无法理解需求
761
+ - 涉及核心业务规则
762
+ - 影响架构决策
763
+ - 涉及安全合规
764
+
765
+ **P1 - 重要级**(强烈建议回答)
766
+ - 影响需求完整性
767
+ - 涉及边界情况处理
768
+ - 影响实现方案选择
769
+ - 涉及性能要求
770
+
771
+ **P2 - 补充级**(可选回答)
772
+ - 有助于优化实现
773
+ - 提供额外上下文
774
+ - 历史参考信息
775
+ output:
776
+ format: markdown
777
+ template: |
778
+ # 知识库查询问题清单
779
+
780
+ ## 元信息
781
+ - 源文档: req.txt
782
+ - 生成时间: {{timestamp}}
783
+ - 总问题数: {{total_count}}
784
+ - P0问题: {{p0_count}} | P1问题: {{p1_count}} | P2问题: {{p2_count}}
785
+
786
+ ---
787
+
788
+ ## P0 阻塞级问题(必须回答)
789
+
790
+ ### A. 业务知识
791
+ {{#each p0_business}}
792
+ #### {{index}}. [{{id}}] {{question}}
793
+ - 关联需求: "{{related_requirement}}"
794
+ - 预期答案类型: {{expected_answer_type}}
795
+ - 子问题:
796
+ {{#each sub_questions}}
797
+ - {{this}}
798
+ {{/each}}
799
+ {{/each}}
800
+
801
+ ### B. 技术知识
802
+ {{#each p0_technical}}
803
+ #### {{index}}. [{{id}}] {{question}}
804
+ - 关联需求: "{{related_requirement}}"
805
+ - 预期答案类型: {{expected_answer_type}}
806
+ - 子问题:
807
+ {{#each sub_questions}}
808
+ - {{this}}
809
+ {{/each}}
810
+ - **注意**: 请提供相关代码示例
811
+ {{/each}}
812
+
813
+ ---
814
+
815
+ ## P1 重要级问题(强烈建议回答)
816
+
817
+ ### A. 业务知识
818
+ {{#each p1_business}}
819
+ #### {{index}}. [{{id}}] {{question}}
820
+ - 关联需求: "{{related_requirement}}"
821
+ - 子问题:
822
+ {{#each sub_questions}}
823
+ - {{this}}
824
+ {{/each}}
825
+ {{/each}}
826
+
827
+ ### B. 技术知识
828
+ {{#each p1_technical}}
829
+ #### {{index}}. [{{id}}] {{question}}
830
+ - 关联需求: "{{related_requirement}}"
831
+ - 子问题:
832
+ {{#each sub_questions}}
833
+ - {{this}}
834
+ {{/each}}
835
+ {{/each}}
836
+
837
+ ### C. 历史追溯
838
+ {{#each p1_history}}
839
+ #### {{index}}. [{{id}}] {{question}}
840
+ - 关联需求: "{{related_requirement}}"
841
+ {{/each}}
842
+
843
+ ---
844
+
845
+ ## P2 补充级问题(可选回答)
846
+
847
+ {{#each p2_questions}}
848
+ #### {{index}}. [{{id}}] {{question}}
849
+ {{/each}}
850
+
851
+ - id: knowledge-landing
852
+ title: 第四阶段:知识落地规范
853
+ instruction: |
854
+ 知识库返回的内容应按以下结构存储到 docs/rag/ 目录:
855
+ output:
856
+ structure: |
857
+ docs/rag/
858
+ ├── _index.md # 知识索引(自动生成)
859
+ ├── _questions.md # 问题清单(本模板输出)
860
+
861
+ ├── business/ # 业务知识
862
+ │ ├── domain-{{domain}}.md # 领域知识
863
+ │ ├── rules-{{topic}}.md # 业务规则
864
+ │ ├── process-{{name}}.md # 业务流程(含详细步骤和关联关系)
865
+ │ ├── data-relations.md # 数据关联关系
866
+ │ └── roles.md # 角色权限
867
+
868
+ ├── technical/ # 技术知识
869
+ │ ├── architecture.md # 整体技术架构
870
+ │ ├── tech-stack.md # 技术栈详情
871
+ │ ├── module-structure.md # 模块结构
872
+ │ ├── middleware/ # 中间件规范
873
+ │ │ ├── redis.md # Redis使用规范和代码示例
874
+ │ │ ├── mq.md # 消息队列规范和代码示例
875
+ │ │ ├── scheduler.md # 定时任务规范和代码示例
876
+ │ │ ├── elasticsearch.md # ES规范和代码示例
877
+ │ │ └── file-storage.md # 文件存储规范
878
+ │ ├── coding-standards/ # 编码规范
879
+ │ │ ├── java-naming.md # Java命名规范
880
+ │ │ ├── java-coding.md # Java编码规范
881
+ │ │ ├── exception.md # 异常处理规范
882
+ │ │ ├── logging.md # 日志规范
883
+ │ │ └── layer-standards.md # 分层规范(Controller/Service/DAO)
884
+ │ ├── sql-standards/ # SQL规范
885
+ │ │ ├── table-design.md # 表设计规范
886
+ │ │ ├── query-standards.md # 查询规范
887
+ │ │ └── performance.md # SQL性能规范
888
+ │ ├── data-model.md # 数据模型(表结构)
889
+ │ ├── api-{{module}}.md # 接口规范
890
+ │ └── patterns.md # 代码模式和示例
891
+
892
+ ├── history/ # 历史信息
893
+ │ ├── related-features.md # 相关功能
894
+ │ └── decisions.md # 决策记录
895
+
896
+ └── constraints/ # 约束条件
897
+ ├── technical.md # 技术约束
898
+ ├── security.md # 安全要求
899
+ └── performance.md # 性能要求
900
+
901
+ file_template: |
902
+ # {{title}}
903
+
904
+ ## 元信息
905
+ - 查询问题: {{question}}
906
+ - 问题ID: {{question_id}}
907
+ - 查询时间: {{timestamp}}
908
+ - 数据来源: 知识库MCP
909
+
910
+ ## 内容摘要
911
+ {{summary}}
912
+
913
+ ## 详细内容
914
+ {{content}}
915
+
916
+ ## 代码示例(如适用)
917
+ {{#if code_examples}}
918
+ {{#each code_examples}}
919
+ ### {{title}}
920
+ ```{{language}}
921
+ {{code}}
922
+ ```
923
+ **说明**: {{description}}
924
+ {{/each}}
925
+ {{/if}}
926
+
927
+ ## 需求关联
928
+ - 关联需求点: {{related_requirement}}
929
+ - 影响分析: {{impact_analysis}}
930
+
931
+ ## 衍生问题
932
+ {{#if follow_up_questions}}
933
+ {{#each follow_up_questions}}
934
+ - {{this}}
935
+ {{/each}}
936
+ {{else}}
937
+
938
+ {{/if}}
939
+
940
+ elicitation:
941
+ after_each_phase: true
942
+ options:
943
+ - "调整问题优先级"
944
+ - "添加更多问题"
945
+ - "删除不相关问题"
946
+ - "修改问题措辞"
947
+ - "添加子问题"
948
+ - "要求提供代码示例"
949
+ - "进入下一阶段"