Files
DevFlow/docs/INDEX.md
绝尘 98393b4908 新增: 初始化 DevFlow 项目仓库
Tauri 2 + Vue 3 + Vite 6 桌面应用,Rust workspace 含 13 个 crate
(df-ai / df-storage / df-workflow / df-core / df-execute 等)。
核心能力:AI 聊天 agentic 循环(工具调用+人工审批)、工作流引擎、
任务/想法/项目/阶段管理、可追溯性,及配套前端组件。
2026-06-12 01:31:05 +08:00

110 lines
5.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# DevFlow 文档索引
> 创建: 2026-06-10 | 当前阶段: Phase 2 本地优先开发流程验证
> 更新: 2026-06-11 | 清理 60% 功能,聚焦核心链路
---
## 目录结构
```
docs/
├── README.md # 快速开始与文档导航
├── 使用指南/ # 用户文档
│ └── 使用手册.html # 完整使用指南HTML
├── INDEX.md # 本文件 — 文档导航
├── 01-技术文档/ # 技术专题研究
│ ├── SQLite-CRUD模式.md # CRUD 层设计模式
│ └── Tauri-IPC模式.md # Tauri IPC 设计模式
├── 02-架构设计/ # 架构方案、设计决策、迁移记录
│ ├── Phase1架构决策.md # Phase 1 关键架构决策
│ ├── 业务系统设计.md # 业务系统设计
│ ├── 前后端类型对齐.md # Rust/TS 类型对齐规范
│ ├── 对抗论证裁决报告.md # 60% 功能清理决策
│ └── 产品定位调整.md # 新定位:本地优先个人开发流程驾驶舱
├── 03-模块文档/ # 各功能模块实现文档
│ ├── df-storage-存储层.md # 存储层概览
│ ├── df-workflow-工作流引擎.md # 工作流引擎概览
│ ├── df-nodes-节点集合.md # 8 种节点概览
│ ├── df-ai-AI集成模块.md # AI Provider 集成
│ └── 想法探索-对抗式评估.md # 想法池对抗评估设计
├── 04-功能迭代/ # 功能开发过程记录
│ ├── DEVFLOW-1.CRUD层实施.md # CRUD 层实施记录
│ ├── DEVFLOW-2.IPC桥接实施.md # IPC 桥接实施记录
│ ├── DEVFLOW-3.Store对接实施.md # Store 对接实施记录
│ ├── DEVFLOW-4.端到端验证.md # 端到端验证记录
│ ├── DEVFLOW-5.功能清理.md # 60% 功能清理记录
│ └── DEVFLOW-6.想法池开发.md # 想法池基础功能开发
├── 05-代码审查/ # 审查报告、代码质量
│ └── 代码审查报告.md # 首轮代码审查结果
├── 06-前端开发/ # 前端分析、优化
│ ├── View改造指南.md # 硬编码 → Store → API 迁移指南
│ └── 组件设计规范.md # Vue 3 组件设计规范
├── 07-项目管理/ # 项目状态、功能清单、版本管理
│ ├── Phase1任务清单.md # Phase 1 任务清单
│ ├── Phase2计划.md # Phase 2 开发计划
│ └── PROGRESS.md # 项目进展与交接记录
└── 08-用户指南/ # 用户手册、配置指南
├── 快速上手.md # 5分钟快速上手
├── 配置指南.md # AI 配置、Git 集成
└── 常见问题.md # FAQ 和故障排除
```
---
## 快速导航
| 分类 | 入口 | 说明 |
|------|------|------|
| 🚀 快速开始 | [README.md](./README.md) | 安装、启动、快速上手 |
| 📖 使用指南 | [使用指南/](./使用指南/) | 完整交互式使用手册 |
| 📋 项目进度 | [PROGRESS.md](../PROGRESS.md) | 实时项目进展与状态 |
| ⚙️ 技术文档 | [01-技术文档/](./01-技术文档/) | SQLite CRUD、Tauri IPC 等技术专题 |
| 🏗️ 架构设计 | [02-架构设计/](./02-架构设计/) | 架构方案、设计决策、产品定位调整 |
| 🔧 模块文档 | [03-模块文档/](./03-模块文档/) | 各 Crate 模块实现与设计 |
| 📈 功能迭代 | [04-功能迭代/](./04-功能迭代/) | DEVFLOW-N 系列功能开发过程 |
| 🔍 代码审查 | [05-代码审查/](./05-代码审查/) | 审查报告、代码质量分析 |
| 🎨 前端开发 | [06-前端开发/](./06-前端开发/) | Vue 3 前端分析、优化、迁移指南 |
| 📊 项目管理 | [07-项目管理/](./07-项目管理/) | 任务清单、开发计划、进度跟踪 |
| 📚 用户指南 | [08-用户指南/](./08-用户指南/) | 快速上手、配置指南、FAQ |
---
## 新文档放置规则
| 文档类型 | 放置位置 |
|----------|----------|
| 技术专题研究 | `01-技术文档/<主题名>.md` |
| 架构设计/改进方案 | `02-架构设计/` |
| Crate 模块实现文档 | `03-模块文档/` |
| 功能开发过程记录 | `04-功能迭代/DEVFLOW-N.<名称>.md` |
| 代码审查/走查报告 | `05-代码审查/` |
| 前端优化/迁移指南 | `06-前端开发/` |
| 项目状态/任务清单 | `07-项目管理/` |
| 用户手册/配置指南 | `08-用户指南/` |
---
## 核心文档速查
| 文档 | 路径 | 说明 |
|------|------|------|
| 架构设计 | `../ARCHITECTURE.md` | 22,745 字完整架构文档 |
| 项目进展 | `../PROGRESS.md` | 工作进展与交接 |
| Crate 结构 | `../ARCHITECTURE.md#四crate-结构` | 13 个 Crate 概览 |
| 数据模型 | `../ARCHITECTURE.md#六数据模型` | SQLite 表结构定义 |
| Phase 规划 | `../ARCHITECTURE.md#八phase-规划` | 5 个 Phase 路线图 |
---
## 技术栈
| 层 | 技术 | 说明 |
|----|------|------|
| Desktop | Tauri v2 | Rust 后端 + WebView 前端 |
| Frontend | Vue 3 + TypeScript + Pinia | Arco Design 组件库 |
| Engine | Rust Workspace (13 crate) | 多 crate 架构 |
| Storage | SQLite (rusqlite) | 本地优先,零运维 |
| AI | Multi-Provider | Claude/GLM/DeepSeek/OpenAI 兼容 |
| Build | Bun + Vite | 前端构建 |