# Gateway 文档索引

本目录包含 Gateway 的完整文档。

## 文档维护规范

1. **先改文档，再动代码** - 新功能或重大修改需先完成文档更新、并完成审阅后，再进行代码实现
2. **文档分层，链接代码** - 关键实现需标注代码文件路径；格式：`module/file.py:function_name`
3. **简洁快照，日志分离** - 只记录已确认的需求和设计，避免推测和未确认的内容

---

## 核心文档

### [需求规划](./requirements.md)
**状态：** ✅ 已确认

已确认的功能需求和范围：
- Agent 生命周期管理
- 对话管理（Conversations）
- 消息路由（Routing）
- 两种 Agent 类型（个人助理、数字员工）
- 两种接入方式（内部、外部）
- 企业功能（可选）

### [架构设计](./architecture.md)
**状态：** ✅ 已确认

Gateway 的架构设计和核心模块：
- 分层架构（Core 层、API 层）
- 三大核心模块（Lifecycle、Conversations、Routing）
- 两种接入方式
- 企业功能

---

## 模块文档

### 核心模块（Core）

**状态：** ✅ 已创建

- [lifecycle.md](./core/lifecycle.md) - 生命周期管理模块
- [conversations.md](./core/conversations.md) - 对话管理模块
- [routing.md](./core/routing.md) - 消息路由模块

### API 文档

**状态：** ✅ 已创建

- [lifecycle.md](./api/lifecycle.md) - 生命周期管理 API
- [conversations.md](./api/conversations.md) - 对话管理 API
- [routing.md](./api/routing.md) - 消息路由 API

### 客户端文档

**状态：** ✅ 已创建

- [python.md](./client/python.md) - Python SDK 使用指南

---

## 使用指南

**状态：** ✅ 已创建

- [quickstart.md](./guides/quickstart.md) - 快速开始
- [internal-agent.md](./guides/internal-agent.md) - 内部 Agent 集成指南
- [external-agent.md](./guides/external-agent.md) - 外部 Agent 集成指南
- [personal-assistant.md](./guides/personal-assistant.md) - 个人助理型 Agent 配置
- [digital-employee.md](./guides/digital-employee.md) - 数字员工型 Agent 配置

---

## 其他文档

### [设计决策](./decisions.md)
**状态：** ✅ 保留

架构决策记录（ADR）。

### [部署指南](./deployment.md)
**状态：** ✅ 保留

部署方式和配置说明。

### 企业功能文档

**状态：** ✅ 保留（可选）

- [enterprise/overview.md](./enterprise/overview.md) - 企业功能概览
- [enterprise/implementation.md](./enterprise/implementation.md) - 企业功能实现

---

## 文档完成状态

### 已完成 ✅

1. **requirements.md** - 需求规划
2. **architecture.md** - 架构设计
3. **docs/README.md** - 文档索引（本文件）
4. **core/** - 核心模块文档（3 个文件）
5. **api/** - API 文档（3 个文件）
6. **client/** - 客户端文档（1 个文件）
7. **guides/** - 使用指南（5 个文件）

**总计：** 15 个文档文件已创建

---

## 相关文档

- [Agent Core 架构](../../agent/docs/architecture.md)：Agent 框架核心设计
- [Gateway README](../README.md)：项目概览
- [Gateway 客户端](../client/README.md)：客户端 SDK 和 CLI 工具