修复: AR-3 审批 reason 查项目名拼对象名（用户再反馈 P0）
build_approval_reason 改 async + 接收 db，对 delete/restore/purge/update/bind/create_task 的 id/project_id 查 ProjectRepo.get_by_id 拼「项目名」(id=x)（原只拼裸 id，用户反馈'只返回 ID 不知道是什么数据'） 新增 resolve_project_label helper；process_tool_calls 调用改 await 来源 aichat审查报告 第二章 + 用户 2026-06-14 再反馈;cargo 0 err
This commit is contained in:
225
docs/08-用户指南/使用手册-2026-06-12.md
Normal file
225
docs/08-用户指南/使用手册-2026-06-12.md
Normal file
@@ -0,0 +1,225 @@
|
||||
# DevFlow 使用手册
|
||||
|
||||
> "本地优先的个人开发流程驾驶舱"
|
||||
|
||||
```mermaid
|
||||
graph LR
|
||||
A[想法池] -->|评估| B[项目管理]
|
||||
B -->|创建| C[任务队列]
|
||||
C -->|执行| D[工作流引擎]
|
||||
D -->|合并| E[Git仓库]
|
||||
```
|
||||
|
||||
```mermaid
|
||||
graph LR
|
||||
A[想法] -->|收集| B[任务]
|
||||
B -->|分配| C[分支]
|
||||
C -->|自动化| D[工作流]
|
||||
D -->|提交| E[代码]
|
||||
```
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 运行应用
|
||||
```bash
|
||||
bun install
|
||||
bun run tauri dev
|
||||
```
|
||||
|
||||
### 一句话功能
|
||||
你的项目流程，本地跑，AI 辅助，数据不出门
|
||||
|
||||
## 🎯 核心价值链
|
||||
|
||||
### 任务 → 分支 → 工作流 → 合并
|
||||
|
||||
#### 1. 任务管理
|
||||
- **创建任务**：指定项目、标题、分支名
|
||||
- **状态流转**：待开始 → 进行中 → 待审查 → 已合并
|
||||
- **优先级**：P0（紧急）到 P3（低）
|
||||
|
||||
#### 2. 分支绑定
|
||||
```bash
|
||||
# 创建任务时自动生成分支
|
||||
# 例如：feature/devflow-improve
|
||||
```
|
||||
|
||||
#### 3. 工作流执行
|
||||
- **环境检查**：依赖验证、端口检查
|
||||
- **运行测试**：单元测试、集成测试
|
||||
- **构建产物**：打包、优化、部署
|
||||
|
||||
#### 4. 实时监控
|
||||
- **事件日志**：每个节点执行状态
|
||||
- **错误处理**：失败重试、人工审批
|
||||
|
||||
## 📋 功能模块
|
||||
|
||||
### 🤖 AI Chat
|
||||
- **单 Provider**：简化配置
|
||||
- **工具调用**：代码生成、分析
|
||||
- **流式响应**：实时输出
|
||||
|
||||
### 💡 想法池
|
||||
- **轻量版**：聚焦核心
|
||||
- **预留对抗评估**：后续升级
|
||||
|
||||
### 📂 项目管理
|
||||
- **多项目支持**：切换不同仓库
|
||||
- **状态同步**：与 Git 分支联动
|
||||
|
||||
### 📚 知识库（收藏夹）
|
||||
- **静态收集**：个人经验碎片
|
||||
- **分类管理**：审查规则、Prompt模板、踩坑经验
|
||||
- **快速搜索**：标题、标签、内容
|
||||
|
||||
### ⚙️ 设置
|
||||
- **AI 配置**：Provider、模型选择
|
||||
- **通用设置**：主题、语言
|
||||
|
||||
## 🔧 核心功能详解
|
||||
|
||||
### 任务操作流程
|
||||
|
||||
#### 1. 创建任务
|
||||
```typescript
|
||||
// 在项目详情页点击 "+ 新任务"
|
||||
- 填写任务标题
|
||||
- 选择项目
|
||||
- （可选）指定分支名
|
||||
```
|
||||
|
||||
#### 2. 任务执行
|
||||
- **自动创建分支**：`git checkout -b feature/task-name`
|
||||
- **绑定任务 ID**：Git commit 自动关联
|
||||
- **状态同步**：合并后任务标记为已完成
|
||||
|
||||
#### 3. 工作流运行
|
||||
```typescript
|
||||
// 点击"运行测试工作流"
|
||||
1. 环境检查 → 验证依赖
|
||||
2. 运行测试 → 执行单元测试
|
||||
3. 构建产物 → 生成发布包
|
||||
```
|
||||
|
||||
### AI Chat 使用
|
||||
|
||||
#### 基础对话
|
||||
- 直接提问
|
||||
- 代码审查
|
||||
- 问题诊断
|
||||
|
||||
#### 工具调用
|
||||
- **生成代码**：根据描述生成完整实现
|
||||
- **文件操作**：读取、编辑项目文件
|
||||
- **Git 操作**：提交、推送、合并
|
||||
|
||||
## 💡 想法池功能
|
||||
|
||||
### 创建想法
|
||||
```typescript
|
||||
// 简单记录
|
||||
- 标题：一句话描述
|
||||
- 描述：详细说明（可选）
|
||||
- 优先级：P1~P3
|
||||
- 标签：便于分类
|
||||
```
|
||||
|
||||
### 状态管理
|
||||
- **草稿**：初始想法
|
||||
- **活跃**：正在考虑
|
||||
- **已完成**：已实现或放弃
|
||||
|
||||
### 未来升级
|
||||
- **对抗式评估**：正方+反方+分析师
|
||||
- **智能推荐**：相关想法关联
|
||||
|
||||
## 🌟 特色功能
|
||||
|
||||
### 本地优先
|
||||
- **数据存储**：SQLite 本地数据库
|
||||
- **无需网络**：基础功能离线可用
|
||||
- **隐私保护**：代码不出本地
|
||||
|
||||
### 实时监控
|
||||
- **事件流**：WebSocket 实时更新
|
||||
- **进度显示**：工作流执行进度
|
||||
- **错误提示**：失败原因分析
|
||||
|
||||
### 工作流节点
|
||||
```typescript
|
||||
// 支持的节点类型
|
||||
- Script：执行 Shell 命令
|
||||
- Human：人工审批
|
||||
- Condition：条件判断
|
||||
- Parallel：并行执行
|
||||
```
|
||||
|
||||
## 📊 使用统计
|
||||
|
||||
### 个人效能
|
||||
- **任务完成率**：按时完成任务比例
|
||||
- **分支管理**：活跃分支数量
|
||||
- **工作流成功率**：自动执行成功率
|
||||
|
||||
### 项目进度
|
||||
- **阶段分布**：规划/开发/测试/上线
|
||||
- **任务积压**：待处理任务数量
|
||||
- **开发速度**：每周完成任务数
|
||||
|
||||
## 🎨 界面说明
|
||||
|
||||
### 颜色系统
|
||||
- **主色**：紫色（#6B46C1）
|
||||
- **成功色**：绿色（#10B981）
|
||||
- **警告色**：黄色（#F59E0B）
|
||||
- **错误色**：红色（#EF4444）
|
||||
|
||||
### 图标含义
|
||||
- 📋：待开始
|
||||
- 🔨：进行中
|
||||
- 👀：待审查
|
||||
- ✅：已合并
|
||||
- 🗑️：已废弃
|
||||
|
||||
## ⚠️ 注意事项
|
||||
|
||||
### Git 集成
|
||||
- 必须初始化 Git 仓库
|
||||
- 配置用户邮箱和姓名
|
||||
- 保持分支命名规范
|
||||
|
||||
### AI 配置
|
||||
- 需要有效的 API Key
|
||||
- 检查网络连接
|
||||
- 关注 Token 使用量
|
||||
|
||||
### 工作流设计
|
||||
- 避免长时间阻塞操作
|
||||
- 设置合理的超时时间
|
||||
- 保留人工干预接口
|
||||
|
||||
## 🔄 更新日志
|
||||
|
||||
### v1.0 (2026-06-11)
|
||||
- ✅ 完成核心功能
|
||||
- ✅ 任务管理系统
|
||||
- ✅ 工作流引擎
|
||||
- ✅ AI Chat 集成
|
||||
- ✅ 本地数据存储
|
||||
|
||||
### 计划功能
|
||||
- 🔄 想法对抗式评估
|
||||
- 🔄 更多工作流节点
|
||||
- 🔄 团队协作功能
|
||||
- 🔄 数据导出功能
|
||||
|
||||
## 📞 支持
|
||||
|
||||
- 问题反馈：创建 Issue
|
||||
- 功能建议：想法池提交
|
||||
- 使用交流：Discord 社区
|
||||
|
||||
---
|
||||
|
||||
**记住**：这不是全流程操作系统，而是专注于本地任务流程的工具。简单、实用、可靠。
|
||||
Reference in New Issue
Block a user