@zeyue0329/xiaoma-cli 1.0.42 → 1.0.44

package/xiaoma-core/templates/rag-knowledge-tmpl.yaml

@@ -0,0 +1,569 @@
+template:
+  id: rag-knowledge-template-v1
+  name: RAG知识落地模板
+  version: 1.0
+  description: 将知识库MCP返回的知识内容结构化存储到docs/rag目录
+  output:
+    format: markdown
+    base_path: docs/rag/
+
+sections:
+  - id: index-template
+    title: 知识索引模板
+    filename: _index.md
+    template: |
+      # RAG知识库索引
+
+      ## 概览
+      - 需求文档: {{requirement_file}}
+      - 创建时间: {{created_at}}
+      - 最后更新: {{updated_at}}
+      - 知识条目数: {{total_entries}}
+
+      ## 知识分类统计
+
+      | 分类 | 条目数 | 覆盖率 |
+      |------|--------|--------|
+      | 业务知识 | {{business_count}} | {{business_coverage}}% |
+      | 技术知识 | {{technical_count}} | {{technical_coverage}}% |
+      | 历史信息 | {{history_count}} | {{history_coverage}}% |
+      | 约束条件 | {{constraints_count}} | {{constraints_coverage}}% |
+
+      ## 知识目录
+
+      ### 业务知识 (business/)
+      {{#each business_files}}
+      - [{{title}}](business/{{filename}}) - {{summary}}
+      {{/each}}
+
+      ### 技术知识 (technical/)
+      {{#each technical_files}}
+      - [{{title}}](technical/{{filename}}) - {{summary}}
+      {{/each}}
+
+      ### 历史信息 (history/)
+      {{#each history_files}}
+      - [{{title}}](history/{{filename}}) - {{summary}}
+      {{/each}}
+
+      ### 约束条件 (constraints/)
+      {{#each constraints_files}}
+      - [{{title}}](constraints/{{filename}}) - {{summary}}
+      {{/each}}
+
+      ## 未回答问题
+      {{#if unanswered_questions}}
+      以下问题未能从知识库获得答案：
+      {{#each unanswered_questions}}
+      - [{{id}}] {{question}}
+      {{/each}}
+      {{else}}
+      所有问题均已获得回答。
+      {{/if}}
+
+      ## 后续行动
+      {{#each follow_up_actions}}
+      - [ ] {{action}}
+      {{/each}}
+
+  - id: business-knowledge
+    title: 业务知识模板
+    path: business/
+    variants:
+      - id: domain-knowledge
+        filename_pattern: "domain-{{domain_name}}.md"
+        template: |
+          # {{domain_name}} 领域知识
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 领域概述
+          {{domain_overview}}
+
+          ## 核心概念
+
+          {{#each concepts}}
+          ### {{name}}
+          - **定义**: {{definition}}
+          - **业务含义**: {{business_meaning}}
+          - **相关实体**: {{related_entities}}
+          {{/each}}
+
+          ## 业务规则
+
+          {{#each rules}}
+          ### 规则{{index}}: {{name}}
+          - **描述**: {{description}}
+          - **触发条件**: {{trigger}}
+          - **执行逻辑**: {{logic}}
+          - **异常处理**: {{exception}}
+          {{/each}}
+
+          ## 与需求的关联
+          {{requirement_mapping}}
+
+      - id: process-knowledge
+        filename_pattern: "process-{{process_name}}.md"
+        template: |
+          # {{process_name}} 业务流程
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 流程概述
+          {{process_overview}}
+
+          ## 流程步骤
+
+          ```mermaid
+          {{mermaid_diagram}}
+          ```
+
+          ### 详细步骤
+
+          {{#each steps}}
+          #### 步骤{{index}}: {{name}}
+          - **执行者**: {{actor}}
+          - **输入**: {{input}}
+          - **处理**: {{processing}}
+          - **输出**: {{output}}
+          - **后置条件**: {{postcondition}}
+          {{/each}}
+
+          ## 异常流程
+
+          {{#each exceptions}}
+          ### {{name}}
+          - **触发条件**: {{trigger}}
+          - **处理方式**: {{handling}}
+          - **恢复机制**: {{recovery}}
+          {{/each}}
+
+          ## 与需求的关联
+          {{requirement_mapping}}
+
+      - id: roles-knowledge
+        filename_pattern: "roles.md"
+        template: |
+          # 用户角色与权限
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 角色定义
+
+          {{#each roles}}
+          ### {{name}}
+          - **描述**: {{description}}
+          - **职责**: {{responsibilities}}
+          - **权限范围**: {{permissions}}
+
+          #### 可执行操作
+          {{#each operations}}
+          - {{name}}: {{description}} ({{permission_level}})
+          {{/each}}
+          {{/each}}
+
+          ## 权限矩阵
+
+          | 操作 | {{#each roles}}{{name}} | {{/each}}
+          |------|{{#each roles}}--------|{{/each}}
+          {{#each operations}}
+          | {{name}} | {{#each role_permissions}}{{this}} | {{/each}}
+          {{/each}}
+
+          ## 与需求的关联
+          {{requirement_mapping}}
+
+  - id: technical-knowledge
+    title: 技术知识模板
+    path: technical/
+    variants:
+      - id: architecture
+        filename_pattern: "architecture.md"
+        template: |
+          # 系统架构
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 架构概览
+          {{architecture_overview}}
+
+          ## 技术栈
+          | 层级 | 技术 | 版本 | 说明 |
+          |------|------|------|------|
+          {{#each tech_stack}}
+          | {{layer}} | {{technology}} | {{version}} | {{description}} |
+          {{/each}}
+
+          ## 模块结构
+
+          ```
+          {{module_structure}}
+          ```
+
+          ## 模块说明
+
+          {{#each modules}}
+          ### {{name}}
+          - **职责**: {{responsibility}}
+          - **依赖**: {{dependencies}}
+          - **对外接口**: {{interfaces}}
+          {{/each}}
+
+          ## 与需求的关联
+          - **建议实现位置**: {{suggested_location}}
+          - **需要修改的模块**: {{affected_modules}}
+          - **需要新增的模块**: {{new_modules}}
+
+      - id: data-model
+        filename_pattern: "data-model.md"
+        template: |
+          # 数据模型
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 数据库概览
+          - **数据库类型**: {{database_type}}
+          - **数据库版本**: {{database_version}}
+          - **ORM框架**: {{orm_framework}}
+
+          ## 相关数据表
+
+          {{#each tables}}
+          ### {{table_name}}
+
+          **说明**: {{description}}
+
+          | 字段名 | 类型 | 约束 | 说明 |
+          |--------|------|------|------|
+          {{#each columns}}
+          | {{name}} | {{type}} | {{constraints}} | {{description}} |
+          {{/each}}
+
+          **索引**:
+          {{#each indexes}}
+          - {{name}}: {{columns}} ({{type}})
+          {{/each}}
+
+          {{/each}}
+
+          ## 表关系
+
+          ```mermaid
+          erDiagram
+          {{er_diagram}}
+          ```
+
+          ## 与需求的关联
+          - **需要新增的表**: {{new_tables}}
+          - **需要修改的表**: {{modified_tables}}
+          - **数据迁移需求**: {{migration_needs}}
+
+      - id: api-spec
+        filename_pattern: "api-{{module}}.md"
+        template: |
+          # {{module}} 接口规范
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 接口概览
+          - **基础路径**: {{base_path}}
+          - **认证方式**: {{auth_method}}
+          - **响应格式**: {{response_format}}
+
+          ## 接口列表
+
+          {{#each apis}}
+          ### {{method}} {{path}}
+
+          **说明**: {{description}}
+
+          **请求参数**:
+          | 参数名 | 位置 | 类型 | 必填 | 说明 |
+          |--------|------|------|------|------|
+          {{#each parameters}}
+          | {{name}} | {{in}} | {{type}} | {{required}} | {{description}} |
+          {{/each}}
+
+          **请求体**:
+          ```json
+          {{request_body}}
+          ```
+
+          **响应**:
+          ```json
+          {{response_body}}
+          ```
+
+          **错误码**:
+          | 错误码 | 说明 |
+          |--------|------|
+          {{#each error_codes}}
+          | {{code}} | {{message}} |
+          {{/each}}
+
+          ---
+          {{/each}}
+
+          ## 与需求的关联
+          - **可复用的接口**: {{reusable_apis}}
+          - **需要新增的接口**: {{new_apis}}
+          - **需要修改的接口**: {{modified_apis}}
+
+      - id: code-patterns
+        filename_pattern: "patterns.md"
+        template: |
+          # 代码模式与最佳实践
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 项目结构规范
+          ```
+          {{project_structure}}
+          ```
+
+          ## 代码规范
+          {{#each coding_standards}}
+          ### {{category}}
+          {{description}}
+
+          **示例**:
+          ```{{language}}
+          {{example}}
+          ```
+          {{/each}}
+
+          ## 常用模式
+
+          {{#each patterns}}
+          ### {{name}}
+          - **使用场景**: {{use_case}}
+          - **实现示例**: {{example_location}}
+          - **注意事项**: {{notes}}
+          {{/each}}
+
+          ## 可复用组件
+
+          {{#each reusable_components}}
+          ### {{name}}
+          - **位置**: {{location}}
+          - **功能**: {{functionality}}
+          - **使用方法**: {{usage}}
+          {{/each}}
+
+          ## 与需求的关联
+          {{requirement_mapping}}
+
+  - id: history-knowledge
+    title: 历史信息模板
+    path: history/
+    variants:
+      - id: related-features
+        filename_pattern: "related-features.md"
+        template: |
+          # 相关历史功能
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 相关功能列表
+
+          {{#each features}}
+          ### {{name}}
+          - **实现时间**: {{implemented_at}}
+          - **当前状态**: {{status}}
+          - **功能描述**: {{description}}
+          - **实现位置**: {{location}}
+
+          **与当前需求的关系**:
+          {{relation_to_current}}
+
+          **可借鉴点**:
+          {{lessons_learned}}
+
+          ---
+          {{/each}}
+
+          ## 建议
+          {{recommendations}}
+
+      - id: decisions
+        filename_pattern: "decisions.md"
+        template: |
+          # 架构决策记录
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 相关决策
+
+          {{#each decisions}}
+          ### ADR-{{id}}: {{title}}
+
+          **状态**: {{status}}
+          **日期**: {{date}}
+
+          **背景**:
+          {{context}}
+
+          **决策**:
+          {{decision}}
+
+          **理由**:
+          {{rationale}}
+
+          **影响**:
+          {{consequences}}
+
+          **与当前需求的关联**:
+          {{relation_to_current}}
+
+          ---
+          {{/each}}
+
+  - id: constraints-knowledge
+    title: 约束条件模板
+    path: constraints/
+    variants:
+      - id: technical-constraints
+        filename_pattern: "technical.md"
+        template: |
+          # 技术约束
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 技术栈约束
+
+          {{#each tech_constraints}}
+          ### {{category}}
+          - **约束**: {{constraint}}
+          - **原因**: {{reason}}
+          - **影响**: {{impact}}
+          {{/each}}
+
+          ## 依赖约束
+
+          {{#each dependency_constraints}}
+          - **{{name}}**: {{constraint}}
+          {{/each}}
+
+          ## 与需求的关联
+          {{requirement_mapping}}
+
+      - id: security-constraints
+        filename_pattern: "security.md"
+        template: |
+          # 安全合规要求
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 安全要求
+
+          {{#each security_requirements}}
+          ### {{name}}
+          - **描述**: {{description}}
+          - **适用范围**: {{scope}}
+          - **实现方式**: {{implementation}}
+          {{/each}}
+
+          ## 合规要求
+
+          {{#each compliance_requirements}}
+          ### {{standard}}
+          - **要求**: {{requirement}}
+          - **检查点**: {{checkpoints}}
+          {{/each}}
+
+          ## 与需求的关联
+          {{requirement_mapping}}
+
+      - id: performance-constraints
+        filename_pattern: "performance.md"
+        template: |
+          # 性能要求
+
+          ## 元信息
+          - 查询问题ID: {{question_ids}}
+          - 来源: 知识库MCP
+          - 更新时间: {{timestamp}}
+
+          ## 性能指标
+
+          | 指标 | 目标值 | 当前值 | 说明 |
+          |------|--------|--------|------|
+          {{#each metrics}}
+          | {{name}} | {{target}} | {{current}} | {{description}} |
+          {{/each}}
+
+          ## SLA要求
+          {{#each sla_requirements}}
+          - **{{name}}**: {{value}}
+          {{/each}}
+
+          ## 与需求的关联
+          {{requirement_mapping}}
+
+workflow:
+  knowledge_landing_process:
+    step1:
+      name: "创建目录结构"
+      action: |
+        确保 docs/rag/ 目录结构存在:
+        - docs/rag/business/
+        - docs/rag/technical/
+        - docs/rag/history/
+        - docs/rag/constraints/
+
+    step2:
+      name: "分类知识内容"
+      action: |
+        根据问题类别(A/B/C/D)将知识库返回内容分类:
+        - A类 → business/
+        - B类 → technical/
+        - C类 → history/
+        - D类 → constraints/
+
+    step3:
+      name: "应用模板生成文件"
+      action: |
+        为每条知识选择合适的模板变体，填充内容并生成markdown文件
+
+    step4:
+      name: "生成索引文件"
+      action: |
+        更新 docs/rag/_index.md 索引文件，统计所有知识条目
+
+    step5:
+      name: "标记未答问题"
+      action: |
+        将无法从知识库获得答案的问题记录到索引文件的"未回答问题"部分