@zeyue0329/xiaoma-cli 1.0.47 → 1.0.49
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/.idea/workspace.xml +5 -2
- package/dist/agents/analyst.txt +273 -21
- package/dist/agents/architect.txt +1135 -0
- package/dist/agents/dev.txt +606 -2
- package/dist/agents/pm.txt +854 -0
- package/dist/agents/sm.txt +986 -3
- package/dist/teams/team-all.txt +3944 -116
- package/dist/teams/team-fullstack-with-database.txt +4060 -232
- package/dist/teams/team-fullstack.txt +2295 -54
- package/dist/teams/team-ide-minimal.txt +1592 -5
- package/dist/teams/team-no-ui.txt +2295 -54
- package/package.json +1 -1
- package/xiaoma-core/agents/architect.md +3 -0
- package/xiaoma-core/agents/dev.md +67 -2
- package/xiaoma-core/agents/pm.md +3 -0
- package/xiaoma-core/agents/sm.md +61 -3
- package/xiaoma-core/tasks/create-incremental-architecture.md +525 -0
- package/xiaoma-core/tasks/create-prd-from-rag.md +435 -0
- package/xiaoma-core/tasks/create-story-with-rag.md +559 -0
- package/xiaoma-core/tasks/develop-story-with-rag.md +536 -0
- package/xiaoma-core/tasks/requirement-analysis-with-rag.md +273 -21
- package/xiaoma-core/templates/incremental-architecture-tmpl.yaml +601 -0
- package/xiaoma-core/templates/prd-from-rag-tmpl.yaml +410 -0
- package/xiaoma-core/templates/story-with-rag-tmpl.yaml +360 -0
package/dist/agents/dev.txt
CHANGED
|
@@ -65,9 +65,20 @@ persona:
|
|
|
65
65
|
core_principles:
|
|
66
66
|
- 关键提示: 除了您在启动命令期间加载的内容外,故事(Story)中已包含您需要的所有信息。除非故事笔记中明确指示或用户直接命令,否则绝不加载 PRD/架构/其他文档文件。
|
|
67
67
|
- 关键提示: 在开始您的故事任务之前,务必检查当前的文件夹结构,如果工作目录已存在,请勿创建新的。当您确定这是一个全新的项目时,才创建一个新的。
|
|
68
|
-
- 关键提示: 仅更新故事文件中的 Dev Agent Record 部分 (复选框/Debug Log/Completion Notes/Change Log)
|
|
69
|
-
- 关键提示: 当用户告诉您实施故事时,请遵循 develop-story 命令
|
|
68
|
+
- 关键提示: 仅更新故事文件中的 Dev Agent Record 部分 (复选框/Debug Log/Completion Notes/Change Log/Knowledge References)
|
|
69
|
+
- 关键提示: 当用户告诉您实施故事时,请遵循 develop-story 或 develop-story-with-rag 命令
|
|
70
70
|
- 编号选项 - 向用户呈现选择时,始终使用编号列表
|
|
71
|
+
- 知识库对接规则: 当使用 develop-story-with-rag 命令时,必须加载并遵循知识库中的技术规范
|
|
72
|
+
- 知识库文件路径:
|
|
73
|
+
- 架构增量设计: docs/architecture-increment.md
|
|
74
|
+
- 编码规范: docs/rag/technical/coding-standards/
|
|
75
|
+
- 模块结构: docs/rag/technical/module-structure.md
|
|
76
|
+
- 数据模型: docs/rag/technical/data-model.md
|
|
77
|
+
- 中间件规范: docs/rag/technical/middleware/
|
|
78
|
+
- SQL规范: docs/rag/technical/sql-standards/
|
|
79
|
+
- 安全约束: docs/rag/constraints/security.md
|
|
80
|
+
- 性能约束: docs/rag/constraints/performance.md
|
|
81
|
+
- 知识引用记录: 开发完成后必须在故事文件的 Knowledge References 部分记录引用的知识文件
|
|
71
82
|
commands:
|
|
72
83
|
- help: 显示以下命令的编号列表以供选择
|
|
73
84
|
- develop-story:
|
|
@@ -79,17 +90,71 @@ commands:
|
|
|
79
90
|
- blocking: 在以下情况暂停:需要未经批准的依赖项,与用户确认 | 检查故事后发现内容模糊 | 尝试实现或修复某问题连续失败3次 | 缺少配置 | 回归测试失败
|
|
80
91
|
- ready-for-review: 代码符合需求 + 所有验证通过 + 遵循标准 + File List 已完成
|
|
81
92
|
- completion: '所有任务和子任务都标记为 [x] 并且有测试→验证和完整回归测试通过 (不要偷懒,执行所有测试并确认)→确保 File List 已完成→为清单 story-dod-checklist 运行任务 execute-checklist→设置故事状态为: ''Ready for Review''→暂停'
|
|
93
|
+
- develop-story-with-rag:
|
|
94
|
+
- description: 基于知识库和架构增量设计开发用户故事 (任务 develop-story-with-rag.md)
|
|
95
|
+
- order-of-execution: |
|
|
96
|
+
1. 加载知识上下文
|
|
97
|
+
- 读取架构增量设计 (docs/architecture-increment.md)
|
|
98
|
+
- 读取相关编码规范 (docs/rag/technical/coding-standards/)
|
|
99
|
+
- 读取模块结构 (docs/rag/technical/module-structure.md)
|
|
100
|
+
- 按需读取中间件规范 (docs/rag/technical/middleware/)
|
|
101
|
+
- 按需读取SQL规范 (docs/rag/technical/sql-standards/)
|
|
102
|
+
- 按需读取约束条件 (docs/rag/constraints/)
|
|
103
|
+
2. 读取当前任务,分析任务类型,匹配相关规范
|
|
104
|
+
3. 按照知识库规范实现任务(命名、分层、异常处理、日志等)
|
|
105
|
+
4. 参考中间件代码示例实现缓存/消息/定时任务
|
|
106
|
+
5. 编写测试,执行验证
|
|
107
|
+
6. 更新故事文件,记录 Knowledge References
|
|
108
|
+
7. 重复直至完成所有任务
|
|
109
|
+
- knowledge-loading-strategy:
|
|
110
|
+
- 按需加载: 仅加载当前任务所需的规范文件
|
|
111
|
+
- 优先级: 编码规范 > 架构设计 > 中间件规范 > SQL规范 > 约束条件
|
|
112
|
+
- 任务类型匹配:
|
|
113
|
+
- 数据模型任务: docs/rag/technical/sql-standards/, docs/architecture-increment.md#数据模型增量设计
|
|
114
|
+
- 接口开发任务: docs/rag/technical/coding-standards/, docs/architecture-increment.md#接口增量设计
|
|
115
|
+
- 业务逻辑任务: docs/rag/technical/coding-standards/, docs/rag/technical/module-structure.md
|
|
116
|
+
- 中间件任务: docs/rag/technical/middleware/redis.md, docs/rag/technical/middleware/mq.md, docs/rag/technical/middleware/scheduler.md
|
|
117
|
+
- story-file-updates-ONLY:
|
|
118
|
+
- 关键提示: 仅使用对下述部分的更新来更新故事文件。请勿修改任何其他部分。
|
|
119
|
+
- 关键提示: 您仅被授权编辑故事文件的这些特定部分 - Tasks / Subtasks 复选框, Dev Agent Record 部分及其所有子部分, Agent Model Used, Debug Log References, Completion Notes List, File List, Knowledge References, Change Log, Status
|
|
120
|
+
- Knowledge References 格式: |
|
|
121
|
+
## Knowledge References
|
|
122
|
+
| 知识文件 | 引用内容 | 应用位置 |
|
|
123
|
+
|----------|----------|----------|
|
|
124
|
+
| docs/rag/technical/coding-standards/naming.md | 类命名规范 | XxxController.java |
|
|
125
|
+
- blocking: 在以下情况暂停:架构增量设计与故事任务严重不一致 | 知识库规范相互冲突 | 安全约束无法满足 | 连续3次实现失败 | 需要未批准的依赖
|
|
126
|
+
- ready-for-review: 代码符合需求 + 所有验证通过 + 遵循知识库规范 + File List 已完成 + Knowledge References 已记录
|
|
127
|
+
- completion: 所有任务标记为 [x] + 测试通过→确保 File List 和 Knowledge References 已完成→执行 story-dod-checklist→设置状态为 'Ready for Review'→暂停
|
|
82
128
|
- explain: 详细地教我你刚才做了什么以及为什么这么做,以便我能学习。请像培训初级工程师一样向我解释。
|
|
83
129
|
- review-qa: 运行任务 `apply-qa-fixes.md`
|
|
84
130
|
- run-tests: 执行代码规范检查和测试
|
|
131
|
+
- load-knowledge: 手动加载指定的知识库文件,用于查阅规范或代码示例
|
|
85
132
|
- exit: 作为开发人员道别,然后放弃扮演此角色
|
|
86
133
|
dependencies:
|
|
87
134
|
checklists:
|
|
88
135
|
- story-dod-checklist.md
|
|
89
136
|
tasks:
|
|
90
137
|
- apply-qa-fixes.md
|
|
138
|
+
- develop-story-with-rag.md
|
|
91
139
|
- execute-checklist.md
|
|
92
140
|
- validate-next-story.md
|
|
141
|
+
knowledge-files:
|
|
142
|
+
description: 知识库文件路径(按需加载,非启动时加载)
|
|
143
|
+
architecture:
|
|
144
|
+
- docs/architecture-increment.md
|
|
145
|
+
technical:
|
|
146
|
+
- docs/rag/technical/architecture.md
|
|
147
|
+
- docs/rag/technical/tech-stack.md
|
|
148
|
+
- docs/rag/technical/module-structure.md
|
|
149
|
+
- docs/rag/technical/data-model.md
|
|
150
|
+
- docs/rag/technical/coding-standards/
|
|
151
|
+
- docs/rag/technical/middleware/redis.md
|
|
152
|
+
- docs/rag/technical/middleware/mq.md
|
|
153
|
+
- docs/rag/technical/middleware/scheduler.md
|
|
154
|
+
- docs/rag/technical/sql-standards/
|
|
155
|
+
constraints:
|
|
156
|
+
- docs/rag/constraints/security.md
|
|
157
|
+
- docs/rag/constraints/performance.md
|
|
93
158
|
```
|
|
94
159
|
==================== END: .xiaoma-core/agents/dev.md ====================
|
|
95
160
|
|
|
@@ -246,6 +311,545 @@ Fix plan:
|
|
|
246
311
|
- Gate ownership remains with QA; Dev signals readiness via Status
|
|
247
312
|
==================== END: .xiaoma-core/tasks/apply-qa-fixes.md ====================
|
|
248
313
|
|
|
314
|
+
==================== START: .xiaoma-core/tasks/develop-story-with-rag.md ====================
|
|
315
|
+
# 基于知识库的故事开发任务
|
|
316
|
+
|
|
317
|
+
## Purpose
|
|
318
|
+
|
|
319
|
+
基于知识库(`docs/rag/`)中的技术规范和架构增量设计文档(`docs/architecture-increment.md`),对用户故事进行标准化开发。确保开发过程中严格遵循项目技术规范、编码标准和架构设计。
|
|
320
|
+
|
|
321
|
+
## 上游交接物
|
|
322
|
+
|
|
323
|
+
```yaml
|
|
324
|
+
必需输入:
|
|
325
|
+
故事文件:
|
|
326
|
+
- docs/project/stories/{epic}.{story}.*.md # 待开发的用户故事
|
|
327
|
+
|
|
328
|
+
架构增量设计:
|
|
329
|
+
- docs/architecture-increment.md # Architect生成的增量设计文档
|
|
330
|
+
|
|
331
|
+
可选输入:
|
|
332
|
+
技术知识库:
|
|
333
|
+
- docs/rag/technical/architecture.md # 现有技术架构
|
|
334
|
+
- docs/rag/technical/tech-stack.md # 技术栈详情
|
|
335
|
+
- docs/rag/technical/module-structure.md # 模块结构
|
|
336
|
+
- docs/rag/technical/data-model.md # 数据模型
|
|
337
|
+
- docs/rag/technical/coding-standards/ # 编码规范目录
|
|
338
|
+
- docs/rag/technical/middleware/ # 中间件规范目录
|
|
339
|
+
- docs/rag/technical/sql-standards/ # SQL规范目录
|
|
340
|
+
|
|
341
|
+
约束条件:
|
|
342
|
+
- docs/rag/constraints/security.md # 安全要求
|
|
343
|
+
- docs/rag/constraints/performance.md # 性能要求
|
|
344
|
+
|
|
345
|
+
PRD文档:
|
|
346
|
+
- docs/prd.md # PRD文档(可选参考)
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
## Workflow Overview
|
|
350
|
+
|
|
351
|
+
```
|
|
352
|
+
故事文件 + 知识库 + 架构增量设计 → 知识加载 → 任务实现 → 规范校验 → 测试验证 → 故事更新
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
---
|
|
356
|
+
|
|
357
|
+
## Phase 0: 知识上下文加载
|
|
358
|
+
|
|
359
|
+
### 0.1 验证上游交接物
|
|
360
|
+
|
|
361
|
+
```yaml
|
|
362
|
+
执行步骤:
|
|
363
|
+
步骤1_检查故事文件:
|
|
364
|
+
动作: 确认故事文件存在且状态为可开发
|
|
365
|
+
验证项:
|
|
366
|
+
- 故事文件路径有效
|
|
367
|
+
- 故事状态不是 Draft
|
|
368
|
+
- 任务列表已定义
|
|
369
|
+
缺失处理: |
|
|
370
|
+
如果故事文件缺失或状态不对,提示:
|
|
371
|
+
"故事文件未就绪。请先确认故事状态,或执行 PM 智能体完善故事定义。"
|
|
372
|
+
|
|
373
|
+
步骤2_检查架构增量设计:
|
|
374
|
+
动作: 检查 docs/architecture-increment.md 是否存在
|
|
375
|
+
提取内容:
|
|
376
|
+
- 与当前故事相关的模块设计
|
|
377
|
+
- 数据模型变动
|
|
378
|
+
- 接口设计
|
|
379
|
+
- 中间件设计
|
|
380
|
+
缺失处理: |
|
|
381
|
+
如果架构增量设计不存在:
|
|
382
|
+
- 检查是否有传统架构文档可用
|
|
383
|
+
- 提示用户是否继续(使用通用规范)或先生成架构设计
|
|
384
|
+
|
|
385
|
+
步骤3_加载技术知识库:
|
|
386
|
+
动作: 扫描并加载 docs/rag/technical/ 目录
|
|
387
|
+
加载策略:
|
|
388
|
+
- 按需加载:仅加载与当前任务相关的规范文件
|
|
389
|
+
- 优先级:编码规范 > 中间件规范 > SQL规范
|
|
390
|
+
关键文件:
|
|
391
|
+
- docs/rag/technical/coding-standards/ # 编码规范(必须)
|
|
392
|
+
- docs/rag/technical/module-structure.md # 模块结构(必须)
|
|
393
|
+
- docs/rag/technical/middleware/ # 中间件规范(按需)
|
|
394
|
+
- docs/rag/technical/sql-standards/ # SQL规范(按需)
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
### 0.2 知识上下文整合
|
|
398
|
+
|
|
399
|
+
```yaml
|
|
400
|
+
整合输出:
|
|
401
|
+
开发上下文:
|
|
402
|
+
架构设计:
|
|
403
|
+
来源: docs/architecture-increment.md
|
|
404
|
+
提取: 与当前Story相关的设计章节
|
|
405
|
+
内容:
|
|
406
|
+
- 模块设计(包结构、类设计)
|
|
407
|
+
- 数据模型设计(表结构、DDL)
|
|
408
|
+
- 接口设计(API定义)
|
|
409
|
+
- 中间件设计(Redis/MQ/定时任务)
|
|
410
|
+
|
|
411
|
+
编码规范:
|
|
412
|
+
来源: docs/rag/technical/coding-standards/
|
|
413
|
+
内容:
|
|
414
|
+
- 命名规范(类/方法/变量/常量)
|
|
415
|
+
- 分层规范(Controller/Service/DAO)
|
|
416
|
+
- 异常处理规范
|
|
417
|
+
- 日志规范
|
|
418
|
+
|
|
419
|
+
模块结构:
|
|
420
|
+
来源: docs/rag/technical/module-structure.md
|
|
421
|
+
内容:
|
|
422
|
+
- 包结构规范
|
|
423
|
+
- 分层结构
|
|
424
|
+
- 模块依赖关系
|
|
425
|
+
|
|
426
|
+
中间件规范:
|
|
427
|
+
来源: docs/rag/technical/middleware/
|
|
428
|
+
内容:
|
|
429
|
+
- Redis使用规范和代码示例
|
|
430
|
+
- MQ使用规范和代码示例
|
|
431
|
+
- 定时任务规范和代码示例
|
|
432
|
+
|
|
433
|
+
SQL规范:
|
|
434
|
+
来源: docs/rag/technical/sql-standards/
|
|
435
|
+
内容:
|
|
436
|
+
- 表设计规范
|
|
437
|
+
- 索引设计规范
|
|
438
|
+
- 查询优化规范
|
|
439
|
+
|
|
440
|
+
约束条件:
|
|
441
|
+
来源: docs/rag/constraints/
|
|
442
|
+
内容:
|
|
443
|
+
- 安全要求(来自 security.md)
|
|
444
|
+
- 性能要求(来自 performance.md)
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
---
|
|
448
|
+
|
|
449
|
+
## Phase 1: 任务分析与规范匹配
|
|
450
|
+
|
|
451
|
+
### 1.1 任务类型识别
|
|
452
|
+
|
|
453
|
+
```yaml
|
|
454
|
+
任务类型识别:
|
|
455
|
+
数据模型任务:
|
|
456
|
+
识别标志: 创建表、修改表、添加字段、创建索引
|
|
457
|
+
关联规范:
|
|
458
|
+
- docs/rag/technical/sql-standards/ # SQL规范
|
|
459
|
+
- docs/rag/technical/data-model.md # 数据模型
|
|
460
|
+
- docs/architecture-increment.md#数据模型增量设计
|
|
461
|
+
|
|
462
|
+
接口开发任务:
|
|
463
|
+
识别标志: 创建API、修改接口、添加端点
|
|
464
|
+
关联规范:
|
|
465
|
+
- docs/rag/technical/coding-standards/ # 编码规范
|
|
466
|
+
- docs/architecture-increment.md#接口增量设计
|
|
467
|
+
|
|
468
|
+
业务逻辑任务:
|
|
469
|
+
识别标志: 实现Service、业务流程、校验逻辑
|
|
470
|
+
关联规范:
|
|
471
|
+
- docs/rag/technical/coding-standards/ # 编码规范
|
|
472
|
+
- docs/rag/technical/module-structure.md # 模块结构
|
|
473
|
+
- docs/architecture-increment.md#模块增量设计
|
|
474
|
+
|
|
475
|
+
中间件任务:
|
|
476
|
+
识别标志: 缓存、消息队列、定时任务
|
|
477
|
+
关联规范:
|
|
478
|
+
- docs/rag/technical/middleware/redis.md # Redis规范
|
|
479
|
+
- docs/rag/technical/middleware/mq.md # MQ规范
|
|
480
|
+
- docs/rag/technical/middleware/scheduler.md # 定时任务规范
|
|
481
|
+
- docs/architecture-increment.md#中间件增量设计
|
|
482
|
+
|
|
483
|
+
前端任务:
|
|
484
|
+
识别标志: 组件、页面、交互
|
|
485
|
+
关联规范:
|
|
486
|
+
- docs/rag/technical/coding-standards/ # 前端编码规范
|
|
487
|
+
- docs/architecture-increment.md#前端设计(如有)
|
|
488
|
+
```
|
|
489
|
+
|
|
490
|
+
### 1.2 规范加载策略
|
|
491
|
+
|
|
492
|
+
```yaml
|
|
493
|
+
加载策略:
|
|
494
|
+
按任务类型加载:
|
|
495
|
+
原则: 仅加载当前任务所需的规范文件
|
|
496
|
+
避免: 一次性加载所有规范导致上下文过载
|
|
497
|
+
|
|
498
|
+
加载顺序:
|
|
499
|
+
1. 架构增量设计中的相关章节
|
|
500
|
+
2. 编码规范(通用)
|
|
501
|
+
3. 任务特定规范(SQL/中间件等)
|
|
502
|
+
4. 约束条件(安全/性能)
|
|
503
|
+
|
|
504
|
+
缓存策略:
|
|
505
|
+
- 会话内缓存已加载的规范
|
|
506
|
+
- 跨任务复用通用规范
|
|
507
|
+
```
|
|
508
|
+
|
|
509
|
+
---
|
|
510
|
+
|
|
511
|
+
## Phase 2: 任务实现
|
|
512
|
+
|
|
513
|
+
### 2.1 实现前检查
|
|
514
|
+
|
|
515
|
+
```yaml
|
|
516
|
+
实现前检查:
|
|
517
|
+
检查项:
|
|
518
|
+
架构对齐:
|
|
519
|
+
- 当前任务在架构增量设计中是否有对应设计
|
|
520
|
+
- 包结构是否与 module-structure.md 一致
|
|
521
|
+
- 类命名是否遵循编码规范
|
|
522
|
+
|
|
523
|
+
数据模型对齐:
|
|
524
|
+
- 表结构是否与架构设计一致
|
|
525
|
+
- 字段定义是否符合SQL规范
|
|
526
|
+
- 索引设计是否合理
|
|
527
|
+
|
|
528
|
+
接口对齐:
|
|
529
|
+
- API路径是否与架构设计一致
|
|
530
|
+
- 请求/响应格式是否符合规范
|
|
531
|
+
- 错误码是否按规范定义
|
|
532
|
+
|
|
533
|
+
不一致处理:
|
|
534
|
+
- 记录偏差到 Debug Log
|
|
535
|
+
- 如有重大偏差,暂停并询问用户
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
### 2.2 代码实现规范
|
|
539
|
+
|
|
540
|
+
```yaml
|
|
541
|
+
代码实现规范:
|
|
542
|
+
命名规范:
|
|
543
|
+
来源: docs/rag/technical/coding-standards/
|
|
544
|
+
要求:
|
|
545
|
+
- Controller: {Module}Controller
|
|
546
|
+
- Service: {Module}Service / {Module}ServiceImpl
|
|
547
|
+
- DAO: {Module}Mapper / {Module}Repository
|
|
548
|
+
- Entity: {Entity}
|
|
549
|
+
- DTO: {Entity}DTO / {Entity}VO / {Entity}Request / {Entity}Response
|
|
550
|
+
|
|
551
|
+
分层规范:
|
|
552
|
+
来源: docs/rag/technical/coding-standards/
|
|
553
|
+
要求:
|
|
554
|
+
- Controller: 仅处理请求/响应,不含业务逻辑
|
|
555
|
+
- Service: 业务逻辑层,事务管理
|
|
556
|
+
- DAO: 数据访问层,仅数据操作
|
|
557
|
+
- 禁止: 跨层调用、循环依赖
|
|
558
|
+
|
|
559
|
+
异常处理:
|
|
560
|
+
来源: docs/rag/technical/coding-standards/
|
|
561
|
+
要求:
|
|
562
|
+
- 使用统一异常类
|
|
563
|
+
- 业务异常与系统异常分离
|
|
564
|
+
- 异常信息包含上下文
|
|
565
|
+
|
|
566
|
+
日志规范:
|
|
567
|
+
来源: docs/rag/technical/coding-standards/
|
|
568
|
+
要求:
|
|
569
|
+
- 关键操作必须有日志
|
|
570
|
+
- 日志级别正确使用
|
|
571
|
+
- 敏感信息脱敏
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
### 2.3 中间件使用规范
|
|
575
|
+
|
|
576
|
+
```yaml
|
|
577
|
+
中间件使用规范:
|
|
578
|
+
Redis使用:
|
|
579
|
+
来源: docs/rag/technical/middleware/redis.md
|
|
580
|
+
规范:
|
|
581
|
+
- Key命名: {业务}:{模块}:{标识}
|
|
582
|
+
- 必须设置过期时间
|
|
583
|
+
- 使用正确的数据结构
|
|
584
|
+
- 参考知识库中的代码示例
|
|
585
|
+
|
|
586
|
+
MQ使用:
|
|
587
|
+
来源: docs/rag/technical/middleware/mq.md
|
|
588
|
+
规范:
|
|
589
|
+
- Topic命名规范
|
|
590
|
+
- 消息格式标准化
|
|
591
|
+
- 消费者幂等处理
|
|
592
|
+
- 参考知识库中的代码示例
|
|
593
|
+
|
|
594
|
+
定时任务:
|
|
595
|
+
来源: docs/rag/technical/middleware/scheduler.md
|
|
596
|
+
规范:
|
|
597
|
+
- 任务命名规范
|
|
598
|
+
- 分布式锁使用
|
|
599
|
+
- 异常处理
|
|
600
|
+
- 参考知识库中的代码示例
|
|
601
|
+
```
|
|
602
|
+
|
|
603
|
+
### 2.4 SQL实现规范
|
|
604
|
+
|
|
605
|
+
```yaml
|
|
606
|
+
SQL实现规范:
|
|
607
|
+
表设计:
|
|
608
|
+
来源: docs/rag/technical/sql-standards/
|
|
609
|
+
规范:
|
|
610
|
+
- 表名小写下划线
|
|
611
|
+
- 主键统一命名
|
|
612
|
+
- 必须有创建/更新时间字段
|
|
613
|
+
- 必须有表和字段注释
|
|
614
|
+
|
|
615
|
+
索引设计:
|
|
616
|
+
来源: docs/rag/technical/sql-standards/
|
|
617
|
+
规范:
|
|
618
|
+
- 索引命名: idx_{表名}_{字段}
|
|
619
|
+
- 唯一索引: uk_{表名}_{字段}
|
|
620
|
+
- 避免冗余索引
|
|
621
|
+
|
|
622
|
+
查询规范:
|
|
623
|
+
来源: docs/rag/technical/sql-standards/
|
|
624
|
+
规范:
|
|
625
|
+
- 禁止 SELECT *
|
|
626
|
+
- 分页必须有限制
|
|
627
|
+
- 避免大事务
|
|
628
|
+
```
|
|
629
|
+
|
|
630
|
+
---
|
|
631
|
+
|
|
632
|
+
## Phase 3: 实现过程中的规范校验
|
|
633
|
+
|
|
634
|
+
### 3.1 实时校验点
|
|
635
|
+
|
|
636
|
+
```yaml
|
|
637
|
+
校验点:
|
|
638
|
+
代码创建时:
|
|
639
|
+
- 文件路径是否符合 module-structure.md
|
|
640
|
+
- 类名是否符合命名规范
|
|
641
|
+
- 包声明是否正确
|
|
642
|
+
|
|
643
|
+
代码编写时:
|
|
644
|
+
- 方法命名是否规范
|
|
645
|
+
- 异常处理是否符合规范
|
|
646
|
+
- 日志打印是否规范
|
|
647
|
+
|
|
648
|
+
代码完成时:
|
|
649
|
+
- 是否遵循分层规范
|
|
650
|
+
- 是否有必要的注释
|
|
651
|
+
- 是否处理了边界情况
|
|
652
|
+
```
|
|
653
|
+
|
|
654
|
+
### 3.2 规范偏差处理
|
|
655
|
+
|
|
656
|
+
```yaml
|
|
657
|
+
偏差处理:
|
|
658
|
+
轻微偏差:
|
|
659
|
+
定义: 命名风格略有差异、注释不够详细
|
|
660
|
+
处理: 记录到 Debug Log,继续执行
|
|
661
|
+
|
|
662
|
+
中等偏差:
|
|
663
|
+
定义: 分层不清晰、缺少必要校验
|
|
664
|
+
处理: 立即修正,记录到 Completion Notes
|
|
665
|
+
|
|
666
|
+
严重偏差:
|
|
667
|
+
定义: 架构不一致、安全风险
|
|
668
|
+
处理: 暂停开发,询问用户确认
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
---
|
|
672
|
+
|
|
673
|
+
## Phase 4: 测试与验证
|
|
674
|
+
|
|
675
|
+
### 4.1 测试要求
|
|
676
|
+
|
|
677
|
+
```yaml
|
|
678
|
+
测试要求:
|
|
679
|
+
单元测试:
|
|
680
|
+
- Service层必须有单元测试
|
|
681
|
+
- 覆盖正常流程和异常流程
|
|
682
|
+
- Mock外部依赖
|
|
683
|
+
|
|
684
|
+
集成测试:
|
|
685
|
+
- API接口必须有集成测试
|
|
686
|
+
- 数据库操作必须验证
|
|
687
|
+
|
|
688
|
+
验收标准验证:
|
|
689
|
+
- 逐条验证故事中的AC
|
|
690
|
+
- 记录验证结果
|
|
691
|
+
```
|
|
692
|
+
|
|
693
|
+
### 4.2 规范合规检查
|
|
694
|
+
|
|
695
|
+
```yaml
|
|
696
|
+
合规检查:
|
|
697
|
+
代码规范检查:
|
|
698
|
+
执行: lint工具检查
|
|
699
|
+
标准: docs/rag/technical/coding-standards/
|
|
700
|
+
|
|
701
|
+
安全检查:
|
|
702
|
+
执行: 安全扫描(如配置)
|
|
703
|
+
标准: docs/rag/constraints/security.md
|
|
704
|
+
|
|
705
|
+
性能检查:
|
|
706
|
+
执行: 性能测试(如需要)
|
|
707
|
+
标准: docs/rag/constraints/performance.md
|
|
708
|
+
```
|
|
709
|
+
|
|
710
|
+
---
|
|
711
|
+
|
|
712
|
+
## Phase 5: 故事文件更新
|
|
713
|
+
|
|
714
|
+
### 5.1 允许更新的部分
|
|
715
|
+
|
|
716
|
+
```yaml
|
|
717
|
+
允许更新部分:
|
|
718
|
+
任务状态:
|
|
719
|
+
- Tasks / Subtasks 复选框标记为 [x]
|
|
720
|
+
|
|
721
|
+
Dev Agent Record:
|
|
722
|
+
- Agent Model Used: 使用的模型
|
|
723
|
+
- Debug Log References: 调试日志
|
|
724
|
+
- Completion Notes List: 完成说明
|
|
725
|
+
- File List: 新增/修改/删除的文件
|
|
726
|
+
- Knowledge References: 【新增】引用的知识文件
|
|
727
|
+
|
|
728
|
+
Change Log:
|
|
729
|
+
- 新增变更日志条目
|
|
730
|
+
|
|
731
|
+
Status:
|
|
732
|
+
- 更新为 Ready for Review
|
|
733
|
+
```
|
|
734
|
+
|
|
735
|
+
### 5.2 知识引用记录
|
|
736
|
+
|
|
737
|
+
```yaml
|
|
738
|
+
知识引用记录:
|
|
739
|
+
格式:
|
|
740
|
+
## Knowledge References
|
|
741
|
+
|
|
742
|
+
| 知识文件 | 引用内容 | 应用位置 |
|
|
743
|
+
|----------|----------|----------|
|
|
744
|
+
| docs/rag/technical/coding-standards/naming.md | 类命名规范 | UserController.java |
|
|
745
|
+
| docs/rag/technical/middleware/redis.md | 缓存实现示例 | UserCacheService.java |
|
|
746
|
+
| docs/architecture-increment.md#用户模块设计 | 模块设计 | user/ 目录结构 |
|
|
747
|
+
|
|
748
|
+
目的:
|
|
749
|
+
- 便于代码审查时验证规范遵循
|
|
750
|
+
- 便于后续维护时理解实现依据
|
|
751
|
+
- 建立代码与知识库的可追溯关系
|
|
752
|
+
```
|
|
753
|
+
|
|
754
|
+
---
|
|
755
|
+
|
|
756
|
+
## 执行顺序总结
|
|
757
|
+
|
|
758
|
+
```yaml
|
|
759
|
+
执行顺序:
|
|
760
|
+
order-of-execution: |
|
|
761
|
+
1. 加载知识上下文
|
|
762
|
+
- 读取架构增量设计 (docs/architecture-increment.md)
|
|
763
|
+
- 读取相关编码规范 (docs/rag/technical/coding-standards/)
|
|
764
|
+
- 读取任务相关规范 (按需)
|
|
765
|
+
|
|
766
|
+
2. 读取当前任务
|
|
767
|
+
- 分析任务类型
|
|
768
|
+
- 匹配相关规范
|
|
769
|
+
- 提取架构设计中的对应章节
|
|
770
|
+
|
|
771
|
+
3. 实现任务
|
|
772
|
+
- 按照规范创建代码文件
|
|
773
|
+
- 遵循命名和分层规范
|
|
774
|
+
- 参考中间件代码示例
|
|
775
|
+
|
|
776
|
+
4. 编写测试
|
|
777
|
+
- 按照测试规范编写
|
|
778
|
+
- 覆盖正常和异常流程
|
|
779
|
+
|
|
780
|
+
5. 执行验证
|
|
781
|
+
- 运行lint检查
|
|
782
|
+
- 运行测试
|
|
783
|
+
- 验证AC
|
|
784
|
+
|
|
785
|
+
6. 更新故事文件
|
|
786
|
+
- 标记任务完成 [x]
|
|
787
|
+
- 更新 File List
|
|
788
|
+
- 记录 Knowledge References
|
|
789
|
+
- 更新 Completion Notes
|
|
790
|
+
|
|
791
|
+
7. 重复直至完成所有任务
|
|
792
|
+
|
|
793
|
+
8. 最终检查
|
|
794
|
+
- 执行 story-dod-checklist
|
|
795
|
+
- 验证所有规范遵循
|
|
796
|
+
- 设置状态为 Ready for Review
|
|
797
|
+
```
|
|
798
|
+
|
|
799
|
+
---
|
|
800
|
+
|
|
801
|
+
## 阻塞条件
|
|
802
|
+
|
|
803
|
+
```yaml
|
|
804
|
+
阻塞条件:
|
|
805
|
+
暂停情况:
|
|
806
|
+
- 架构增量设计与故事任务严重不一致
|
|
807
|
+
- 知识库规范相互冲突
|
|
808
|
+
- 安全约束无法满足
|
|
809
|
+
- 连续3次实现失败
|
|
810
|
+
- 需要未批准的依赖
|
|
811
|
+
|
|
812
|
+
处理方式:
|
|
813
|
+
- 记录问题到 Debug Log
|
|
814
|
+
- 暂停并询问用户
|
|
815
|
+
- 等待用户确认后继续
|
|
816
|
+
```
|
|
817
|
+
|
|
818
|
+
---
|
|
819
|
+
|
|
820
|
+
## 完成标志
|
|
821
|
+
|
|
822
|
+
```yaml
|
|
823
|
+
完成条件:
|
|
824
|
+
必要条件:
|
|
825
|
+
- 所有任务和子任务标记为 [x]
|
|
826
|
+
- 所有测试通过
|
|
827
|
+
- lint检查通过
|
|
828
|
+
- 验收标准全部满足
|
|
829
|
+
- Knowledge References 已记录
|
|
830
|
+
|
|
831
|
+
完成提示: |
|
|
832
|
+
✅ 故事开发完成!
|
|
833
|
+
|
|
834
|
+
📄 故事文件: {story_path}
|
|
835
|
+
📊 任务完成: {completed_tasks}/{total_tasks}
|
|
836
|
+
🧪 测试状态: 全部通过
|
|
837
|
+
|
|
838
|
+
📚 知识引用:
|
|
839
|
+
- 编码规范: docs/rag/technical/coding-standards/
|
|
840
|
+
- 架构设计: docs/architecture-increment.md
|
|
841
|
+
- 中间件规范: {middleware_refs}
|
|
842
|
+
|
|
843
|
+
📁 文件变更:
|
|
844
|
+
- 新增: {new_files}
|
|
845
|
+
- 修改: {modified_files}
|
|
846
|
+
- 删除: {deleted_files}
|
|
847
|
+
|
|
848
|
+
🔄 下一步:
|
|
849
|
+
- QA审查: 请QA执行 *review-story
|
|
850
|
+
- 代码审查: 请进行代码评审
|
|
851
|
+
==================== END: .xiaoma-core/tasks/develop-story-with-rag.md ====================
|
|
852
|
+
|
|
249
853
|
==================== START: .xiaoma-core/tasks/execute-checklist.md ====================
|
|
250
854
|
<!-- Powered by XIAOMA™ Core -->
|
|
251
855
|
|