Joan Workflow

当用户询问“joan”、“pods”、“workspace”、“domain knowledge”、“context sync”、“joan init”、“joan todo”,或需了解 Joan 知识管理系统运作方式时使用此技能。提供 pods、待办、计划及工作区管理的工作流指导。

安装

概览

什么是Joan Workflow

Joan Workflow 是一个专为 AI 辅助开发设计的基于工作区的知识与任务管理系统。它通过结构化的方式帮助团队组织项目知识、跟踪任务进展,并确保上下文在开发过程中持续同步。Joan 的核心设计理念是将知识文档、待办事项和实现计划整合在一个统一的工作流中,从而提升团队协作效率和代码质量。每个项目都被关联到一个或多个工作区(workspace),而工作区内包含版本化知识文档(称为 pods)、任务列表(todos)以及详细的实现方案(plans)。这种分层结构使得复杂项目的知识管理变得清晰有序。 系统支持本地与云端的双向同步机制,开发者可以在本地编辑 pods 或更新 todos,并通过命令行工具一键推送到服务器,供团队成员或 AI 助手访问。所有操作均通过简洁的 CLI 命令完成,例如 `joan pod create` 创建新知识文档,`joan todo list –mine` 查看个人分配的任务。此外,Joan 还提供 MCP(Model Context Protocol)集成能力,允许外部工具如 Claude 等 AI 模型通过标准接口获取工作区内的 pods 内容,从而实现智能上下文的注入。这种设计特别适合需要频繁与 AI 协作的开发场景,比如生成代码前自动加载相关架构说明或业务规则。 Joan 强调“活文档”(living documentation)的理念——即知识库应随项目演进而动态更新。无论是记录技术决策、存储领域术语,还是归档最佳实践,都可以通过 pods 实现。同时,它与 CLAUDE.md 等开发者配置文件深度集成,确保每次运行 `joan context claude` 时,最新的项目上下文都能被准确注入到 AI 助手的输入中。这不仅减少了重复沟通成本,也显著降低了因信息缺失导致的返工风险。

核心功能特点

  1. 基于工作区的知识管理体系,支持 pods、todos、plans 和成员角色的组织
  2. 版本化 markdown 文档管理,实现项目知识的持久化与可追溯
  3. CLI 驱动的操作流程,涵盖 pods 的创建、编辑、推送与拉取
  4. 任务追踪与优先级管理,支持按负责人筛选和状态更新
  5. MCP 协议集成,允许 AI 工具安全访问工作区知识内容
  6. 自动上下文生成功能,可将 Joan 环境信息注入 CLAUDE.md 文件

适用场景

当开发者启动一个新项目时,可以通过 `joan init` 快速将当前目录绑定至一个已有工作区,并选择相关的 pods 进行跟踪。这一步骤为后续的知识管理和任务协作打下基础。随后,使用 `joan context claude` 生成 CLAUDE.md 文件,即可让 AI 助手掌握当前项目的架构约定和业务逻辑,避免在编码初期出现理解偏差。例如,在一个微服务系统中,可以先添加描述 API 规范、认证机制和错误处理策略的 pods,再让 AI 根据这些文档生成符合标准的接口代码。 在开发具体功能模块之前,建议先执行 `joan pod pull` 拉取最新知识文档,并结合 `joan todo list –all` 查看团队分配给自己的任务。这有助于开发者明确目标范围,并参考已有的设计决策防止重复造轮子。如果发现缺少关键背景信息,还可以用 `joan pod add` 引入新的 pods。完成编码后,应及时更新对应的 todo 状态,并将本地修改通过 `joan pod push` 共享给队友,确保知识库始终保持最新。 对于长期维护的项目,定期归档已完成任务、补充新发现的经验教训尤为重要。Joan 提供了清晰的归档机制,避免旧信息干扰当前工作流。此外,借助 MCP 集成,AI 工具不仅能读取静态文档,还能在运行时动态调用 `get_pod` 获取特定领域的实时知识,极大提升了智能辅助开发的响应速度与准确性。