@zeyue0329/xiaoma-cli 1.0.46 → 1.0.48

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.
@@ -2944,206 +2944,880 @@ docs/rag/
2944
2944
  ==================== END: .xiaoma-core/tasks/generate-rag-questions.md ====================
2945
2945
 
2946
2946
  ==================== START: .xiaoma-core/tasks/requirement-analysis-with-rag.md ====================
2947
- <!-- Powered by XiaoMa™ Core -->
2948
-
2949
2947
  # 基于知识库的需求分析任务
2950
2948
 
2951
2949
  ## Purpose
2952
2950
 
2953
- 通过结合外部需求文档(req.txt)和知识库(RAG/MCP)进行深度需求分析,生成高质量的PRD文档。
2951
+ 通过结合外部需求文档(req.txt)和知识库(RAG/MCP)进行深度需求分析,输出结构化的需求分析报告,为后续PM智能体生成PRD提供完整输入。
2954
2952
 
2955
2953
  ## Workflow Overview
2956
2954
 
2957
2955
  ```
2958
- req.txt → 问题生成 → 知识库查询 → 知识落地(docs/rag/) → 需求分析 → PRD生成
2956
+ req.txt → 深度解析 → 问题生成 → 知识库查询 → 知识落地(docs/rag/) → 需求分析报告
2959
2957
  ```
2960
2958
 
2961
- ## Phase 1: 需求文档解析与问题生成
2959
+ ## 输出文件
2962
2960
 
2963
- ### 1.1 需求文档初步解析
2961
+ | 阶段 | 输出文件 | 路径 |
2962
+ |------|----------|------|
2963
+ | 需求解析 | 解析结果 | `docs/rag/_requirement-parsing.yaml` |
2964
+ | 问题生成 | 问题清单 | `docs/rag/_questions.md` |
2965
+ | 知识落地 | 知识索引 | `docs/rag/_index.md` |
2966
+ | 知识落地 | 分类知识 | `docs/rag/{category}/*.md` |
2967
+ | 需求分析 | 分析报告 | `docs/rag/_analysis-report.md` |
2964
2968
 
2965
- 首先读取并分析 req.txt 文档,识别以下关键信息:
2969
+ ## 职责边界
2966
2970
 
2967
2971
  ```yaml
2968
- 解析维度:
2969
- 业务领域: 识别需求所属的业务领域和子领域
2970
- 核心功能: 提取需求描述的主要功能点
2971
- 用户角色: 识别涉及的用户类型和角色
2972
- 业务流程: 提取隐含或显式的业务流程
2973
- 数据实体: 识别涉及的数据对象和关系
2974
- 集成点: 识别与外部系统的交互需求
2975
- 约束条件: 提取技术、业务、时间等约束
2976
- 模糊点: 标记需要澄清的不明确内容
2972
+ 本任务职责:
2973
+ - 需求文档深度解析
2974
+ - 知识库问题生成与查询
2975
+ - 知识文档落地与组织
2976
+ - 需求分析报告生成
2977
+
2978
+ 不在本任务职责范围:
2979
+ - PRD文档生成(由PM智能体负责)
2980
+ - 用户故事编写(由SM智能体负责)
2981
+ - 任务拆解与排期(由SM智能体负责)
2982
+
2983
+ 下游交接:
2984
+ 交接对象: PM智能体
2985
+ 交接物: docs/rag/ 目录下的完整知识文档和分析报告
2986
+ 交接命令: "*create-prd docs/rag/"
2977
2987
  ```
2978
2988
 
2979
- ### 1.2 知识库问题生成框架
2989
+ ---
2980
2990
 
2981
- 基于解析结果,生成以下类别的问题向知识库查询:
2991
+ ## Phase 1: 需求文档深度解析
2982
2992
 
2983
- ---
2993
+ ### 1.1 环境准备
2994
+
2995
+ ```yaml
2996
+ 执行动作:
2997
+ - 检查需求文档 {req_file} 是否存在
2998
+ - 创建 docs/rag/ 目录结构(如不存在)
2999
+ - 如目录已存在,询问用户是否覆盖
3000
+ ```
3001
+
3002
+ ### 1.2 需求文档深度解析
3003
+
3004
+ 读取并分析需求文档,提取以下关键信息:
3005
+
3006
+ ```yaml
3007
+ 解析维度:
2984
3008
 
2985
- ## Phase 2: 知识库提问清单模板
3009
+ 业务领域:
3010
+ - 主领域: 需求所属的业务领域(如:订单管理、用户管理、支付系统)
3011
+ - 子领域: 涉及的子模块或子系统
3012
+
3013
+ 功能点:
3014
+ - 功能名称: 具体功能的名称
3015
+ - 功能描述: 功能的详细描述
3016
+ - 输入: 功能的输入数据
3017
+ - 输出: 功能的输出数据
3018
+ - 涉及实体: 功能涉及的数据实体
3019
+
3020
+ 用户角色:
3021
+ - 角色名称: 用户类型
3022
+ - 操作列表: 该角色可执行的操作
3023
+ - 权限级别: 角色的权限范围
3024
+
3025
+ 数据实体:
3026
+ - 实体名称: 数据对象名称
3027
+ - 属性列表: 实体包含的属性
3028
+ - 关系定义:
3029
+ - 目标实体: 关联的实体
3030
+ - 关系类型: 一对一/一对多/多对一/多对多
3031
+ - 关联字段: 建立关联的字段
3032
+ - 关联规则: 关联的业务规则
2986
3033
 
2987
- ### 类别 A: 业务知识查询
3034
+ 业务流程:
3035
+ - 流程名称: 业务流程的名称
3036
+ - 触发条件: 流程的启动条件
3037
+ - 步骤详情:
3038
+ - 序号: 步骤顺序
3039
+ - 名称: 步骤名称
3040
+ - 执行者: 系统自动/人工操作/外部系统
3041
+ - 前置步骤: 依赖的上一个步骤
3042
+ - 触发条件: 从前置步骤到本步骤的触发条件
3043
+ - 输入数据: 本步骤的输入
3044
+ - 输出数据: 本步骤的输出
3045
+ - 数据变更: 本步骤对数据的修改
3046
+ - 异常分支: 异常情况的处理分支
2988
3047
 
2989
- #### A1. 业务领域背景
3048
+ 技术组件:
3049
+ - 组件名称: 需求中提及的技术组件(消息队列、缓存、定时任务等)
3050
+ - 用途描述: 组件的使用目的
3051
+
3052
+ 集成点:
3053
+ - 外部系统: 需要集成的外部系统
3054
+ - 集成方式: API/MQ/文件等
3055
+
3056
+ 约束条件:
3057
+ - 技术约束: 技术栈限制
3058
+ - 业务约束: 业务规则限制
3059
+ - 时间约束: 时间要求
3060
+
3061
+ 模糊点:
3062
+ - 位置: 模糊内容在文档中的位置
3063
+ - 内容: 模糊的具体内容
3064
+ - 可能理解: 多种可能的理解方式
2990
3065
  ```
3066
+
3067
+ **交互点**: 展示解析结果,保存到 `docs/rag/_requirement-parsing.yaml`,请用户确认或补充
3068
+
3069
+ ---
3070
+
3071
+ ## Phase 2: 知识库问题生成
3072
+
3073
+ 基于解析结果,生成结构化的知识库查询问题。
3074
+
3075
+ ### 类别 A: 业务知识问题
3076
+
3077
+ #### A1. 业务规则详解 (P0)
3078
+
3079
+ ```yaml
2991
3080
  问题模板:
2992
- - "关于[业务领域],现有系统中有哪些相关的业务规则和约束?"
2993
- - "[业务流程名称]的完整流程是什么?包括哪些步骤和参与者?"
2994
- - "在[业务场景]中,有哪些已知的边界情况和异常处理逻辑?"
2995
- - "[业务概念A]和[业务概念B]之间的关系是什么?"
3081
+ - question: "[{entity}]实体有哪些业务规则?"
3082
+ sub_questions:
3083
+ - "状态有哪些?状态流转规则是什么?哪些状态可以互相转换?"
3084
+ - "必填字段有哪些?每个必填字段的校验规则是什么?"
3085
+ - "字段的取值范围和格式要求是什么?"
3086
+ - "是否有唯一性约束?唯一性的范围是什么(全局/租户/用户)?"
3087
+ - "是否有软删除?软删除的业务规则是什么?"
3088
+ - "创建/修改/删除操作的前置条件是什么?"
3089
+
3090
+ - question: "[{entity}]和[{related_entity}]之间的业务关联规则是什么?"
3091
+ sub_questions:
3092
+ - "关联关系的业务含义是什么?"
3093
+ - "关联是否必须存在?可以为空吗?"
3094
+ - "删除主实体时,关联实体如何处理?(级联删除/置空/禁止删除)"
3095
+ - "关联实体的生命周期如何与主实体绑定?"
3096
+
3097
+ - question: "[{role}]角色在[{operation}]操作上的权限规则是什么?"
3098
+ sub_questions:
3099
+ - "该角色可以操作哪些数据范围?(全部/本部门/本人)"
3100
+ - "操作需要哪些前置审批或确认?"
3101
+ - "操作是否有时间窗口限制?"
3102
+ - "操作失败时的提示信息应该是什么?"
2996
3103
  ```
2997
3104
 
2998
- #### A2. 现有功能调研
2999
- ```
3105
+ #### A2. 业务流程详解 (P0)
3106
+
3107
+ ```yaml
3000
3108
  问题模板:
3001
- - "系统中是否已存在类似[功能描述]的功能?如果有,实现方式是什么?"
3002
- - "[模块名称]目前支持哪些操作?有什么限制?"
3003
- - "用户当前如何完成[业务目标]?现有流程有什么痛点?"
3109
+ - question: "[{process}]业务流程的完整定义是什么?"
3110
+ sub_questions:
3111
+ - "流程的触发条件是什么?由谁/什么事件触发?"
3112
+ - "流程的正常结束条件是什么?"
3113
+ - "流程的异常结束条件有哪些?"
3114
+ - "流程是否支持取消/撤销?取消后如何回滚?"
3115
+ - "流程的超时处理机制是什么?"
3116
+
3117
+ - question: "[{process}]流程中,步骤[{step_a}]到步骤[{step_b}]的详细信息?"
3118
+ sub_questions:
3119
+ - "从[{step_a}]到[{step_b}]的触发条件是什么?"
3120
+ - "[{step_a}]完成后,需要传递哪些数据给[{step_b}]?"
3121
+ - "数据传递的格式和校验规则是什么?"
3122
+ - "[{step_a}]失败时,是否阻塞[{step_b}]?还是走其他分支?"
3123
+ - "这两个步骤之间是否有时间约束?(如必须在N分钟内完成)"
3124
+
3125
+ - question: "[{process}]流程的第[{n}]个步骤[{step_name}]的详细执行逻辑是什么?"
3126
+ sub_questions:
3127
+ - "该步骤的执行者是谁?(系统自动/人工操作/外部系统)"
3128
+ - "该步骤的输入数据有哪些?数据来源是什么?"
3129
+ - "该步骤的处理逻辑是什么?涉及哪些业务规则?"
3130
+ - "该步骤会产生/修改哪些数据?"
3131
+ - "该步骤完成的标志是什么?如何判定成功/失败?"
3132
+ - "该步骤失败后的重试机制是什么?"
3133
+ - "该步骤是否需要记录日志/审计?记录哪些信息?"
3134
+
3135
+ - question: "[{process}]流程中有哪些并行/分支节点?"
3136
+ sub_questions:
3137
+ - "哪些步骤可以并行执行?并行执行的条件是什么?"
3138
+ - "并行步骤的汇合点在哪里?汇合的条件是什么(全部完成/任一完成)?"
3139
+ - "有哪些条件分支?每个分支的触发条件是什么?"
3140
+ - "分支是否会重新汇合?汇合点在哪里?"
3141
+
3142
+ - question: "[{process}]流程的异常处理机制是什么?"
3143
+ sub_questions:
3144
+ - "每个步骤可能出现的异常有哪些?"
3145
+ - "异常发生后的处理策略是什么?(重试/跳过/终止/人工处理)"
3146
+ - "异常是否需要通知?通知谁?通知方式是什么?"
3147
+ - "流程中断后如何恢复?是否支持断点续传?"
3004
3148
  ```
3005
3149
 
3006
- #### A3. 业务规则确认
3150
+ #### A3. 数据关联关系详解 (P0)
3151
+
3152
+ ```yaml
3153
+ 问题模板:
3154
+ - question: "[{entity_a}]和[{entity_b}]的数据关联关系详情?"
3155
+ sub_questions:
3156
+ - "关联类型是什么?(一对一/一对多/多对一/多对多)"
3157
+ - "关联是通过什么字段建立的?外键在哪一方?"
3158
+ - "关联是否必须?能否存在孤立记录?"
3159
+ - "关联的建立时机是什么?创建时/后续关联?"
3160
+ - "关联可以修改吗?修改的业务场景是什么?"
3161
+ - "解除关联的条件是什么?解除后数据如何处理?"
3162
+
3163
+ - question: "[{entity}]的一对多关联详情?"
3164
+ sub_questions:
3165
+ - "一个[{entity}]最多可以关联多少个[{related_entity}]?"
3166
+ - "是否有最小关联数量要求?"
3167
+ - "关联顺序是否重要?如何维护顺序?"
3168
+ - "批量添加/删除关联的业务规则是什么?"
3169
+
3170
+ - question: "[{entity}]涉及的多对多关联详情?"
3171
+ sub_questions:
3172
+ - "多对多关联是否有中间表?中间表存储哪些额外信息?"
3173
+ - "关联的创建和删除权限由谁控制?"
3174
+ - "关联是否有时效性?过期如何处理?"
3007
3175
  ```
3176
+
3177
+ #### A4. 边界情况与异常处理 (P1)
3178
+
3179
+ ```yaml
3008
3180
  问题模板:
3009
- - "[数据实体]的业务规则有哪些?例如:必填字段、取值范围、状态流转规则"
3010
- - "[操作A]在什么条件下可以执行?有哪些前置条件?"
3011
- - "不同[用户角色]在[功能]上的权限差异是什么?"
3181
+ - question: "[{operation}]操作的边界情况有哪些?"
3182
+ sub_questions:
3183
+ - "并发执行时如何处理?是否需要加锁?锁的粒度是什么?"
3184
+ - "数据不存在时如何处理?"
3185
+ - "数据已被其他操作锁定时如何处理?"
3186
+ - "操作超时时如何处理?"
3187
+ - "部分成功时如何处理?是否支持事务回滚?"
3188
+
3189
+ - question: "[{entity}]数据量很大时的处理规则?"
3190
+ sub_questions:
3191
+ - "列表查询的分页规则是什么?默认每页多少条?最大每页多少条?"
3192
+ - "是否支持批量操作?批量操作的最大数量是多少?"
3193
+ - "大数据量导出的限制是什么?是否需要异步处理?"
3194
+ - "历史数据的归档策略是什么?"
3012
3195
  ```
3013
3196
 
3014
3197
  ---
3015
3198
 
3016
- ### 类别 B: 技术知识查询
3199
+ ### 类别 B: 技术知识问题
3017
3200
 
3018
- #### B1. 系统架构
3019
- ```
3201
+ #### B1. 整体项目技术架构 (P0)
3202
+
3203
+ ```yaml
3020
3204
  问题模板:
3021
- - "现有系统的技术架构是什么?使用了哪些核心框架和技术栈?"
3022
- - "[模块名称]的代码结构和目录组织是怎样的?"
3023
- - "系统的数据库设计采用什么模式?主要的数据表有哪些?"
3024
- - "系统中有哪些公共组件和工具类可以复用?"
3205
+ - question: "项目的整体技术架构是什么?"
3206
+ sub_questions:
3207
+ - "项目采用什么架构模式?(单体/微服务/SOA/DDD)"
3208
+ - "系统分为哪些层次?每层的职责是什么?"
3209
+ - "各层之间如何交互?调用方式是什么?"
3210
+ - "请提供架构图或架构说明文档"
3211
+
3212
+ - question: "项目的技术栈详情是什么?"
3213
+ sub_questions:
3214
+ - "后端框架:使用什么框架?版本是多少?(如Spring Boot版本)"
3215
+ - "数据库:使用什么数据库?版本是多少?是否有读写分离?"
3216
+ - "缓存:使用什么缓存?(Redis/Memcached等)版本是多少?"
3217
+ - "消息队列:使用什么MQ?(RabbitMQ/Kafka/RocketMQ等)版本是多少?"
3218
+ - "搜索引擎:是否使用?使用什么?(Elasticsearch等)"
3219
+ - "文件存储:使用什么存储?(本地/OSS/MinIO等)"
3220
+ - "日志系统:使用什么日志框架和日志收集系统?"
3221
+ - "监控系统:使用什么监控?(Prometheus/Grafana等)"
3222
+
3223
+ - question: "项目的模块划分是什么?"
3224
+ sub_questions:
3225
+ - "项目包含哪些Maven模块?各模块的职责是什么?"
3226
+ - "模块之间的依赖关系是什么?"
3227
+ - "公共模块有哪些?提供什么能力?"
3228
+ - "请提供模块结构图或模块说明"
3229
+
3230
+ - question: "项目的包结构规范是什么?"
3231
+ sub_questions:
3232
+ - "Controller层的包路径和命名规范?"
3233
+ - "Application层的包路径和命名规范?"
3234
+ - "Service层的包路径和命名规范?"
3235
+ - "DAO/Repository层的包路径和命名规范?"
3236
+ - "Entity/Model层的包路径和命名规范?"
3237
+ - "DTO/VO层的包路径和命名规范?"
3238
+ - "工具类的包路径和命名规范?"
3239
+ - "配置类的包路径和命名规范?"
3240
+ - "请提供包结构示例"
3025
3241
  ```
3026
3242
 
3027
- #### B2. 接口与集成
3243
+ #### B2. 中间件使用规范 (P0) - 要求提供代码Demo
3244
+
3245
+ ```yaml
3246
+ 问题模板:
3247
+ - question: "项目中Redis的使用规范是什么?"
3248
+ sub_questions:
3249
+ - "Redis的连接配置在哪里?如何获取RedisTemplate?"
3250
+ - "Key的命名规范是什么?前缀规则是什么?"
3251
+ - "不同业务场景使用哪种数据结构?(String/Hash/List/Set/ZSet)"
3252
+ - "缓存的过期时间策略是什么?"
3253
+ - "如何处理缓存穿透、缓存击穿、缓存雪崩?"
3254
+ - "分布式锁如何实现?使用什么工具?(Redisson等)"
3255
+ code_examples_required:
3256
+ - "字符串缓存的存取示例"
3257
+ - "Hash结构的存取示例"
3258
+ - "分布式锁的使用示例"
3259
+ - "缓存注解(@Cacheable等)的使用示例"
3260
+
3261
+ - question: "项目中消息队列的使用规范是什么?"
3262
+ sub_questions:
3263
+ - "使用什么消息队列?配置在哪里?"
3264
+ - "Topic的命名规范是什么?"
3265
+ - "Queue的命名规范是什么?"
3266
+ - "消息体的格式规范是什么?(JSON结构定义)"
3267
+ - "消息的可靠性如何保证?(确认机制、持久化、重试)"
3268
+ - "消费者的幂等性如何保证?"
3269
+ - "死信队列如何处理?"
3270
+ code_examples_required:
3271
+ - "生产者发送消息的示例"
3272
+ - "消费者接收消息的示例"
3273
+ - "延迟消息的发送示例"
3274
+ - "消息确认和重试的示例"
3275
+
3276
+ - question: "项目中定时任务的使用规范是什么?"
3277
+ sub_questions:
3278
+ - "使用什么定时任务框架?(Spring @Scheduled/XXL-Job/Quartz等)"
3279
+ - "定时任务的配置在哪里?"
3280
+ - "分布式环境下如何保证任务只执行一次?"
3281
+ - "任务执行失败如何处理?是否有重试机制?"
3282
+ - "任务执行日志如何记录?"
3283
+ code_examples_required:
3284
+ - "简单定时任务的定义示例"
3285
+ - "带参数定时任务的示例"
3286
+ - "分布式锁定时任务的示例"
3287
+
3288
+ - question: "项目中Elasticsearch的使用规范是什么?(如果使用)"
3289
+ sub_questions:
3290
+ - "ES的连接配置在哪里?"
3291
+ - "索引的命名规范是什么?"
3292
+ - "Mapping的定义规范是什么?"
3293
+ - "数据同步策略是什么?(同步/异步/Canal等)"
3294
+ code_examples_required:
3295
+ - "索引创建的示例"
3296
+ - "文档的CRUD示例"
3297
+ - "复杂查询的示例"
3298
+
3299
+ - question: "项目中文件存储的使用规范是什么?"
3300
+ sub_questions:
3301
+ - "使用什么文件存储?配置在哪里?"
3302
+ - "文件路径/Key的命名规范是什么?"
3303
+ - "文件大小限制是什么?"
3304
+ - "支持哪些文件类型?"
3305
+ - "文件访问权限如何控制?"
3306
+ code_examples_required:
3307
+ - "文件上传的代码示例"
3308
+ - "文件下载的代码示例"
3309
+
3310
+ - question: "项目中是否使用其他中间件?使用规范是什么?"
3311
+ sub_questions:
3312
+ - "是否使用分布式配置中心?(Nacos/Apollo等)如何使用?"
3313
+ - "是否使用服务注册发现?如何使用?"
3314
+ - "是否使用链路追踪?如何使用?"
3315
+ - "是否使用限流熔断?(Sentinel等)如何使用?"
3316
+ code_examples_required:
3317
+ - "配置读取的示例"
3318
+ - "服务调用的示例"
3319
+ - "限流配置的示例"
3028
3320
  ```
3321
+
3322
+ #### B3. Java编码规范 (P0)
3323
+
3324
+ ```yaml
3029
3325
  问题模板:
3030
- - "与[外部系统]的集成接口是什么?数据格式和协议是什么?"
3031
- - "系统提供了哪些API接口?[功能相关]的接口规范是什么?"
3032
- - "现有的消息队列/事件机制是如何设计的?"
3326
+ - question: "项目的Java编码规范是什么?"
3327
+ sub_questions:
3328
+ - "遵循什么编码规范?(阿里巴巴规范/Google规范/自定义)"
3329
+ - "是否有规范文档?请提供链接或内容"
3330
+
3331
+ - question: "类和接口的命名规范是什么?"
3332
+ sub_questions:
3333
+ - "Controller类的命名规范?后缀是什么?"
3334
+ - "Service接口和实现类的命名规范?"
3335
+ - "DAO/Mapper/Repository的命名规范?"
3336
+ - "Entity/PO的命名规范?"
3337
+ - "DTO的命名规范?请求和响应如何区分?"
3338
+ - "VO的命名规范?"
3339
+ - "枚举类的命名规范?"
3340
+ - "常量类的命名规范?"
3341
+ - "工具类的命名规范?"
3342
+ - "异常类的命名规范?"
3343
+ code_examples_required:
3344
+ - "各类型的命名示例"
3345
+
3346
+ - question: "方法的命名规范是什么?"
3347
+ sub_questions:
3348
+ - "查询单个对象的方法命名?(get/find/query/select)"
3349
+ - "查询列表的方法命名?"
3350
+ - "查询分页的方法命名?"
3351
+ - "新增的方法命名?(add/insert/create/save)"
3352
+ - "修改的方法命名?(update/modify/edit)"
3353
+ - "删除的方法命名?(delete/remove)"
3354
+ - "批量操作的方法命名?"
3355
+ - "布尔判断的方法命名?(is/has/can/should)"
3356
+ code_examples_required:
3357
+ - "方法命名示例"
3358
+
3359
+ - question: "注释规范是什么?"
3360
+ sub_questions:
3361
+ - "类注释的格式要求?必须包含哪些内容?"
3362
+ - "方法注释的格式要求?参数和返回值如何描述?"
3363
+ - "字段注释的格式要求?"
3364
+ - "是否使用Swagger注解?格式要求是什么?"
3365
+ - "TODO/FIXME注释的格式要求?"
3366
+ code_examples_required:
3367
+ - "注释示例"
3368
+
3369
+ - question: "异常处理规范是什么?"
3370
+ sub_questions:
3371
+ - "项目有哪些自定义异常类?何时使用?"
3372
+ - "异常应该在哪一层捕获和处理?"
3373
+ - "业务异常和系统异常如何区分?"
3374
+ - "异常信息如何记录日志?"
3375
+ - "全局异常处理器是如何实现的?"
3376
+ code_examples_required:
3377
+ - "异常处理的代码示例"
3378
+
3379
+ - question: "日志打印规范是什么?"
3380
+ sub_questions:
3381
+ - "使用什么日志框架?(SLF4J+Logback等)"
3382
+ - "不同级别日志(DEBUG/INFO/WARN/ERROR)的使用场景?"
3383
+ - "日志内容应该包含哪些信息?"
3384
+ - "敏感信息如何脱敏?"
3385
+ - "请求入参出参如何记录?"
3386
+ code_examples_required:
3387
+ - "日志打印的代码示例"
3388
+
3389
+ - question: "Controller层的编码规范是什么?"
3390
+ sub_questions:
3391
+ - "URL路径的命名规范?RESTful还是其他风格?"
3392
+ - "请求方法的使用规范?(GET/POST/PUT/DELETE)"
3393
+ - "参数接收方式的规范?(@RequestParam/@RequestBody/@PathVariable)"
3394
+ - "响应格式的统一规范?"
3395
+ - "参数校验如何实现?使用什么注解?"
3396
+ code_examples_required:
3397
+ - "Controller的代码模板"
3398
+
3399
+ - question: "Service层的编码规范是什么?"
3400
+ sub_questions:
3401
+ - "是否必须定义接口?接口和实现类的关系?"
3402
+ - "事务注解如何使用?事务传播行为如何选择?"
3403
+ - "Service之间如何调用?是否允许循环依赖?"
3404
+ - "复杂业务逻辑如何拆分?"
3405
+ code_examples_required:
3406
+ - "Service的代码模板"
3407
+
3408
+ - question: "DAO层的编码规范是什么?"
3409
+ sub_questions:
3410
+ - "使用什么ORM框架?(MyBatis/MyBatis-Plus/JPA等)"
3411
+ - "Mapper接口的编写规范?"
3412
+ - "XML文件还是注解方式?"
3413
+ - "动态SQL的编写规范?"
3414
+ code_examples_required:
3415
+ - "DAO的代码模板"
3033
3416
  ```
3034
3417
 
3035
- #### B3. 数据模型
3418
+ #### B4. SQL规范 (P0)
3419
+
3420
+ ```yaml
3421
+ 问题模板:
3422
+ - question: "项目的SQL编写规范是什么?"
3423
+ sub_questions:
3424
+ - "是否有SQL规范文档?请提供链接或内容"
3425
+
3426
+ - question: "表设计规范是什么?"
3427
+ sub_questions:
3428
+ - "表名的命名规范?前缀规则?"
3429
+ - "字段名的命名规范?(驼峰/下划线)"
3430
+ - "主键的设计规范?(自增/UUID/雪花ID)"
3431
+ - "是否必须有创建时间/更新时间/创建人/更新人字段?"
3432
+ - "是否必须有逻辑删除字段?"
3433
+ - "是否必须有版本号字段(乐观锁)?"
3434
+ - "字段类型的选择规范?"
3435
+ - "字段长度的设计规范?"
3436
+ - "索引的命名和设计规范?"
3437
+ code_examples_required:
3438
+ - "建表语句的模板"
3439
+
3440
+ - question: "SQL查询规范是什么?"
3441
+ sub_questions:
3442
+ - "SELECT是否禁止使用*?"
3443
+ - "WHERE条件的编写规范?"
3444
+ - "JOIN的使用规范?最多允许关联几张表?"
3445
+ - "子查询的使用规范?"
3446
+ - "ORDER BY的使用规范?"
3447
+ - "LIMIT的使用规范?深分页如何处理?"
3448
+ code_examples_required:
3449
+ - "查询SQL的示例"
3450
+
3451
+ - question: "SQL更新规范是什么?"
3452
+ sub_questions:
3453
+ - "UPDATE是否必须带WHERE条件?"
3454
+ - "批量更新的写法规范?"
3455
+ - "是否使用乐观锁?如何使用?"
3456
+ code_examples_required:
3457
+ - "更新SQL的示例"
3458
+
3459
+ - question: "SQL性能规范是什么?"
3460
+ sub_questions:
3461
+ - "索引的使用规范?如何避免索引失效?"
3462
+ - "大表查询的规范?"
3463
+ - "慢SQL的定义标准?如何优化?"
3464
+ - "EXPLAIN的使用规范?"
3465
+ code_examples_required:
3466
+ - "SQL优化的示例"
3036
3467
  ```
3468
+
3469
+ #### B5. 数据模型 (P0)
3470
+
3471
+ ```yaml
3037
3472
  问题模板:
3038
- - "[数据实体]在数据库中的表结构是什么?包含哪些字段?"
3039
- - "[实体A]和[实体B]之间的数据库关系是怎样的?"
3040
- - "系统中有哪些枚举值或字典表与[业务领域]相关?"
3473
+ - question: "[{entity}]对应的数据库表结构是什么?"
3474
+ sub_questions:
3475
+ - "表名是什么?"
3476
+ - "包含哪些字段?每个字段的类型、长度、约束?"
3477
+ - "主键是什么?主键生成策略是什么?"
3478
+ - "有哪些索引?索引类型是什么?"
3479
+ - "有哪些外键约束?(如果有)"
3480
+ code_examples_required:
3481
+ - "完整的DDL语句"
3482
+
3483
+ - question: "[{entity_a}]和[{entity_b}]的数据库关联设计是什么?"
3484
+ sub_questions:
3485
+ - "关联类型是什么?(一对一/一对多/多对多)"
3486
+ - "外键在哪张表?外键字段名是什么?"
3487
+ - "是否有中间表?中间表结构是什么?"
3488
+ code_examples_required:
3489
+ - "关联查询的示例SQL"
3490
+
3491
+ - question: "[{domain}]领域的ER图是什么?"
3492
+ sub_questions:
3493
+ - "涉及哪些表?"
3494
+ - "表之间的关系是什么?"
3495
+ - "请提供ER图或表关系说明"
3041
3496
  ```
3042
3497
 
3043
- #### B4. 代码实现参考
3498
+ #### B6. 接口规范 (P1)
3499
+
3500
+ ```yaml
3501
+ 问题模板:
3502
+ - question: "项目的API接口规范是什么?"
3503
+ sub_questions:
3504
+ - "API风格是什么?(RESTful/RPC/GraphQL)"
3505
+ - "URL设计规范是什么?"
3506
+ - "版本控制如何实现?"
3507
+ - "认证授权如何实现?"
3508
+ - "请提供API设计规范文档"
3509
+
3510
+ - question: "接口请求规范是什么?"
3511
+ sub_questions:
3512
+ - "请求头的规范?必须包含哪些Header?"
3513
+ - "请求体的格式?(JSON/Form)"
3514
+ - "分页参数的规范?参数名是什么?"
3515
+ - "排序参数的规范?"
3516
+ code_examples_required:
3517
+ - "请求示例"
3518
+
3519
+ - question: "接口响应规范是什么?"
3520
+ sub_questions:
3521
+ - "统一响应格式是什么?包含哪些字段?"
3522
+ - "成功响应的格式?"
3523
+ - "错误响应的格式?"
3524
+ - "分页响应的格式?"
3525
+ - "错误码的设计规范?"
3526
+ code_examples_required:
3527
+ - "响应示例"
3528
+
3529
+ - question: "现有的[{module}]模块提供了哪些API接口?"
3530
+ sub_questions:
3531
+ - "接口列表是什么?"
3532
+ - "每个接口的URL、方法、参数、响应是什么?"
3533
+ - "请提供Swagger文档或接口文档链接"
3044
3534
  ```
3535
+
3536
+ #### B7. 代码实现模式 (P1)
3537
+
3538
+ ```yaml
3045
3539
  问题模板:
3046
- - "类似[功能]的实现在代码中是如何组织的?请提供示例代码位置"
3047
- - "[技术方案]在现有代码中有没有参考实现?"
3048
- - "系统中处理[技术问题]的通用模式是什么?"
3540
+ - question: "项目中通用的CRUD实现模式是什么?"
3541
+ sub_questions:
3542
+ - "是否有通用的BaseController/BaseService?"
3543
+ - "是否使用代码生成器?如何使用?"
3544
+ code_examples_required:
3545
+ - "标准CRUD的代码示例"
3546
+
3547
+ - question: "项目中分页查询的实现模式是什么?"
3548
+ sub_questions:
3549
+ - "使用什么分页插件?(PageHelper/MyBatis-Plus等)"
3550
+ - "分页参数如何接收?"
3551
+ - "分页结果如何封装?"
3552
+ code_examples_required:
3553
+ - "分页查询的代码示例"
3554
+
3555
+ - question: "项目中复杂查询的实现模式是什么?"
3556
+ sub_questions:
3557
+ - "多条件动态查询如何实现?"
3558
+ - "多表关联查询如何实现?"
3559
+ code_examples_required:
3560
+ - "复杂查询的代码示例"
3561
+
3562
+ - question: "项目中事务处理的实现模式是什么?"
3563
+ sub_questions:
3564
+ - "本地事务如何使用?"
3565
+ - "分布式事务如何处理?使用什么方案?"
3566
+ code_examples_required:
3567
+ - "事务处理的代码示例"
3568
+
3569
+ - question: "项目中有哪些通用工具类?"
3570
+ sub_questions:
3571
+ - "日期时间处理工具类?"
3572
+ - "字符串处理工具类?"
3573
+ - "JSON处理工具类?"
3574
+ - "加密解密工具类?"
3575
+ - "文件处理工具类?"
3576
+ - "HTTP请求工具类?"
3577
+ code_examples_required:
3578
+ - "工具类的使用示例"
3049
3579
  ```
3050
3580
 
3051
3581
  ---
3052
3582
 
3053
- ### 类别 C: 历史需求与变更
3583
+ ### 类别 C: 历史追溯问题
3054
3584
 
3055
- #### C1. 相关需求追溯
3056
- ```
3585
+ #### C1. 历史需求 (P1)
3586
+
3587
+ ```yaml
3057
3588
  问题模板:
3058
- - "之前有没有类似[需求描述]的需求?实现情况如何?"
3059
- - "[功能模块]的历史变更记录有哪些?最近的改动是什么?"
3060
- - "有没有与[需求]相关的已知问题或技术债务?"
3589
+ - question: "之前有没有类似[{feature}]的需求?"
3590
+ sub_questions:
3591
+ - "实现情况如何?是否上线?"
3592
+ - "实现过程中遇到了什么问题?"
3593
+ - "有什么经验教训可以借鉴?"
3594
+ - "相关代码在哪里?"
3595
+
3596
+ - question: "[{module}]模块最近有什么变更?"
3597
+ sub_questions:
3598
+ - "变更的内容是什么?"
3599
+ - "变更的原因是什么?"
3600
+ - "变更后是否有问题?"
3061
3601
  ```
3062
3602
 
3063
- #### C2. 决策记录
3603
+ #### C2. 决策记录 (P2)
3604
+
3605
+ ```yaml
3606
+ 问题模板:
3607
+ - question: "[{technical_choice}]为什么选择当前的实现方式?"
3608
+ sub_questions:
3609
+ - "决策的背景是什么?"
3610
+ - "考虑过哪些备选方案?"
3611
+ - "选择当前方案的理由是什么?"
3612
+ - "这个决策有什么限制或trade-off?"
3064
3613
  ```
3614
+
3615
+ #### C3. 已知问题 (P1)
3616
+
3617
+ ```yaml
3065
3618
  问题模板:
3066
- - "[技术方案]为什么选择了当前的实现方式?有什么历史背景?"
3067
- - "[设计决策]有没有相关的ADR(架构决策记录)?"
3619
+ - question: "[{module}]模块有哪些已知的问题或技术债务?"
3620
+ sub_questions:
3621
+ - "问题的具体描述是什么?"
3622
+ - "问题的影响范围是什么?"
3623
+ - "是否有计划修复?"
3624
+ - "新功能开发需要注意什么?"
3068
3625
  ```
3069
3626
 
3070
3627
  ---
3071
3628
 
3072
- ### 类别 D: 上下文与约束
3629
+ ### 类别 D: 约束条件问题
3073
3630
 
3074
- #### D1. 项目约束
3631
+ #### D1. 技术约束 (P1)
3632
+
3633
+ ```yaml
3634
+ 问题模板:
3635
+ - question: "项目的技术栈限制有哪些?"
3636
+ sub_questions:
3637
+ - "必须使用什么框架/库?不能使用什么?"
3638
+ - "JDK版本要求是什么?"
3639
+ - "是否有第三方库的版本要求?"
3640
+ - "是否有禁止使用的技术或方案?"
3641
+
3642
+ - question: "[{technical_approach}]方案在当前技术栈下是否可行?"
3643
+ sub_questions:
3644
+ - "是否与现有技术兼容?"
3645
+ - "是否需要引入新的依赖?"
3646
+ - "团队是否有相关经验?"
3075
3647
  ```
3648
+
3649
+ #### D2. 安全合规 (P0)
3650
+
3651
+ ```yaml
3076
3652
  问题模板:
3077
- - "项目的技术栈限制有哪些?必须遵循的技术规范是什么?"
3078
- - "项目的安全合规要求有哪些?"
3079
- - "项目的性能要求和SLA标准是什么?"
3653
+ - question: "[{data_type}]数据的安全要求是什么?"
3654
+ sub_questions:
3655
+ - "数据的敏感级别是什么?"
3656
+ - "存储时是否需要加密?用什么算法?"
3657
+ - "传输时是否需要加密?"
3658
+ - "是否需要脱敏?脱敏规则是什么?"
3659
+ - "数据的访问权限如何控制?"
3660
+ - "数据的保留期限是多久?"
3661
+
3662
+ - question: "项目的安全规范是什么?"
3663
+ sub_questions:
3664
+ - "SQL注入如何防范?"
3665
+ - "XSS如何防范?"
3666
+ - "CSRF如何防范?"
3667
+ - "接口防刷如何实现?"
3668
+ - "敏感操作是否需要二次确认?"
3669
+
3670
+ - question: "项目需要满足哪些合规要求?"
3671
+ sub_questions:
3672
+ - "是否需要满足等保要求?什么级别?"
3673
+ - "是否涉及个人隐私数据?需要满足什么要求?"
3674
+ - "是否有审计日志要求?记录哪些内容?"
3080
3675
  ```
3081
3676
 
3082
- #### D2. 团队规范
3677
+ #### D3. 性能要求 (P1)
3678
+
3679
+ ```yaml
3680
+ 问题模板:
3681
+ - question: "项目的性能要求是什么?"
3682
+ sub_questions:
3683
+ - "接口响应时间要求?P99要求?"
3684
+ - "并发量要求?峰值并发是多少?"
3685
+ - "吞吐量要求?"
3686
+ - "可用性要求?99.9%还是99.99%?"
3687
+
3688
+ - question: "[{interface}]接口的性能要求是什么?"
3689
+ sub_questions:
3690
+ - "响应时间要求是多少?"
3691
+ - "预期的调用频率是多少?"
3692
+ - "是否需要限流?限流规则是什么?"
3083
3693
  ```
3694
+
3695
+ #### D4. 团队规范 (P2)
3696
+
3697
+ ```yaml
3084
3698
  问题模板:
3085
- - "团队的代码规范和开发流程是什么?"
3086
- - "团队的测试要求和代码审查标准是什么?"
3087
- - "项目的部署流程和环境配置是怎样的?"
3699
+ - question: "团队的开发流程是什么?"
3700
+ sub_questions:
3701
+ - "分支管理策略是什么?(GitFlow等)"
3702
+ - "代码审查流程是什么?"
3703
+ - "上线流程是什么?"
3704
+ - "环境有哪些?(dev/test/staging/prod)"
3705
+
3706
+ - question: "团队的测试要求是什么?"
3707
+ sub_questions:
3708
+ - "单元测试覆盖率要求?"
3709
+ - "是否需要集成测试?"
3710
+ - "是否需要性能测试?"
3711
+ - "测试用例的编写规范?"
3088
3712
  ```
3089
3713
 
3090
3714
  ---
3091
3715
 
3092
3716
  ## Phase 3: 问题生成执行流程
3093
3717
 
3094
- ### 3.1 智能问题生成
3718
+ ### 3.1 执行步骤
3095
3719
 
3096
3720
  ```yaml
3097
3721
  执行步骤:
3098
3722
  步骤1_解析需求:
3099
3723
  输入: req.txt
3100
- 动作: 提取关键实体、流程、约束
3101
- 输出: 需求要素清单
3102
-
3103
- 步骤2_映射问题类别:
3104
- 输入: 需求要素清单
3105
- 动作: 将每个要素映射到问题类别(A/B/C/D)
3106
- 输出: 问题类别映射表
3107
-
3108
- 步骤3_生成具体问题:
3109
- 输入: 问题类别映射表 + 问题模板
3110
- 动作: 用具体内容填充模板生成问题
3111
- 输出: 知识库查询问题清单
3112
-
3113
- 步骤4_问题优先级排序:
3114
- 优先级规则:
3115
- P0_阻塞级: 缺失会导致无法理解需求的核心问题
3116
- P1_重要级: 影响需求完整性的问题
3117
- P2_补充级: 有助于优化实现的问题
3724
+ 动作: 按Phase 1要求深度解析需求文档
3725
+ 输出: docs/rag/_requirement-parsing.yaml
3726
+ 交互: 请用户确认解析结果
3727
+
3728
+ 步骤2_生成问题:
3729
+ 输入: 需求解析结果
3730
+ 动作: 根据Phase 2模板生成具体问题,填充实际内容
3731
+ 输出: 问题清单(含主问题和子问题)
3732
+ 交互: 请用户确认或调整问题
3733
+
3734
+ 步骤3_优先级排序:
3735
+ 输入: 问题清单
3736
+ 动作: 按P0/P1/P2规则排序
3737
+ 规则:
3738
+ P0_阻塞级:
3739
+ - 缺失会导致完全无法理解需求
3740
+ - 涉及核心业务规则和数据关联
3741
+ - 影响架构决策
3742
+ - 涉及安全合规
3743
+ P1_重要级:
3744
+ - 影响需求完整性
3745
+ - 涉及边界情况处理
3746
+ - 影响实现方案选择
3747
+ - 涉及性能要求
3748
+ P2_补充级:
3749
+ - 有助于优化实现
3750
+ - 提供额外上下文
3751
+ - 历史参考信息
3752
+ 输出: 排序后的问题清单
3753
+
3754
+ 步骤4_保存问题清单:
3755
+ 输入: 排序后的问题清单
3756
+ 动作: 保存到 docs/rag/_questions.md
3757
+ 输出: 问题清单文件
3758
+
3759
+ 步骤5_创建目录结构:
3760
+ 动作: 创建知识落地所需的目录
3761
+ 输出: docs/rag/ 目录结构
3118
3762
  ```
3119
3763
 
3120
3764
  ### 3.2 问题清单输出格式
3121
3765
 
3766
+ 保存到 `docs/rag/_questions.md`:
3767
+
3122
3768
  ```markdown
3123
3769
  # 知识库查询问题清单
3124
3770
 
3125
- ## 基本信息
3126
- - 需求文档: req.txt
3127
- - 生成时间: {{timestamp}}
3128
- - 问题总数: {{total_count}}
3771
+ ## 元信息
3772
+ - 源文档: {req_file}
3773
+ - 生成时间: {timestamp}
3774
+ - 总问题数: {total_count}
3775
+ - P0问题: {p0_count} | P1问题: {p1_count} | P2问题: {p2_count}
3776
+
3777
+ ---
3129
3778
 
3130
- ## P0 阻塞级问题 (必须回答)
3779
+ ## P0 阻塞级问题(必须回答)
3780
+
3781
+ ### A. 业务知识
3782
+
3783
+ #### 1. [A1-001] {问题标题}
3784
+ - **关联需求**: "{相关需求描述}"
3785
+ - **预期答案类型**: {答案类型}
3786
+ - **子问题**:
3787
+ - {子问题1}
3788
+ - {子问题2}
3789
+ - ...
3790
+
3791
+ ### B. 技术知识
3792
+
3793
+ #### 1. [B1-001] {问题标题}
3794
+ - **关联需求**: "{相关需求描述}"
3795
+ - **预期答案类型**: {答案类型}
3796
+ - **子问题**:
3797
+ - {子问题1}
3798
+ - {子问题2}
3799
+ - ...
3800
+ - **注意**: 请提供相关代码示例
3131
3801
 
3132
- ### 业务知识
3133
- 1. [A1-001] {{具体问题}}
3134
- - 关联需求点: {{需求中的相关描述}}
3135
- - 预期答案类型: {{期望获得的信息类型}}
3802
+ ---
3136
3803
 
3137
- ### 技术知识
3138
- 2. [B1-001] {{具体问题}}
3139
- - 关联需求点: {{需求中的相关描述}}
3140
- - 预期答案类型: {{期望获得的信息类型}}
3804
+ ## P1 重要级问题(强烈建议回答)
3141
3805
 
3142
- ## P1 重要级问题 (建议回答)
3143
3806
  ...
3144
3807
 
3145
- ## P2 补充级问题 (可选回答)
3808
+ ---
3809
+
3810
+ ## P2 补充级问题(可选回答)
3811
+
3146
3812
  ...
3813
+
3814
+ ---
3815
+
3816
+ ## 下一步操作指引
3817
+
3818
+ 1. **查询知识库**: 将上述问题发送给知识库MCP获取答案
3819
+ 2. **知识落地**: 使用 `*land-knowledge` 命令将答案保存到 `docs/rag/` 对应子目录
3820
+ 3. **生成PRD**: 使用 `*create-prd-from-rag` 命令基于知识生成PRD文档
3147
3821
  ```
3148
3822
 
3149
3823
  ---
@@ -3154,52 +3828,93 @@ req.txt → 问题生成 → 知识库查询 → 知识落地(docs/rag/) → 需
3154
3828
 
3155
3829
  ```
3156
3830
  docs/rag/
3157
- ├── _index.md # 知识索引文件
3831
+ ├── _index.md # 知识索引(自动生成)
3832
+ ├── _questions.md # 问题清单
3833
+ ├── _requirement-parsing.yaml # 需求解析结果
3834
+
3158
3835
  ├── business/ # 业务知识
3159
- │ ├── domain-rules.md # 业务规则
3160
- │ ├── processes.md # 业务流程
3161
- └── entities.md # 业务实体
3836
+ │ ├── domain-{domain}.md # 领域知识
3837
+ │ ├── rules-{topic}.md # 业务规则
3838
+ ├── process-{name}.md # 业务流程(含详细步骤和关联关系)
3839
+ │ ├── data-relations.md # 数据关联关系(一对一/一对多/多对多)
3840
+ │ └── roles.md # 角色权限
3841
+
3162
3842
  ├── technical/ # 技术知识
3163
- │ ├── architecture.md # 系统架构
3164
- │ ├── data-model.md # 数据模型
3165
- │ ├── apis.md # 接口规范
3166
- └── code-patterns.md # 代码模式
3843
+ │ ├── architecture.md # 整体技术架构
3844
+ │ ├── tech-stack.md # 技术栈详情
3845
+ │ ├── module-structure.md # 模块结构
3846
+ ├── middleware/ # 中间件规范(含代码Demo)
3847
+ │ │ ├── redis.md # Redis使用规范和代码示例
3848
+ │ │ ├── mq.md # 消息队列规范和代码示例
3849
+ │ │ ├── scheduler.md # 定时任务规范和代码示例
3850
+ │ │ ├── elasticsearch.md # ES规范和代码示例
3851
+ │ │ └── file-storage.md # 文件存储规范
3852
+ │ ├── coding-standards/ # 编码规范
3853
+ │ │ ├── java-naming.md # Java命名规范
3854
+ │ │ ├── java-coding.md # Java编码规范
3855
+ │ │ ├── exception.md # 异常处理规范
3856
+ │ │ ├── logging.md # 日志规范
3857
+ │ │ └── layer-standards.md # 分层规范(Controller/Service/DAO)
3858
+ │ ├── sql-standards/ # SQL规范
3859
+ │ │ ├── table-design.md # 表设计规范
3860
+ │ │ ├── query-standards.md # 查询规范
3861
+ │ │ └── performance.md # SQL性能规范
3862
+ │ ├── data-model.md # 数据模型(表结构)
3863
+ │ ├── api-{module}.md # 接口规范
3864
+ │ └── patterns.md # 代码模式和示例
3865
+
3167
3866
  ├── history/ # 历史信息
3168
- │ ├── related-requirements.md # 相关需求
3867
+ │ ├── related-features.md # 相关功能
3169
3868
  │ └── decisions.md # 决策记录
3869
+
3170
3870
  └── constraints/ # 约束条件
3171
3871
  ├── technical.md # 技术约束
3172
- └── compliance.md # 合规要求
3872
+ ├── security.md # 安全要求
3873
+ └── performance.md # 性能要求
3173
3874
  ```
3174
3875
 
3175
3876
  ### 4.2 知识文档格式
3176
3877
 
3177
3878
  ```markdown
3178
- # {{知识标题}}
3879
+ # {知识标题}
3179
3880
 
3180
3881
  ## 元信息
3181
- - 来源: 知识库MCP查询
3182
- - 查询问题: {{原始问题}}
3183
- - 查询时间: {{timestamp}}
3184
- - 置信度: {{high/medium/low}}
3882
+ - 查询问题: {原始问题}
3883
+ - 问题ID: {question_id}
3884
+ - 查询时间: {timestamp}
3885
+ - 数据来源: 知识库MCP
3185
3886
 
3186
3887
  ## 内容摘要
3187
- {{一句话总结}}
3888
+ {一句话总结}
3188
3889
 
3189
3890
  ## 详细内容
3190
- {{知识库返回的完整内容}}
3891
+ {知识库返回的完整内容}
3191
3892
 
3192
- ## 与需求的关联
3193
- - 关联需求点: {{req.txt中的相关内容}}
3194
- - 影响分析: {{这个知识如何影响需求实现}}
3893
+ ## 代码示例(如适用)
3195
3894
 
3196
- ## 后续问题
3197
- {{基于此知识产生的新问题(如有)}}
3895
+ ### {示例标题1}
3896
+ ```java
3897
+ {代码内容}
3898
+ ```
3899
+ **说明**: {代码说明}
3900
+
3901
+ ### {示例标题2}
3902
+ ```sql
3903
+ {SQL内容}
3904
+ ```
3905
+ **说明**: {SQL说明}
3906
+
3907
+ ## 需求关联
3908
+ - 关联需求点: {req.txt中的相关内容}
3909
+ - 影响分析: {这个知识如何影响需求实现}
3910
+
3911
+ ## 衍生问题
3912
+ {基于此知识产生的新问题(如有)}
3198
3913
  ```
3199
3914
 
3200
3915
  ---
3201
3916
 
3202
- ## Phase 5: 需求分析与PRD生成
3917
+ ## Phase 5: 需求分析报告生成
3203
3918
 
3204
3919
  ### 5.1 分析输入整合
3205
3920
 
@@ -3207,6 +3922,7 @@ docs/rag/
3207
3922
  分析输入:
3208
3923
  主要输入:
3209
3924
  - req.txt: 原始需求文档
3925
+ - docs/rag/_requirement-parsing.yaml: 需求解析结果
3210
3926
  - docs/rag/*: 知识库查询结果
3211
3927
  辅助输入:
3212
3928
  - 项目简报(如存在): docs/brief.md
@@ -3219,8 +3935,8 @@ docs/rag/
3219
3935
  分析维度:
3220
3936
  功能分析:
3221
3937
  - 核心功能拆解
3222
- - 功能优先级排序
3223
- - 功能依赖关系
3938
+ - 功能优先级排序(P0/P1/P2)
3939
+ - 功能依赖关系图
3224
3940
 
3225
3941
  用户分析:
3226
3942
  - 用户角色定义
@@ -3228,44 +3944,260 @@ docs/rag/
3228
3944
  - 用户价值主张
3229
3945
 
3230
3946
  技术分析:
3231
- - 技术可行性评估
3232
- - 与现有系统的兼容性
3233
- - 技术风险识别
3947
+ - 技术可行性评估(基于技术架构和编码规范)
3948
+ - 与现有系统的兼容性(基于中间件和数据模型)
3949
+ - 技术风险识别与评估
3234
3950
 
3235
3951
  业务分析:
3236
- - 业务规则验证
3952
+ - 业务规则验证(基于业务知识)
3237
3953
  - 业务流程优化机会
3238
3954
  - 业务价值量化
3239
3955
 
3956
+ 数据分析:
3957
+ - 数据实体关系验证
3958
+ - 数据模型兼容性
3959
+ - 数据迁移需求
3960
+
3240
3961
  差距分析:
3241
3962
  - 现有能力 vs 需求能力
3242
3963
  - 需要新增/修改的功能
3243
3964
  - 需要新增/修改的数据
3965
+
3966
+ 风险分析:
3967
+ - 技术风险清单
3968
+ - 业务风险清单
3969
+ - 依赖风险清单
3970
+ - 风险缓解建议
3244
3971
  ```
3245
3972
 
3246
- ### 5.3 PRD生成流程
3973
+ ### 5.3 需求分析报告生成流程
3247
3974
 
3248
3975
  ```yaml
3249
- PRD生成:
3976
+ 报告生成:
3250
3977
  步骤1:
3251
3978
  动作: 整合所有知识输入
3979
+ 输入: docs/rag/ 目录下的所有知识文件
3252
3980
  输出: 知识上下文汇总
3253
3981
 
3254
3982
  步骤2:
3255
- 动作: 执行需求分析(5.2维度)
3256
- 输出: 需求分析报告
3983
+ 动作: 执行多维度需求分析(5.2)
3984
+ 输出: 各维度分析结论
3257
3985
 
3258
3986
  步骤3:
3259
- 动作: 套用PRD模板(prd-tmpl.yaml)
3260
- 输出: PRD草稿
3987
+ 动作: 识别待澄清问题
3988
+ 输出: 待确认事项清单
3261
3989
 
3262
3990
  步骤4:
3263
- 动作: 启发式验证(advanced-elicitation)
3264
- 输出: 优化后的PRD
3991
+ 动作: 生成需求分析报告
3992
+ 输出: docs/rag/_analysis-report.md
3265
3993
 
3266
3994
  步骤5:
3267
- 动作: 输出最终PRD到指定位置
3268
- 输出: docs/prd.md
3995
+ 动作: 更新知识索引
3996
+ 输出: docs/rag/_index.md (更新)
3997
+ ```
3998
+
3999
+ ### 5.4 需求分析报告模板
4000
+
4001
+ 保存到 `docs/rag/_analysis-report.md`:
4002
+
4003
+ ```markdown
4004
+ # 需求分析报告
4005
+
4006
+ ## 元信息
4007
+ - 源需求文档: {req_file}
4008
+ - 分析时间: {timestamp}
4009
+ - 分析师: Analyst Agent
4010
+ - 报告版本: 1.0
4011
+
4012
+ ---
4013
+
4014
+ ## 1. 需求概述
4015
+
4016
+ ### 1.1 需求背景
4017
+ {基于req.txt提取的背景信息}
4018
+
4019
+ ### 1.2 核心目标
4020
+ {需求要达成的核心目标}
4021
+
4022
+ ### 1.3 范围边界
4023
+ - **包含**: {明确包含的内容}
4024
+ - **不包含**: {明确排除的内容}
4025
+
4026
+ ---
4027
+
4028
+ ## 2. 功能分析
4029
+
4030
+ ### 2.1 功能清单
4031
+
4032
+ | 序号 | 功能名称 | 优先级 | 描述 | 依赖功能 |
4033
+ |------|----------|--------|------|----------|
4034
+ | F001 | {功能名} | P0/P1/P2 | {描述} | {依赖} |
4035
+
4036
+ ### 2.2 功能依赖关系
4037
+
4038
+ ```mermaid
4039
+ graph TD
4040
+ F001 --> F002
4041
+ F002 --> F003
4042
+ ```
4043
+
4044
+ ### 2.3 功能优先级说明
4045
+ - **P0 (必须实现)**: {列表}
4046
+ - **P1 (重要)**: {列表}
4047
+ - **P2 (可选)**: {列表}
4048
+
4049
+ ---
4050
+
4051
+ ## 3. 用户分析
4052
+
4053
+ ### 3.1 用户角色
4054
+
4055
+ | 角色 | 描述 | 主要操作 | 权限级别 |
4056
+ |------|------|----------|----------|
4057
+ | {角色名} | {描述} | {操作列表} | {权限} |
4058
+
4059
+ ### 3.2 用户旅程
4060
+ {关键用户旅程描述}
4061
+
4062
+ ---
4063
+
4064
+ ## 4. 数据分析
4065
+
4066
+ ### 4.1 数据实体清单
4067
+
4068
+ | 实体名称 | 描述 | 核心属性 | 关联实体 |
4069
+ |----------|------|----------|----------|
4070
+ | {实体名} | {描述} | {属性} | {关联} |
4071
+
4072
+ ### 4.2 数据关系图
4073
+
4074
+ ```mermaid
4075
+ erDiagram
4076
+ EntityA ||--o{ EntityB : contains
4077
+ ```
4078
+
4079
+ ### 4.3 与现有数据模型的兼容性
4080
+ - **可复用**: {已有实体/表}
4081
+ - **需新增**: {新实体/表}
4082
+ - **需修改**: {需变更的实体/表}
4083
+
4084
+ ---
4085
+
4086
+ ## 5. 技术分析
4087
+
4088
+ ### 5.1 技术可行性评估
4089
+
4090
+ | 功能 | 可行性 | 依赖技术 | 风险等级 | 备注 |
4091
+ |------|--------|----------|----------|------|
4092
+ | {功能} | 高/中/低 | {技术} | 高/中/低 | {备注} |
4093
+
4094
+ ### 5.2 与现有系统兼容性
4095
+ - **架构兼容**: {评估结论}
4096
+ - **中间件兼容**: {评估结论}
4097
+ - **编码规范兼容**: {评估结论}
4098
+
4099
+ ### 5.3 技术实现建议
4100
+ {基于知识库获取的技术规范,给出实现建议}
4101
+
4102
+ ---
4103
+
4104
+ ## 6. 业务规则汇总
4105
+
4106
+ ### 6.1 核心业务规则
4107
+
4108
+ | 规则ID | 规则名称 | 规则描述 | 来源 |
4109
+ |--------|----------|----------|------|
4110
+ | BR001 | {名称} | {描述} | 知识库/需求文档 |
4111
+
4112
+ ### 6.2 业务流程
4113
+
4114
+ | 流程名称 | 触发条件 | 主要步骤 | 异常处理 |
4115
+ |----------|----------|----------|----------|
4116
+ | {流程名} | {条件} | {步骤} | {异常} |
4117
+
4118
+ ---
4119
+
4120
+ ## 7. 差距分析
4121
+
4122
+ ### 7.1 能力差距
4123
+
4124
+ | 需求能力 | 现有能力 | 差距 | 解决方案 |
4125
+ |----------|----------|------|----------|
4126
+ | {需求} | {现有} | {差距} | {方案} |
4127
+
4128
+ ### 7.2 新增/修改清单
4129
+ - **新增功能**: {列表}
4130
+ - **修改功能**: {列表}
4131
+ - **新增数据**: {列表}
4132
+ - **修改数据**: {列表}
4133
+
4134
+ ---
4135
+
4136
+ ## 8. 风险分析
4137
+
4138
+ ### 8.1 风险清单
4139
+
4140
+ | 风险ID | 风险类型 | 风险描述 | 可能性 | 影响 | 缓解措施 |
4141
+ |--------|----------|----------|--------|------|----------|
4142
+ | R001 | 技术/业务/依赖 | {描述} | 高/中/低 | 高/中/低 | {措施} |
4143
+
4144
+ ### 8.2 关键风险说明
4145
+ {高风险项的详细说明}
4146
+
4147
+ ---
4148
+
4149
+ ## 9. 待澄清事项
4150
+
4151
+ ### 9.1 业务待澄清
4152
+
4153
+ | 序号 | 问题 | 上下文 | 建议选项 |
4154
+ |------|------|--------|----------|
4155
+ | Q001 | {问题} | {上下文} | {选项A/B/C} |
4156
+
4157
+ ### 9.2 技术待澄清
4158
+
4159
+ | 序号 | 问题 | 上下文 | 建议选项 |
4160
+ |------|------|--------|----------|
4161
+ | Q001 | {问题} | {上下文} | {选项A/B/C} |
4162
+
4163
+ ---
4164
+
4165
+ ## 10. 知识库引用索引
4166
+
4167
+ | 知识文件 | 路径 | 主要内容 |
4168
+ |----------|------|----------|
4169
+ | {文件名} | docs/rag/{path} | {内容摘要} |
4170
+
4171
+ ---
4172
+
4173
+ ## 11. 下游交接清单
4174
+
4175
+ ### 11.1 交接给PM智能体的输入
4176
+
4177
+ ```yaml
4178
+ 交接物清单:
4179
+ 必读文件:
4180
+ - docs/rag/_analysis-report.md # 本报告
4181
+ - docs/rag/_requirement-parsing.yaml # 需求解析结果
4182
+
4183
+ 知识文件目录:
4184
+ - docs/rag/business/ # 业务知识
4185
+ - docs/rag/technical/ # 技术知识
4186
+ - docs/rag/constraints/ # 约束条件
4187
+
4188
+ 原始需求:
4189
+ - {req_file}
4190
+
4191
+ 建议后续动作:
4192
+ - PM智能体执行: "*create-prd docs/rag/"
4193
+ - 重点关注: 待澄清事项(第9节)
4194
+ - 风险跟踪: 风险清单(第8节)
4195
+ ```
4196
+
4197
+ ---
4198
+
4199
+ *报告生成时间: {timestamp}*
4200
+ *Analyst Agent - XiaoMa Framework*
3269
4201
  ```
3270
4202
 
3271
4203
  ---
@@ -3284,18 +4216,52 @@ PRD生成:
3284
4216
  参数:
3285
4217
  req_file: 需求文档路径 (默认: req.txt)
3286
4218
  rag_output: 知识输出路径 (默认: docs/rag/)
3287
- prd_output: PRD输出路径 (默认: docs/prd.md)
3288
4219
  skip_rag: 跳过知识库查询 (默认: false)
3289
4220
  interactive: 交互模式 (默认: true)
3290
4221
  ```
3291
4222
 
3292
4223
  ### 交互模式流程
3293
4224
 
3294
- 1. **解析阶段**: 展示需求解析结果,请用户确认
3295
- 2. **提问阶段**: 展示问题清单,请用户确认或调整
3296
- 3. **查询阶段**: 依次查询知识库,展示返回结果
3297
- 4. **分析阶段**: 展示分析结论,请用户确认
3298
- 5. **生成阶段**: 生成PRD草稿,启用启发式优化
4225
+ 1. **解析阶段**: 展示需求解析结果,保存到 `docs/rag/_requirement-parsing.yaml`,请用户确认
4226
+ 2. **提问阶段**: 展示问题清单,保存到 `docs/rag/_questions.md`,请用户确认或调整
4227
+ 3. **查询阶段**: 依次查询知识库,将返回结果保存到 `docs/rag/` 对应子目录
4228
+ 4. **分析阶段**: 执行多维度需求分析,生成分析报告
4229
+ 5. **完成阶段**: 输出 `docs/rag/_analysis-report.md`,提示用户交接给PM智能体
4230
+
4231
+ ### 相关命令
4232
+
4233
+ | 命令 | 说明 |
4234
+ |------|------|
4235
+ | `*generate-rag-questions {req_file}` | 单独执行问题生成,保存到 `docs/rag/_questions.md` |
4236
+ | `*land-knowledge` | 将知识库返回内容保存到 `docs/rag/` 对应子目录 |
4237
+ | `*generate-analysis-report` | 基于 `docs/rag/` 知识生成需求分析报告 |
4238
+
4239
+ ### YOLO模式
4240
+
4241
+ 通过 `*yolo` 命令切换YOLO模式,一次性完成所有步骤,跳过中间确认环节。
4242
+
4243
+ ---
4244
+
4245
+ ## 任务完成标志
4246
+
4247
+ ```yaml
4248
+ 完成条件:
4249
+ 必要输出:
4250
+ - docs/rag/_requirement-parsing.yaml # 需求解析结果
4251
+ - docs/rag/_questions.md # 问题清单
4252
+ - docs/rag/_index.md # 知识索引
4253
+ - docs/rag/_analysis-report.md # 需求分析报告
4254
+ - docs/rag/{category}/*.md # 分类知识文件
4255
+
4256
+ 完成提示: |
4257
+ ✅ 需求分析任务完成!
4258
+
4259
+ 📁 输出目录: docs/rag/
4260
+ 📋 分析报告: docs/rag/_analysis-report.md
4261
+
4262
+ 🔄 下一步: 请将分析结果交接给PM智能体
4263
+ 💡 执行命令: *create-prd docs/rag/
4264
+ ```
3299
4265
  ==================== END: .xiaoma-core/tasks/requirement-analysis-with-rag.md ====================
3300
4266
 
3301
4267
  ==================== START: .xiaoma-core/templates/brainstorming-output-tmpl.yaml ====================