288 lines
7.6 KiB
Markdown
288 lines
7.6 KiB
Markdown
# 📚 TraceStudio 文档导航
|
||
|
||
版本：**v2.0 (Unified)**
|
||
最后更新：2025-01-08
|
||
状态：✅ 完全融合
|
||
|
||
---
|
||
|
||
## 📖 核心文档
|
||
|
||
### 🎯 [快速参考指南](./QUICK_REFERENCE.md)
|
||
**5 分钟了解全部功能**
|
||
- 核心概念速览
|
||
- 快速开始示例
|
||
- 10 个内置节点速查表
|
||
- API 快速参考
|
||
- 常用工作流模式
|
||
- 故障排除
|
||
|
||
### 🏛️ [融合完成报告](./FUSION_COMPLETION_REPORT.md)
|
||
**完整的融合过程总结**
|
||
- 执行摘要（关键成果）
|
||
- 融合架构（三层系统）
|
||
- 文件结构（融合后）
|
||
- 功能对比（版本演进）
|
||
- 测试验证（100% 通过）
|
||
- 向后兼容性验证
|
||
- 性能对比
|
||
- 迁移清单
|
||
|
||
### 🎓 [融合完成摘要](./FUSION_COMPLETE.md)
|
||
**融合要点速览**
|
||
- 融合概览表
|
||
- 核心融合模块说明
|
||
- 文件清理列表
|
||
- 向后兼容性确认
|
||
- 关键设计决策
|
||
- 使用指南
|
||
- 实际对比
|
||
|
||
### 🔧 [架构对比分析](./ARCHITECTURE_COMPARISON.md)
|
||
**两个版本的深度对比**
|
||
- 快速对比表
|
||
- 架构深度对比
|
||
- 节点系统对比
|
||
- 连线系统对比
|
||
- 维度转换引擎对比
|
||
- 函数节点对比
|
||
- 执行流程对比
|
||
- 使用场景决策
|
||
- 架构融合方案
|
||
- 建议步骤
|
||
|
||
---
|
||
|
||
## 📚 功能文档
|
||
|
||
### 🚀 [高级功能完整指南](./ADVANCED_FEATURES.md)
|
||
**所有高级特性的详细说明**
|
||
- 架构概述
|
||
- 特殊节点详解
|
||
- 边类型和维度转换
|
||
- 数组操作节点
|
||
- 工作流模式
|
||
- 设计原理
|
||
- 性能指标
|
||
|
||
### 🏗️ [后端架构完整说明](./BACKEND_ARCHITECTURE_COMPLETE.md)
|
||
**系统的全面技术文档**
|
||
- 整体架构
|
||
- 核心模块
|
||
- 节点系统
|
||
- 工作流执行
|
||
- 缓存系统
|
||
- 工作流管理
|
||
- 前后端集成
|
||
|
||
---
|
||
|
||
## 📂 设计文档
|
||
|
||
### 📋 [节点设计指南](./CUSTOM_NODE_DESIGN.md)
|
||
**如何创建自定义节点**
|
||
- 基础节点
|
||
- 高级节点
|
||
- 最佳实践
|
||
- 示例代码
|
||
|
||
### 🗂️ [目录结构说明](./DIRECTORY_STRUCTURE.md)
|
||
**项目文件组织**
|
||
- 目录概览
|
||
- 各目录用途
|
||
- 文件说明
|
||
|
||
### 👁️ [文件查看器指南](./FILE_VIEWER_GUIDE.md)
|
||
**如何使用文件浏览器**
|
||
|
||
### 🌐 [工作流访问指南](./LAN_ACCESS.md)
|
||
**如何通过 LAN 访问工作流系统**
|
||
|
||
---
|
||
|
||
## 🎬 快速导航
|
||
|
||
### 我想...
|
||
|
||
**🔰 学习基础概念** → [快速参考指南](./QUICK_REFERENCE.md)
|
||
- 5 分钟了解全部概念
|
||
- 快速上手示例
|
||
|
||
**📊 理解系统架构** → [后端架构完整说明](./BACKEND_ARCHITECTURE_COMPLETE.md)
|
||
- 系统各部分如何配合
|
||
- 数据流转过程
|
||
|
||
**🛠️ 创建自定义节点** → [节点设计指南](./CUSTOM_NODE_DESIGN.md)
|
||
- 如何开发新节点
|
||
- 代码示例
|
||
|
||
**🔍 了解高级特性** → [高级功能完整指南](./ADVANCED_FEATURES.md)
|
||
- 特殊节点详解
|
||
- 维度转换原理
|
||
|
||
**🔄 比较两个版本** → [架构对比分析](./ARCHITECTURE_COMPARISON.md)
|
||
- 普通版 vs Advanced 版
|
||
- 融合方案说明
|
||
|
||
**✅ 查看融合过程** → [融合完成报告](./FUSION_COMPLETION_REPORT.md)
|
||
- 完整的融合总结
|
||
- 测试验证结果
|
||
|
||
**⚡ 快速开始** → [融合完成摘要](./FUSION_COMPLETE.md)
|
||
- 3 个核心改进
|
||
- 立即行动建议
|
||
|
||
---
|
||
|
||
## 🔗 文档关系图
|
||
|
||
```
|
||
START（你在这里）
|
||
↓
|
||
┌─────────────────────────────────────────┐
|
||
│ 选择你的学习路径 │
|
||
└─────────────────────────────────────────┘
|
||
↓
|
||
├─→ 【新手】快速上手
|
||
│ └─→ QUICK_REFERENCE.md
|
||
│ └─→ ADVANCED_FEATURES.md（可选）
|
||
│
|
||
├─→ 【开发者】深入理解
|
||
│ ├─→ BACKEND_ARCHITECTURE_COMPLETE.md
|
||
│ ├─→ CUSTOM_NODE_DESIGN.md
|
||
│ └─→ ADVANCED_FEATURES.md
|
||
│
|
||
├─→ 【架构师】系统设计
|
||
│ ├─→ ARCHITECTURE_COMPARISON.md
|
||
│ ├─→ FUSION_COMPLETION_REPORT.md
|
||
│ └─→ BACKEND_ARCHITECTURE_COMPLETE.md
|
||
│
|
||
└─→ 【运维】部署配置
|
||
├─→ DIRECTORY_STRUCTURE.md
|
||
├─→ LAN_ACCESS.md
|
||
└─→ FILE_VIEWER_GUIDE.md
|
||
```
|
||
|
||
---
|
||
|
||
## 📖 按主题索引
|
||
|
||
### 功能特性
|
||
- 🎯 [特殊节点](./ADVANCED_FEATURES.md#特殊节点)
|
||
- 🔗 [连线分类](./ADVANCED_FEATURES.md#连线类型)
|
||
- 📐 [维度转换](./ADVANCED_FEATURES.md#维度转换)
|
||
- 🔄 [函数嵌套](./ADVANCED_FEATURES.md#函数节点嵌套)
|
||
- 🎪 [工作流模式](./ADVANCED_FEATURES.md#常用工作流模式)
|
||
|
||
### 系统设计
|
||
- 🏛️ [整体架构](./BACKEND_ARCHITECTURE_COMPLETE.md#整体架构)
|
||
- 📦 [核心模块](./BACKEND_ARCHITECTURE_COMPLETE.md#核心模块)
|
||
- 🔃 [节点系统](./BACKEND_ARCHITECTURE_COMPLETE.md#节点系统)
|
||
- ⚙️ [执行流程](./BACKEND_ARCHITECTURE_COMPLETE.md#工作流执行流程)
|
||
|
||
### 开发指南
|
||
- 📝 [创建节点](./CUSTOM_NODE_DESIGN.md#创建节点)
|
||
- 🧪 [测试节点](./CUSTOM_NODE_DESIGN.md#节点测试)
|
||
- ✨ [最佳实践](./CUSTOM_NODE_DESIGN.md#最佳实践)
|
||
- 📚 [代码示例](./CUSTOM_NODE_DESIGN.md#示例代码)
|
||
|
||
---
|
||
|
||
## 📊 文档统计
|
||
|
||
| 文档 | 类型 | 大小 | 更新日期 |
|
||
|------|------|------|--------|
|
||
| QUICK_REFERENCE.md | 参考 | 800+ 行 | 2025-01-08 |
|
||
| FUSION_COMPLETION_REPORT.md | 报告 | 900+ 行 | 2025-01-08 |
|
||
| FUSION_COMPLETE.md | 摘要 | 500+ 行 | 2025-01-08 |
|
||
| ARCHITECTURE_COMPARISON.md | 分析 | 600+ 行 | 2025-01-08 |
|
||
| ADVANCED_FEATURES.md | 指南 | 800+ 行 | 之前 |
|
||
| BACKEND_ARCHITECTURE_COMPLETE.md | 设计 | 1000+ 行 | 之前 |
|
||
| CUSTOM_NODE_DESIGN.md | 教程 | 500+ 行 | 之前 |
|
||
| 其他文档 | 综合 | - | 之前 |
|
||
|
||
**总计：** 6,000+ 行文档
|
||
|
||
---
|
||
|
||
## 🎓 学习路线
|
||
|
||
### 第 1 天：基础（1-2 小时）
|
||
1. 阅读 [快速参考指南](./QUICK_REFERENCE.md) - 20 分钟
|
||
2. 运行示例代码 - 20 分钟
|
||
3. 理解 10 个内置节点 - 20 分钟
|
||
4. **目标：能创建基本工作流** ✅
|
||
|
||
### 第 2 天：进阶（1-2 小时）
|
||
1. 学习 [高级功能](./ADVANCED_FEATURES.md) - 30 分钟
|
||
2. 理解维度转换 - 20 分钟
|
||
3. 创建函数节点 - 20 分钟
|
||
4. **目标：能使用高级特性** ✅
|
||
|
||
### 第 3 天：深入（2-3 小时）
|
||
1. 研究 [系统架构](./BACKEND_ARCHITECTURE_COMPLETE.md) - 40 分钟
|
||
2. 学习 [节点设计](./CUSTOM_NODE_DESIGN.md) - 40 分钟
|
||
3. 创建自定义节点 - 40 分钟
|
||
4. **目标：能扩展系统** ✅
|
||
|
||
### 第 4-5 天：精通（根据需要）
|
||
1. 深入研究源码
|
||
2. 参与系统开发
|
||
3. **目标：成为系统专家** ✅
|
||
|
||
---
|
||
|
||
## 🔍 文档搜索
|
||
|
||
### 我想找...
|
||
|
||
**概念 / 原理**
|
||
- 节点系统 → 搜索 `BACKEND_ARCHITECTURE_COMPLETE.md`
|
||
- 维度转换 → 搜索 `ADVANCED_FEATURES.md`
|
||
- 工作流执行 → 搜索 `BACKEND_ARCHITECTURE_COMPLETE.md`
|
||
|
||
**代码示例**
|
||
- 创建节点 → 搜索 `CUSTOM_NODE_DESIGN.md`
|
||
- 执行工作流 → 搜索 `QUICK_REFERENCE.md`
|
||
- 高级特性 → 搜索 `ADVANCED_FEATURES.md`
|
||
|
||
**故障排除**
|
||
- 常见错误 → 搜索 `QUICK_REFERENCE.md#常见错误`
|
||
- 性能问题 → 搜索 `QUICK_REFERENCE.md#性能调优`
|
||
|
||
**架构设计**
|
||
- 系统概览 → 搜索 `BACKEND_ARCHITECTURE_COMPLETE.md`
|
||
- 版本对比 → 搜索 `ARCHITECTURE_COMPARISON.md`
|
||
- 融合过程 → 搜索 `FUSION_COMPLETION_REPORT.md`
|
||
|
||
---
|
||
|
||
## ✅ 文档检查清单
|
||
|
||
- [x] 快速参考指南已创建
|
||
- [x] 融合报告已完成
|
||
- [x] 架构对比已分析
|
||
- [x] 所有导入已更新
|
||
- [x] 测试已验证 (100% 通过)
|
||
- [x] 代码已清理
|
||
- [x] 文档已链接
|
||
|
||
---
|
||
|
||
## 📞 反馈和改进
|
||
|
||
如果你发现文档中有遗漏或错误，请联系开发团队。
|
||
|
||
---
|
||
|
||
**准备好开始了吗？** 👇
|
||
|
||
👉 [从快速参考指南开始 →](./QUICK_REFERENCE.md)
|
||
|
||
---
|
||
|
||
**最后更新：** 2025-01-08
|
||
**状态：** ✅ 完全就绪
|
||
**版本：** v2.0 (Unified)
|
||
|