teamai-cli 0.16.9 → 0.17.0

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,54 @@
1
+ # Phase 0: 源材料采集与预处理
2
+
3
+ ## 仓库发现与分类
4
+
5
+ 从入口仓库出发,递归发现所有相关仓库:
6
+
7
+ 1. **依赖分析**: 解析项目依赖文件(如 `requirements.txt`, `package.json`, `pom.xml`, `Cargo.toml`, `go.mod` 等,按检测到的语言选择)
8
+ 2. **配置引用**: 解析流程编排配置中引用的模块名 → 仓库映射
9
+ 3. **RPC 服务发现**: 从服务注册配置提取服务名 → 仓库映射
10
+ 4. **按架构层级分类**: API接入层 / 流程引擎层 / 服务执行层 / 资源调度层 / 数据适配层 / 基础执行层
11
+ 5. **标记核心度**: 根据代码行数、被依赖数、Handler 数量计算优先级
12
+
13
+ ## 关键文件提取清单
14
+
15
+ | 文件类型 | 匹配模式 | 提取目的 |
16
+ |---------|---------|---------|
17
+ | **入口文件** | `main.py`, `main.go`, `cmd/*/main.go`, `app.ts` | 服务启动方式和初始化流程 |
18
+ | **路由/Handler** | `handler.*`, `router.*`, `controller.*` | API 接口和消息处理入口 |
19
+ | **配置文件** | `*config*.*`, `conf/`, `*.yaml`, `*.toml` | 流程编排、参数配置 |
20
+ | **Proto/IDL** | `*.proto`, `*.thrift`, `*schema*` | RPC 接口契约和数据结构 |
21
+ | **数据库操作** | `*db*.*`, `*dao*.*`, `*model*.*`, `*repository*.*` | 数据模型和表结构 |
22
+ | **常量/错误码** | `*const*`, `*error*`, `*code*`, `*enum*` | 错误码体系和业务常量 |
23
+ | **测试文件** | `*_test.*`, `test_*.*` | 预期行为和边界条件 |
24
+
25
+ ## 构建代码知识图谱
26
+
27
+ 在正式生成文档前,构建代码知识图谱作为中间表示:
28
+
29
+ **节点类型**: `[Service]` / `[Handler]` / `[Config]` / `[Table]` / `[Queue]` / `[API]` / `[ErrorCode]`
30
+
31
+ **边类型**: `[CALLS]`(同步RPC/HTTP) / `[PUBLISHES]`(异步MQ) / `[CONSUMES]`(MQ消费) / `[READS]`(DB读) / `[WRITES]`(DB写) / `[CONFIGURES]`(配置驱动) / `[MAPS_TO]`(产品→代码)
32
+
33
+ **构建方法**(按可用性排序):
34
+ 1. **`team-wiki compile code --extract ast,heuristic --write`** — Tree-sitter 结构边(**TS/JS/Python/Go** 等)+ 多语言 heuristic 事实页
35
+ 2. Grep + Read(Agent K1/K2)— 补充动态路由、配置驱动调用
36
+ 3. 解析编排配置 → 模块→命令映射
37
+ 4. 解析 Proto/IDL/DDL → 数据结构和表关系(结构化文件,可精确解析)
38
+ 5. MQ 拓扑推断 → Exchange/Topic/Queue/Routing Key
39
+ 6. API 映射 → 外部 API 名称 → 内部 Handler 入口
40
+
41
+ > `code-ast` 对相对 import 可产出 `DEPENDS_ON` 边;包级/动态调用仍可能遗漏,标 `[UNVERIFIED]` 或 `AMBIGUOUS`。
42
+ > 能力 ID 与边优先级见插件内 `GRAPH-CAPABILITIES.md`。
43
+
44
+ ## 输入源优先级
45
+
46
+ | 优先级 | 输入源 | 具体内容 | 产出文档类型 |
47
+ |--------|--------|---------|------------|
48
+ | **P0 必须** | 代码仓库 | 目录结构、入口文件、配置、Proto | Type-1,4 |
49
+ | **P0 必须** | 流程编排配置 | workflow_config / 状态机 | Type-1,4,5 |
50
+ | **P0 必须** | 产品 API 文档 | 接口参数、错误码 | Type-5,6 |
51
+ | **P1 重要** | 数据库 Schema | DDL、表结构 | Type-4 |
52
+ | **P1 重要** | 产品使用文档 | 使用限制、FAQ | Type-6,8a |
53
+ | **P2 增强** | Git 历史 | Commit/MR 记录 | Type-8b |
54
+ | **P2 增强** | 故障记录 | 事故报告 | Type-8d |
@@ -0,0 +1,89 @@
1
+ # Phase 1: 架构逆向工程 — 从代码到架构认知
2
+
3
+ ## 1. 自底向上分层法
4
+
5
+ ```
6
+ Step 1: 识别"叶子节点" — 直接操作基础设施
7
+ ├── 数据库操作 (MySQL/PostgreSQL/Redis/MongoDB)
8
+ ├── 消息队列操作 (RabbitMQ/Kafka/RocketMQ)
9
+ ├── 外部系统调用 (第三方 API / 底层驱动)
10
+ └── 文件/对象存储操作 (S3/OSS/COS)
11
+
12
+ Step 2: 识别"中间节点" — 编排和路由
13
+ ├── 消息路由框架 (消费者路由分发)
14
+ ├── 任务调度器 (定时任务/延迟任务)
15
+ ├── 流程编排引擎 (Workflow/Saga/状态机)
16
+ └── 资源调度器 (负载均衡/资源分配)
17
+
18
+ Step 3: 识别"根节点" — 外部入口
19
+ ├── API 网关 / HTTP Handler / gRPC Server
20
+ ├── 定时任务入口 (Cron/Scheduler)
21
+ └── 事件监听入口 (Webhook/EventBus)
22
+
23
+ Step 4: 按调用方向分层
24
+ 外部入口 → 流程编排 → 服务执行 → 资源调度 → 数据操作 → 基础设施
25
+ ```
26
+
27
+ ### 分层判定规则
28
+
29
+ | 判定特征 | 所属层级 | 典型代码模式 |
30
+ |---------|---------|-------------|
31
+ | HTTP/gRPC Server 启动 | API 接入层 | `http.ListenAndServe()`, `grpc.NewServer()` |
32
+ | 参数校验 + 鉴权 + 限流 | API 接入层 | `validate()`, `auth()`, `rateLimit()` |
33
+ | 流程步骤配置和状态机 | 流程引擎层 | `workflow_config`, `state_machine` |
34
+ | MQ 消费 + Handler 路由 | 服务执行层 | `channel.consume()`, `handler.dispatch()` |
35
+ | 调度算法 (Filter/Score) | 资源调度层 | `filter()`, `score()`, `schedule()` |
36
+ | DB CRUD + 缓存操作 | 数据适配层 | `db.query()`, `redis.get()` |
37
+ | 底层系统调用/驱动 | 基础执行层 | `exec()`, `syscall.*`, `driver.*` |
38
+
39
+ ## 2. 三层穿透追踪法(核心方法论)
40
+
41
+ 对任何用户可见 API 操作,完成三层穿透追踪:
42
+
43
+ ```
44
+ Layer 1: API 入口层
45
+ ├── 定位 Handler 函数
46
+ ├── 提取参数校验逻辑
47
+ ├── 识别硬编码默认值和白名单
48
+ └── 确定下游调用方式 (同步RPC / 异步MQ)
49
+
50
+ Layer 2: 流程编排层
51
+ ├── 查找流程配置 (workflow_config / saga_config)
52
+ ├── 解析步骤序列 (步骤名/执行模块/回滚模块/超时/重试)
53
+ ├── 标注每步的执行模块和回滚模块
54
+ └── 确定步骤间的数据传递方式
55
+
56
+ Layer 3: 服务执行层
57
+ ├── 追踪每个步骤的具体 Handler 实现
58
+ ├── 识别数据库操作和状态变更
59
+ ├── 标注外部系统调用
60
+ └── 确定最终执行结果的回调路径
61
+
62
+ 输出: 完整调用链时序图 + 状态流转图 + 数据流向图
63
+ ```
64
+
65
+ ### 调用链文档化标准格式
66
+
67
+ ```
68
+ [API名称](代码入口: {仓库}/{路径}/{文件})
69
+ → 参数校验 + 鉴权限流
70
+ → [前置检查]: {检查内容}
71
+ → RPC/MQ → [编排层] ({配置文件}: {操作名})
72
+ → [服务层] ({配置文件}: {flow_name})
73
+ → [{步骤1模块}] {步骤1命令} ({具体说明})
74
+ → [{步骤2模块}] {步骤2命令} ({具体说明})
75
+ → ...
76
+ → 回调 [编排层]
77
+ ```
78
+
79
+ ## 3. 组件关系矩阵
80
+
81
+ 构建 N×N 关系矩阵,标注通信方式:
82
+
83
+ | 调用方 ↓ / 被调方 → | 组件A | 组件B | 组件C |
84
+ |---------------------|-------|-------|-------|
85
+ | **组件A** | — | RPC | MQ |
86
+ | **组件B** | — | — | DB |
87
+ | **组件C** | RPC | MQ | — |
88
+
89
+ 标注: `RPC`(同步) / `MQ`(异步) / `DB`(共享数据库) / `—`(无直接通信)
@@ -0,0 +1,341 @@
1
+ # Phase 2: 九大文档类型生成规范与模板
2
+
3
+ ## Type-1: 技术架构总览
4
+
5
+ **规模**: ~200KB | **数量**: 1 份
6
+
7
+ ### 必备章节
8
+
9
+ ```
10
+ 读者导航指南 (按角色推荐阅读路径)
11
+ 知识库检索路由指引 (AI 专用,4条分流规则+4级优先级)
12
+ 1. 架构概述 (30秒快速理解表、整体架构图ASCII、组件关系矩阵)
13
+ 2. 三维架构视图 (逻辑/数据/部署)
14
+ 3. 核心链路 ⭐ (每条核心API的完整时序图+调用链)
15
+ 4. 核心组件详解 (每组件概述+表格)
16
+ 5. 配置管理与服务发现
17
+ 6. 数据模型与存储架构 ⭐
18
+ 7. 高可用与技术架构
19
+ 8. 架构演进与设计决策
20
+ 9. AI 研发知识库规范 ⭐ (元数据QA/全局状态机/MQ拓扑/调度引擎/跨层追踪)
21
+ 附录: 代码仓库/术语表/代码入口索引/错误码
22
+ ```
23
+
24
+ ### 生成规则
25
+ - T1-R01: 必须包含读者导航指南
26
+ - T1-R02: 必须包含 AI 检索路由规则
27
+ - T1-R03: 核心链路必须有时序图
28
+ - T1-R04: 组件表必须包含代码仓库列
29
+ - T1-R05: 术语表必须包含内外部映射
30
+ - T1-R06: 必须有 AI 专用第 9 章
31
+ - T1-R07: 架构图使用 ASCII Art
32
+
33
+ ---
34
+
35
+ ## Type-2: 业务架构文档
36
+
37
+ **规模**: ~70KB | **数量**: 1 份
38
+
39
+ ```
40
+ 1. 产品能力矩阵 (能力域/子能力/对应API/计费影响)
41
+ 2. 计费模型详解 (模式对比/状态机/退费续费规则)
42
+ 3. 核心实体生命周期 (完整状态机/各状态允许操作/互斥规则)
43
+ 4. 核心业务流程 (用户视角时序图+前置条件+异常处理)
44
+ 5. 产品规格体系 (命名规则/规格与底层资源映射)
45
+ ```
46
+
47
+ ---
48
+
49
+ ## Type-3: 部署架构文档
50
+
51
+ **规模**: ~40KB | **数量**: 1 份
52
+
53
+ ```
54
+ 1. 分层部署架构图
55
+ 2. 服务部署矩阵 (服务名/部署方式/实例数/资源配置/依赖)
56
+ 3. 环境配置 (生产/测试/差异对照)
57
+ 4. 部署流程与变更管理
58
+ ```
59
+
60
+ ---
61
+
62
+ ## Type-4: 组件设计文档(核心产出)
63
+
64
+ **规模**: 20~100KB/份 | **数量**: N 份(每组件一份)
65
+
66
+ ### 标准模板
67
+
68
+ ```
69
+ # {组件名} 内部设计说明
70
+ <!-- search-anchor: 组件名, 别名, 核心关键词 -->
71
+ > 项目名称 / 版本 / 代码仓库 / 代码规模
72
+ > 在整体架构中的位置: [📘 链接到主架构文档]
73
+
74
+ ## 🤖 AI 快速理解要点
75
+ (10 维度结构化摘要,详细定义见 [phase3-ai-enhancement.md §1](phase3-ai-enhancement.md))
76
+
77
+ ## 📋 项目概述 (核心职责+在架构中的位置)
78
+ ## 🏗️ 架构设计 (ASCII架构图+核心子模块,函数签名)
79
+ ## 📊 数据模型 (SQL DDL带注释+数据流向图)
80
+ ## 🔌 接口设计 (对外接口表+对内接口+错误码)
81
+ ## ⚙️ 核心流程 (时序图+步骤说明+异常处理)
82
+ ## 🔧 配置说明 (配置项/默认值/说明/影响范围)
83
+ ## 📈 监控与告警
84
+ ## 🐛 常见问题与排障
85
+ ```
86
+
87
+ ### 生成规则
88
+ - T4-R01: 必须有 AI 快速理解表
89
+ - T4-R02: 必须有双向链接到主架构文档
90
+ - T4-R03: 核心函数必须列出签名
91
+ - T4-R04: SQL DDL 必须包含注释
92
+ - T4-R05: 配置项必须标注影响范围
93
+ - T4-R06: 架构图使用 ASCII Art
94
+ - T4-R07: 代码入口必须精确到函数名
95
+
96
+ ### 从代码生成的步骤
97
+
98
+ > 详细执行规范见 `references/agents/kb-doc-generator.md`,此处仅列概要:
99
+ > 1. 代码结构扫描(Glob → Grep → Read 三步法,按语言自适应)
100
+ > 2. 信息提取(10 维度:核心职责/架构层级/上下游/代码入口/核心机制/数据流向/技术栈/数据模型/配置项/定时任务)
101
+ > 3. 文档组装(按上述模板章节顺序)
102
+ > 4. 自校验(准确性统计 + 接口对账)
103
+
104
+ ---
105
+
106
+ ## Type-5: 产品-代码映射(桥梁文档)
107
+
108
+ ### 每个核心 API 一节
109
+
110
+ ```
111
+ ### N.1 用户意图 (一句话)
112
+ ### N.2 产品约束 (约束项/约束值/影响组件/校验位置)
113
+ ### N.3 用户可见状态流转 (ASCII图+内部状态映射)
114
+ ### N.4 内部调用链路 (标准格式精确到代码文件)
115
+ ### N.5 写代码时必须考虑的 (硬性约束编号列表)
116
+ ### N.6 错误码与内部异常映射 (外部码/内部组件/含义)
117
+ ```
118
+
119
+ ### 生成规则
120
+ - T5-R01: 约束表必须标注"影响的组件"和"校验位置"
121
+ - T5-R02: 调用链必须精确到代码文件路径
122
+ - T5-R03: 状态流转必须标注内部状态码映射
123
+ - T5-R04: "写代码时必须考虑的"是强制章节
124
+ - T5-R05: 错误码映射必须包含内部组件归属
125
+
126
+ ### 桥梁文档生成方法(3 Step)
127
+
128
+ **Step 1: 提取产品约束** — 从产品文档中提取所有影响代码实现的约束:
129
+
130
+ ```
131
+ 扫描维度:
132
+ ├── 数量限制 (批量上限、配额、最大值)
133
+ ├── 类型约束 (枚举值、互斥关系)
134
+ ├── 状态前置条件 (操作前资源必须处于什么状态)
135
+ ├── 计费规则 (不同计费模式的差异处理)
136
+ ├── 安全约束 (鉴权、加密、脱敏)
137
+ └── 兼容性约束 (类型兼容、版本兼容、地域限制)
138
+ ```
139
+
140
+ **Step 2: 映射到代码位置** — 对每个产品约束,追踪到代码中的具体校验位置:
141
+
142
+ ```
143
+ 产品约束: "{API名} 批量上限 N"
144
+ ↓ 追踪
145
+ 代码位置: {API网关组件} → {文件路径} → validate_params()
146
+ ↓ 确认
147
+ 校验方式: if len(resource_ids) > N: raise InvalidParameterValue
148
+ ```
149
+
150
+ **Step 3: 构建映射表** — 将上述信息组装为标准的产品-代码映射表(见 Type-5 模板)。
151
+
152
+ **桥梁文档质量标准**:
153
+
154
+ | 质量维度 | 标准 | 检查方法 |
155
+ |---------|------|---------|
156
+ | **完整性** | 所有核心 API 都有映射 | 对照 API 列表逐一检查 |
157
+ | **精确性** | 代码路径精确到文件和函数 | 实际打开代码验证 |
158
+ | **一致性** | 约束值与产品文档一致 | 交叉比对产品文档 |
159
+ | **时效性** | 与最新代码版本同步 | 定期 diff 检查 |
160
+
161
+ ---
162
+
163
+ ## Type-6: 产品规则速查表
164
+
165
+ ```
166
+ ## N. {规则类别}
167
+ | 规则 | 约束值 | 影响的组件 | 校验位置 | 来源文档 |
168
+
169
+ ## 状态与操作互斥规则
170
+ | 当前状态 | 允许的操作 | 禁止的操作 |
171
+ ```
172
+
173
+ - T6-R01: 每条规则必须标注"影响的组件"
174
+ - T6-R02: 约束值必须是精确数字
175
+ - T6-R03: 必须有"来源文档"列
176
+ - T6-R04: 状态互斥规则必须是完整矩阵
177
+
178
+ ---
179
+
180
+ ## Type-7: 业务开发规范 SOP
181
+
182
+ ```
183
+ 1. 为什么需要标准代码模板 (野生代码问题)
184
+ 2. 核心规约 (绝不向外暴露底层错误/Context一传到底/参数前置校验)
185
+ 3. 标准 Handler 代码模板 (可直接复制,标注"AI 编码铁律")
186
+ 4. 错误码映射对照表 (场景描述用AI思考逻辑/推荐错误码/Message)
187
+ 5. AI 评审 CheckList (可机器校验)
188
+ ```
189
+
190
+ - T7-R01: 代码模板必须可直接复制运行
191
+ - T7-R02: 每个关键注释标注"AI 编码铁律"
192
+ - T7-R03: 错误码表用"AI的思考逻辑"作为场景描述
193
+
194
+ ---
195
+
196
+ ## Type-8: 知识增强文档
197
+
198
+ ### Type-8a: 产品知识文库
199
+ 标注 `type: bridge`,表格对比易混淆概念,含"代码传参示例"和"架构与业务影响"列。
200
+
201
+ ### Type-8b: 反模式与踩坑指南
202
+ 五段式:**触发场景→错误表现→根因分析→正确做法→关联组件**
203
+ 概览表标注编号/分类/严重程度(P0致命/P1严重/P2重要)/关联组件。
204
+
205
+ ### Type-8c: RPC 接口契约
206
+ struct 定义含序列化 Tag + 必填/选填标注 + AI 编码契约要求。
207
+
208
+ ### Type-8d: 排障案例记录 (Memorix)
209
+ 结构:问题现象→排查过程(Step N)→根因定位→修复方案→经验总结→关联文档。
210
+
211
+ ---
212
+
213
+ ## Type-9: 图谱文档集(Graph RAG)
214
+
215
+ **规模**: 10~30KB/份 | **数量**: 5~10 份 | **目录**: `graph/`
216
+
217
+ > 将散落在 N 份组件文档中的**跨组件关系信息**抽取为结构化索引,解决 RAG 检索在关系查询场景下的"信息分散"问题。
218
+
219
+ ### 图谱文档类型清单
220
+
221
+ | 编号 | 文档名 | 核心内容 | 解决的检索痛点 |
222
+ |------|--------|---------|--------------|
223
+ | G1 | 组件依赖关系矩阵 | N×N 通信矩阵 + 正向/反向依赖索引 + 外部服务依赖 | "谁依赖 X?" 需遍历所有文档 |
224
+ | G2 | 组件调用链路全景 | 核心 API 端到端链路 + 读写分离机制 + **完整状态机流转图** + 操作-状态约束矩阵 | "API 经过哪些模块?" 信息分散 |
225
+ | G3 | 数据流与存储依赖图 | 存储依赖矩阵 + MQ 队列拓扑 + 缓存策略 | "数据存在哪里?" |
226
+ | G4 | 错误码组件映射表 | 错误码段分配 + 外部→内部映射 | "错误码是哪个模块的?" |
227
+ | G5 | 跨组件交互场景手册 | ≥10 个场景的 mermaid 时序图 + 异常处理 | "配额检查怎么做的?" |
228
+ | G6 | 知识图谱三元组 | (S, P, O) 三元组 + 多跳依赖路径索引 | "A 间接依赖谁?" |
229
+ | G7 | 架构风险与影响面分析 | 爆炸半径 + 聚类分析 + 关键路径/瓶颈 | "X 挂了影响多大?" |
230
+ | G8 | **核心配置参数索引** | 分层配置项→行为影响映射 + 变更影响面速查 | "怎么修改 XX 配置?" |
231
+ | G9 | **业务规则约束矩阵** | 操作前置条件 + 硬件/迁移/计费约束 + AI 推理决策树 | "能不能做 XX?" |
232
+
233
+ ### 图谱文档生成规则
234
+
235
+ - T9-R01: 每份图谱文档必须有 `🤖 AI 快速理解要点` 表
236
+ - T9-R02: 每份图谱文档必须有 `<!-- search-anchor: ... -->` 锚点
237
+ - T9-R03: 图谱目录必须有 `README.md` 索引,含"按问题类型查找"表和"检索路由规则建议"
238
+ - T9-R04: 状态机必须使用 mermaid `stateDiagram-v2` 格式
239
+ - T9-R05: 约束决策树必须使用 mermaid `graph TD` 格式
240
+ - T9-R06: 操作-状态约束必须是 ✅/❌ 矩阵格式
241
+ - T9-R07: 配置参数必须标注"影响行为"、"变更风险"(🟢低/🟡中/🔴高)、"生效方式"(热生效/需重启)
242
+ - T9-R08: 业务规则约束必须包含 AI 推理检查流程(mermaid 流程图)
243
+ - T9-R09: 三元组必须遵循 (Subject, Predicate, Object) 标准格式
244
+ - T9-R10: 图谱文档**不替代**组件文档,而是提供**关系视角的结构化索引**
245
+
246
+ ### 图谱文档生成方法
247
+
248
+ **Step 1: 关系抽取** — 从 N 份组件文档中提取跨组件关系:
249
+
250
+ ```
251
+ 扫描维度:
252
+ ├── 调用关系 (A calls B, 协议, 场景)
253
+ ├── 数据依赖 (A reads/writes B, 数据内容)
254
+ ├── 消息拓扑 (A publishes_to/consumes_from Queue)
255
+ ├── 状态流转 (操作 → 起始状态 → 中间状态 → 终态)
256
+ ├── 约束条件 (操作 → 前置条件 → 硬件/计费/配额约束)
257
+ ├── 配置映射 (配置项 → 影响行为 → 变更风险)
258
+ └── 错误码归属 (错误码段 → 组件 → 排查方向)
259
+ ```
260
+
261
+ **Step 2: 结构化建模** — 将抽取的关系转化为标准格式:
262
+
263
+ ```
264
+ 关系矩阵 → N×N 表格
265
+ 调用链路 → 端到端文本链路 + mermaid 时序图
266
+ 状态机 → mermaid stateDiagram-v2
267
+ 约束规则 → 决策树(mermaid graph TD) + 汇总表
268
+ 配置索引 → 分层表格(配置项/默认值/影响行为/变更风险/生效方式)
269
+ 三元组 → (Subject, Predicate, Object, Protocol, Scenario) 表格
270
+ ```
271
+
272
+ **Step 3: 索引织网** — 建立图谱文档间的交叉引用和检索路由:
273
+
274
+ ```
275
+ README.md:
276
+ ├── 文档目录表 (文件/大小/核心内容)
277
+ ├── 按问题类型查找表 (问题类型/示例/查找文档)
278
+ └── 检索路由规则建议 (关键词→优先检索文档)
279
+ ```
280
+
281
+ ### 关键模板
282
+
283
+ #### 状态机流转图模板
284
+
285
+ ```markdown
286
+ ## 实例状态机完整流转图
287
+
288
+ ### 核心状态流转图
289
+ ​```mermaid
290
+ stateDiagram-v2
291
+ [*] --> PENDING: CreateAction
292
+ PENDING --> RUNNING: 创建成功 (flag: 2→1)
293
+ RUNNING --> STOPPING: StopAction (flag: 1→8)
294
+ STOPPING --> STOPPED: 关机成功 (flag: 8→3)
295
+ ...
296
+ ​```
297
+
298
+ ### 操作-状态约束速查矩阵
299
+ | 操作 \ 当前状态 | RUNNING | STOPPED | PENDING | ... |
300
+ |---------------|:-------:|:-------:|:-------:|:---:|
301
+ | **Start** | ❌ | ✅ | ❌ | ... |
302
+ | **Stop** | ✅ | ❌ | ❌ | ... |
303
+ ```
304
+
305
+ #### 业务规则约束矩阵模板
306
+
307
+ ```markdown
308
+ ## 操作前置条件矩阵
309
+ | 操作 | 状态要求 | 硬件约束 | 计费约束 | 配额约束 | 其他约束 |
310
+
311
+ ## 迁移约束决策树
312
+ ​```mermaid
313
+ graph TD
314
+ A[迁移请求] --> B{硬件约束1?}
315
+ B -->|是| C["❌ 禁止"]
316
+ B -->|否| D{硬件约束2?}
317
+ ...
318
+ ​```
319
+
320
+ ## AI 推理规则速查
321
+ ​```mermaid
322
+ graph TD
323
+ A["用户问:能否执行 XX?"] --> B["Step 1: 状态检查"]
324
+ B --> B1{"查操作-状态约束矩阵"}
325
+ B1 -->|❌| Z1["不能,状态不支持"]
326
+ B1 -->|✅| C["Step 2: 类型检查"]
327
+ ...
328
+ ​```
329
+ ```
330
+
331
+ #### 配置参数索引模板
332
+
333
+ ```markdown
334
+ ## {组件层}配置参数
335
+ | 配置项 | 默认值 | 影响行为 | 变更风险 | 生效方式 |
336
+ |--------|--------|---------|---------|---------|
337
+ | `config.key` | value | 描述 | 🟢低/🟡中/🔴高 | 热生效/需重启 |
338
+
339
+ ## 配置变更影响面速查
340
+ | 变更类型 | 影响范围 | 生效方式 | 回滚策略 | 变更风险 |
341
+ ```
@@ -0,0 +1,164 @@
1
+ # Phase 3: AI-Native 增强 — 让知识库对 AI 可理解
2
+
3
+ ## 1. AI 快速理解表(每份组件文档必备)
4
+
5
+ RAG 检索返回的 chunk 通常是文档片段。AI 快速理解表确保无论检索到文档哪个部分,AI 都能在表头获得组件全局上下文。
6
+
7
+ ```markdown
8
+ ## 🤖 AI 快速理解要点
9
+
10
+ | 维度 | 关键信息 |
11
+ |------|---------|
12
+ | **核心职责** | {一句话,不超过 30 字} |
13
+ | **架构层级** | {所属层级} → {在层级中的角色} |
14
+ | **上游组件** | {组件名(通信方式)} |
15
+ | **下游组件** | {组件名(通信方式)} |
16
+ | **代码入口** | {入口文件} → {核心函数} |
17
+ | **核心机制** | {最重要的 1-2 个技术机制} |
18
+ | **互斥控制** | {并发控制方式} |
19
+ | **数据流向** | {从哪来 → 经过什么 → 到哪去} |
20
+ | **技术栈** | {语言 + 框架 + 中间件} |
21
+ | **定时任务** | {N 个定时任务(简述核心任务)} |
22
+ ```
23
+
24
+ 规则:
25
+ - 每个维度必须是**具体的**,不能泛泛描述
26
+ - "代码入口"精确到 `文件名 → 函数名`
27
+ - "上下游组件"必须标注通信方式 (RPC/MQ/DB)
28
+ - 表格放在文档最前面(紧跟标题之后)
29
+
30
+ ## 2. 检索路由规则(主架构文档必备)
31
+
32
+ 防止 RAG 检索内外部文档"串台":
33
+
34
+ ```markdown
35
+ ## 知识库检索路由指引(AI 专用)
36
+
37
+ ### 文档分类总览
38
+ | 分类 | 目录位置 | 文档数量 | 内容性质 |
39
+ | 【内部·桥梁】产品-代码映射 | ... | N 份 | 核心API意图→约束→链路 |
40
+ | 【内部】组件设计文档 | ... | N 份 | 架构设计、代码入口 |
41
+ | 【外部】产品 API 文档 | ... | N 份 | 官网 API 参考 |
42
+
43
+ ### 检索路由规则
44
+ 规则 1 — 内部架构优先: 涉及组件名/内部概念 → 仅检索内部文档
45
+ 规则 2 — 外部文档适用: 涉及 API 参数/产品限制 → 检索外部文档
46
+ 规则 3 — 混合查询: 同时涉及 → 优先内部,辅以外部
47
+ 规则 4 — 写代码前先查约束: 必须先检索桥梁文档
48
+
49
+ ### 文档优先级
50
+ | 一级(核心) | 产品-代码映射 + 规则速查表 | 写代码前必查 |
51
+ | 二级(架构) | 组件设计文档 + 主架构文档 | 理解内部实现 |
52
+ | 三级(业务) | 业务架构 + 核心链路 | 理解业务流程 |
53
+ | 四级(备查) | 外部 API 原始文档 | 仅在上述不能回答时 |
54
+ ```
55
+
56
+ ## 3. Search Anchor(语义检索锚点)
57
+
58
+ 每份文档标题下方添加:
59
+
60
+ ```html
61
+ <!-- search-anchor: 关键词1, 关键词2, 同义词, 英文术语, 中文术语 -->
62
+ ```
63
+
64
+ - 包含: 中文名、英文名、缩写、同义词、常见搜索词
65
+ - 数量: 5~15 个
66
+ - 示例: `<!-- search-anchor: RPC契约, Schema, 接口契约, Protobuf, IDL -->`
67
+
68
+ ## 4. 双向链接织网
69
+
70
+ ```markdown
71
+ # 组件文档 → 主架构文档
72
+ > 在整体架构中的位置: [📘 主架构文档 - 4.5 {组件名}](./主架构文档.md#45-组件名)
73
+
74
+ # 主架构文档 → 组件文档
75
+ 详见 [{组件名}设计说明](./XX_{组件名}设计说明.md)
76
+
77
+ # 桥梁文档 → 组件文档
78
+ | [{组件名}](./XX_{组件名}设计说明.md) | 入参校验层 |
79
+ ```
80
+
81
+ 织网规则:
82
+ 1. 每份组件文档 ≥ 1 个链接指向主架构文档
83
+ 2. 主架构文档每个组件提及处有链接指向组件文档
84
+ 3. 桥梁文档中提到的每个组件有链接
85
+ 4. 反模式文档的"关联组件"有链接
86
+
87
+ ## 5. QA 对生成(AI 元数据层)
88
+
89
+ 在主架构文档 AI 专用章节预置高频 QA 对(10~20 个):
90
+
91
+ ```markdown
92
+ - **Q: 核心实体的状态机是如何定义的?**
93
+ A: 见 `3.7 实体完整状态机` 及 `9.2.1 全局状态一致性映射表`。
94
+
95
+ - **Q: 流程步骤配置在哪里?异常如何补偿回滚?**
96
+ A: 采用 N 级编排。宏观流程在 {配置文件1},细粒度步骤在 {配置文件2}。
97
+
98
+ - **Q: 消息队列的拓扑和路由规则?**
99
+ A: 见 `9.3.1 MQ 路由拓扑`。核心 Exchange/Topic 包括 {列表}。
100
+
101
+ - **Q: 资源互斥(加锁)规范?**
102
+ A: 见 `9.4.4 分布式锁与幂等规范`。使用 {锁方案}。
103
+ ```
104
+
105
+ 每个 A 必须包含具体的章节/文档引用。
106
+
107
+ ## 6. 图谱文档 AI 增强规范
108
+
109
+ 图谱文档是 AI-Native 知识库的**关系索引层**,专门解决 RAG 在"跨组件关系查询"场景下的检索失败问题。
110
+
111
+ ### 6.1 图谱文档 README 必备结构
112
+
113
+ ```markdown
114
+ # 图谱文档集 (Graph RAG)
115
+ ## 与主文档体系的关系 (三层定位表)
116
+ ## 文档目录 (文件/大小/核心内容)
117
+ ## 按问题类型查找 (问题类型/示例/查找文档)
118
+ ## 检索路由规则建议 (关键词→优先检索文档)
119
+ ## 维护说明
120
+ ```
121
+
122
+ ### 6.2 图谱文档 AI 快速理解表
123
+
124
+ 每份图谱文档必须在标题后紧跟:
125
+
126
+ ```markdown
127
+ ## 🤖 AI 快速理解要点
128
+ | 维度 | 关键信息 |
129
+ |------|---------|
130
+ | **文档定位** | {一句话定位} |
131
+ | **核心价值** | {AI 用这份文档能做什么} |
132
+ | **覆盖范围** | {覆盖了哪些实体/关系} |
133
+ | **使用场景** | {典型问题示例} |
134
+ | **与状态机的关系** | {如适用:状态机解决X,本文档解决Y} |
135
+ ```
136
+
137
+ ### 6.3 AI 推理规则嵌入
138
+
139
+ 对于约束类图谱文档,必须嵌入 AI 推理决策流程:
140
+
141
+ ```markdown
142
+ ## AI 推理规则速查
143
+ > AI 判断"某操作能否执行"时,按以下优先级逐层检查:
144
+
145
+ 1. **状态检查** → 查操作-状态约束矩阵
146
+ 2. **类型检查** → 查特殊实例类型约束汇总
147
+ 3. **硬件检查** → 查硬件约束详表
148
+ 4. **计费检查** → 查计费约束详表
149
+ 5. **配额检查** → 查产品规则速查表
150
+ 6. **互斥检查** → 是否有进行中的操作
151
+ ```
152
+
153
+ ### 6.4 配置变更检查清单
154
+
155
+ 对于配置类图谱文档,AI 回答"怎么修改 XX 配置"时必须同时告知:
156
+
157
+ ```
158
+ 1. 配置文件位置 — 在哪个文件/仓库中
159
+ 2. 影响范围 — 全地域还是单地域/单机
160
+ 3. 生效方式 — 热生效还是需要重启
161
+ 4. 回滚策略 — 如何快速回滚
162
+ 5. 变更风险 — 🟢低 / 🟡中 / 🔴高
163
+ 6. 灰度建议 — 是否需要灰度发布
164
+ ```