docs: 重构文档结构，规范编号并整合冗余内容 #182

huanghaosheng · 2026-06-21T14:52:00+08:00

huanghaosheng commented

2026-06-21 14:52:00 +08:00

主要变更

文档重构（减少 1199 行，-23%）

01-架构设计.md: 503→369 行 (-27%)，删除 DDL/配置示例，精简鉴权/存储描述
02-接口文档.md: 1313→570 行 (-57%)，删除 Go 接口/Orchestrator 实现/配置管理
07-成本控制.md: 65→59 行 (-9%)，代码块替换为文件引用

文档编号规范化

08-功能创意.md → 删除（内容整合到 README.md "功能扩展方向"）
10-Eino框架与编排设计.md → 08-Eino框架与编排设计.md
情景切换.md → 09-情景切换.md
12-鉴权体系.md → 10-鉴权体系.md
13-令牌桶限流.md → 11-令牌桶限流.md

交叉引用更新

01-架构设计.md: 更新对鉴权体系/令牌桶限流的引用为新编号
README.md: 更新文档索引表、推荐阅读顺序、新增功能扩展方向

删除过时文档

09-技术名词解释.md（内容已整合到 03-技术选型.md）
10-Eino重构方案.md（历史记录，已完成）
11-Eino框架技术文档.md（已合并到 08）
情景切换功能完整文档.md（已规范化为 09）

重构原则

架构文档聚焦系统结构，移除实现细节
接口文档保留纯契约，删除内部实现
编号连续（01-11），语义清晰
通过交叉引用连接相关文档，避免重复

## 主要变更 ### 文档重构（减少 1199 行，-23%） - 01-架构设计.md: 503→369 行 (-27%)，删除 DDL/配置示例，精简鉴权/存储描述 - 02-接口文档.md: 1313→570 行 (-57%)，删除 Go 接口/Orchestrator 实现/配置管理 - 07-成本控制.md: 65→59 行 (-9%)，代码块替换为文件引用 ### 文档编号规范化 - 08-功能创意.md → 删除（内容整合到 README.md "功能扩展方向"） - 10-Eino框架与编排设计.md → 08-Eino框架与编排设计.md - 情景切换.md → 09-情景切换.md - 12-鉴权体系.md → 10-鉴权体系.md - 13-令牌桶限流.md → 11-令牌桶限流.md ### 交叉引用更新 - 01-架构设计.md: 更新对鉴权体系/令牌桶限流的引用为新编号 - README.md: 更新文档索引表、推荐阅读顺序、新增功能扩展方向 ### 删除过时文档 - 09-技术名词解释.md（内容已整合到 03-技术选型.md） - 10-Eino重构方案.md（历史记录，已完成） - 11-Eino框架技术文档.md（已合并到 08） - 情景切换功能完整文档.md（已规范化为 09） ## 重构原则 - 架构文档聚焦系统结构，移除实现细节 - 接口文档保留纯契约，删除内部实现 - 编号连续（01-11），语义清晰 - 通过交叉引用连接相关文档，避免重复

huanghaosheng added 2 commits 2026-06-21 14:52:00 +08:00

docs: 重构文档结构，规范编号并整合冗余内容 032de796c8

## 主要变更

### 文档重构（减少 1199 行，-23%）
- 01-架构设计.md: 503→369 行 (-27%)，删除 DDL/配置示例，精简鉴权/存储描述
- 02-接口文档.md: 1313→570 行 (-57%)，删除 Go 接口/Orchestrator 实现/配置管理
- 07-成本控制.md: 65→59 行 (-9%)，代码块替换为文件引用

### 文档编号规范化
- 08-功能创意.md → 删除（内容整合到 README.md "功能扩展方向"）
- 10-Eino框架与编排设计.md → 08-Eino框架与编排设计.md
- 情景切换.md → 09-情景切换.md
- 12-鉴权体系.md → 10-鉴权体系.md
- 13-令牌桶限流.md → 11-令牌桶限流.md

### 交叉引用更新
- 01-架构设计.md: 更新对鉴权体系/令牌桶限流的引用为新编号
- README.md: 更新文档索引表、推荐阅读顺序、新增功能扩展方向

### 删除过时文档
- 09-技术名词解释.md（内容已整合到 03-技术选型.md）
- 10-Eino重构方案.md（历史记录，已完成）
- 11-Eino框架技术文档.md（已合并到 08）
- 情景切换功能完整文档.md（已规范化为 09）

## 重构原则
- 架构文档聚焦系统结构，移除实现细节
- 接口文档保留纯契约，删除内部实现
- 编号连续（01-11），语义清晰
- 通过交叉引用连接相关文档，避免重复

Merge pull request 'docs: 重构文档结构，规范编号并整合冗余内容' (#181 ) from docs/sync-docs into develop c094fe0867

Reviewed-on: http://8.161.227.145:3000/XEngineers/CamTalk/pulls/181

huanghaosheng merged commit ad5d90e344 into v2

2026-06-21 14:52:06 +08:00

huanghaosheng referenced this issue from a commit

2026-06-21 14:52:07 +08:00

Merge pull request 'docs: 重构文档结构，规范编号并整合冗余内容' (#182) from develop into v2

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: XEngineers/CamTalk#182