docs: 扁平化目录结构,优化文档为 Coding Agent 可读格式
- 移除 Obsidian 特有语法(callout、wikilinks、YAML frontmatter) - 目录结构从 3 层嵌套扁平化为编号文件(01~09) - 新增 docs/README.md 文档索引与推荐阅读顺序 - 精简冗余解释,保留所有代码块和实现参考 - CLAUDE.md 全面中文化
This commit is contained in:
27
docs/README.md
Normal file
27
docs/README.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# CamTalk 设计文档
|
||||
|
||||
CamTalk 是一款多模态实时 AI 视觉对话助手。用户通过摄像头和麦克风与 AI 交互,AI 理解视觉场景和语音输入后给出自然回应。
|
||||
|
||||
## 文档索引
|
||||
|
||||
| 文档 | 说明 |
|
||||
|------|------|
|
||||
| [01-项目概述](01-项目概述.md) | 项目目标、核心挑战、交付物 |
|
||||
| [02-系统架构](02-系统架构.md) | 三层架构、技术栈、核心交互流程、前后端模块、存储策略、部署架构 |
|
||||
| [03-接口文档](03-接口文档.md) | WebSocket 协议、REST API、数据模型、错误码、连接管理(**实现时首先阅读**) |
|
||||
| [04-技术选型](04-技术选型.md) | 持久化层(PostgreSQL)和前端边缘处理层的选型对比与决策理由 |
|
||||
| [05-用户故事](05-用户故事.md) | P0/P1/P2 用户故事、验收标准、优先级决策依据 |
|
||||
| [06-语音交互](06-语音交互.md) | VAD → STT → LLM → TTS 全链路、延迟优化 |
|
||||
| [07-视觉理解](07-视觉理解.md) | 帧采样策略、图像编码、多模态 LLM 输入机制 |
|
||||
| [08-成本控制](08-成本控制.md) | 智能采样、端云协同、模型分级、缓存复用 |
|
||||
| [09-技术名词解释](09-技术名词解释.md) | 前端/后端/AI 服务技术名词简明解释 |
|
||||
|
||||
## 推荐阅读顺序
|
||||
|
||||
1. **01-项目概述** — 了解项目目标
|
||||
2. **02-系统架构** — 理解三层架构和技术栈全貌
|
||||
3. **03-接口文档** — 前后端通信契约,实现时的最高依据
|
||||
4. **04-技术选型** — 了解为什么选这些技术
|
||||
5. **05-用户故事** — 明确功能优先级
|
||||
6. **06~08** — 各技术领域的详细设计
|
||||
7. **09-技术名词解释** — 遇到不熟悉的名词时查阅
|
||||
Reference in New Issue
Block a user