名称: Joan 工作流
描述: 当用户询问关于 "joan"、"pods"、"workspace"、"domain knowledge"、"context sync"、"joan init"、"joan todo",或需要了解 Joan 知识管理系统如何运作的指导时,应使用此技能。提供关于 pods、todos、plans 和 workspace 管理的工作流指导。
版本: 0.1.0
Joan 是一个基于工作区的、用于 AI 辅助开发的知识与任务管理系统。本技能涵盖何时及如何使用 Joan 的核心概念。
工作区是 Joan 中的顶级组织单元。每个工作区包含:
- Pods: 版本化的领域知识文档
- Todos: 限定于该工作区的任务
- Plans: 与任务关联的实现规范
- Members: 具有角色(管理员、成员)的团队成员
Pods 是包含领域知识的版本化 Markdown 文档。使用 Pods 来:
- 记录项目架构和设计决策
- 存储领域特定的术语和业务规则
- 在团队成员和 AI 助手之间共享知识
- 维护随着项目演进而更新的活文档
Pod 生命周期:
1. 使用 joan pod create 在本地创建
2. 在 .joan/pods/ 目录下编辑 Markdown 文件
3. 使用 joan pod push 推送到服务器
4. 使用 joan pod pull 拉取最新版本
Todos 是限定于某个工作区的任务。使用 Todos 来:
- 跟踪团队成员的工作项
- 分配任务并设置优先级
- 将实现计划与任务关联
Todo 工作流:
1. 使用 joan todo create 创建
2. 使用 joan todo list 列出
3. 随着工作进展更新状态
4. 完成后归档
Plans 是与 Todos 关联的实现规范。使用 Plans 来:
- 记录功能将如何实现
- 将复杂任务分解为步骤
- 与团队共享实现方法
joan init # 交互式选择工作区
joan init -w <workspace-id> # 非交互式,指定特定工作区
joan status # 显示项目和认证状态
joan pod list # 列出已跟踪的 pods
joan pod list --all # 列出工作区中的所有 pods
joan pod add # 将工作区中的 pods 添加到项目
joan pod create # 在本地创建新 pod
joan pod pull # 从服务器拉取 pods
joan pod push # 将本地 pods 推送到服务器
joan pod open # 在浏览器中打开 pod
joan todo list # 列出已跟踪 pods 相关的 todos
joan todo list --mine # 列出分配给我的 todos
joan todo create # 创建新 todo
joan todo update <id> # 更新 todo 字段
joan todo archive <id> # 归档已完成的 todo
joan plan list <todo-id> # 列出某个 todo 的 plans
joan plan create <todo-id> # 创建实现计划
joan plan pull <todo-id> # 从服务器拉取 plans
joan plan push <todo-id> # 将 plans 推送到服务器
joan context claude # 生成包含 Joan 上下文的 CLAUDE.md 文件
joan init 将项目连接到工作区joan context claude 将上下文注入 CLAUDE.mdjoan pod list --alljoan pod addjoan pod pulljoan pod push 和 joan todo pushjoan pod createjoan pod pushjoan context claudeJoan 在 https://joan.land/mcp/joan 提供了一个 MCP 服务器,包含以下工具:
- list_workspaces - 列出可访问的工作区
- list_pods - 列出工作区中的 pods
- get_pod - 获取 pod 内容
MCP 服务器使用 OAuth 2.1 认证。请先通过 CLI 使用 joan auth login 进行认证。
Joan 将项目配置存储在 .joan/config.yaml 中:
workspace_id: <uuid>
tracked_pods:
- name: "Pod 名称"
id: <uuid>
Pods 在本地以 Markdown 文件形式存储在 .joan/pods/ 目录下。
joan context claude