workflow.md 5.1 KB

开发工作流

本文档描述 Obsidian + Vibe Kanban + Claude Code 三者协作的工作流程

三者关系

┌─────────────────────────────────────────────────────────────────┐
│  Obsidian (文档中心 - 单一数据源)                                  │
│  路径: /Users/jamesw/dev_workspace/vibe-coding-cn                │
│  ├── 架构设计 (*.canvas)                                         │
│  ├── 需求文档                                                    │
│  └── 任务卡片 → 同步到 Kanban                                     │
└─────────────────────────────────────────────────────────────────┘
                         ↓ 读取文档 / 同步任务
┌─────────────────────────────────────────────────────────────────┐
│  Vibe Kanban (任务管理)                                           │
│  ├── Project: tg-live-game-hono                                  │
│  ├── Project ID: 7c6bb2ce-90a2-4e96-bc04-5facdcdb337f            │
│  └── 任务状态: todo → inprogress → inreview → done               │
└─────────────────────────────────────────────────────────────────┘
                         ↓ 领取任务 / 执行开发
┌─────────────────────────────────────────────────────────────────┐
│  Claude Code (代码开发)                                           │
│  工作目录: /Users/jamesw/dev_workspace/frontend/tg-live-game/    │
│           tg-live-game-hono                                      │
│  ├── 读取 Obsidian 架构文档                                       │
│  ├── 根据 Kanban 任务开发                                         │
│  └── 完成后更新任务状态                                            │
└─────────────────────────────────────────────────────────────────┘

工作流程

1. 需求设计阶段 (Obsidian)

在 Obsidian 的 canvas 中设计架构和需求:

  1. 打开相关的 .canvas 文件
  2. 添加新的组件/功能卡片
  3. 使用任务卡片格式标记待开发内容:

    任务YYYYMMDD-NN
    ─────────────────
    任务标题
    
    1. 需求描述
    2. 具体要求
    3. ...
    

2. 任务同步阶段 (Obsidian → Kanban)

当 canvas 有新的任务卡片时:

  1. Claude Code 读取 canvas 文件
  2. 解析新增的任务卡片
  3. 提取任务名称和描述
  4. 调用 Vibe Kanban API 创建任务

同步命令示例

"同步 d1-database.canvas 的新任务到 Kanban"

3. 开发阶段 (Claude Code)

  1. 从 Kanban 获取任务
  2. 读取 Obsidian 文档理解架构
  3. 在代码目录执行开发
  4. 完成后提交代码

4. 任务完成阶段

  1. 代码提交到 git
  2. 更新 Kanban 任务状态为 done
  3. 如有需要,更新 Obsidian 文档

文件路径映射

位置 路径 用途
Obsidian 文档 /Users/jamesw/dev_workspace/vibe-coding-cn/tg-live-game/tg-live-game-hono/ 架构设计、需求文档
代码仓库 /Users/jamesw/dev_workspace/frontend/tg-live-game/tg-live-game-hono/ 代码实现
Claude 配置 {代码仓库}/CLAUDE.md 项目关联配置

任务卡片规范

格式

任务YYYYMMDD-NN

任务标题

1. 第一个要求
2. 第二个要求
...

示例

任务20260101-01

数据库备份

1. 要求如下
2. 每天备份一次,文件要按照日期命名

解析规则

  • 任务编号: 任务YYYYMMDD-NN 格式,用于唯一标识
  • 任务标题: 编号后的第一行非空文本
  • 任务描述: 剩余所有内容

多项目协作

当任务涉及前后端同时开发时,参考父项目的工作流文档:[[../workflow]]

Claude Code 启动位置

# 仅后端开发
cd /Users/jamesw/dev_workspace/frontend/tg-live-game/tg-live-game-hono
claude

# 前后端协作(推荐)
cd /Users/jamesw/dev_workspace/frontend/tg-live-game
claude

关联任务格式

任务YYYYMMDD-NN-hono
─────────────────
后端:功能名称

project: tg-live-game-hono
related: 任务YYYYMMDD-NN-web

1. 需求描述

相关文件

  • [[architecture]] - 整体架构设计
  • [[auth-system]] - 认证鉴权系统
  • [[d1-database]] - 数据库设计
  • [[README]] - 项目概述
  • [[../workflow]] - 父项目工作流(多项目协作)
  • [[../_project]] - 父项目配置