COLLABORATION.md
在多 Agent 项目(Claude Code + Codex + Pi Agent 等)中的共享最高指令文件——一个文件,被多个 Agent 共同引用
设计
COLULABORATION.md 用于解除多个 AI Agent 在一个项目中”各读各的配置”导致行为分裂——Claude Code 只读 CLAUDE.md,Codex 只读 AGENTS.md,Pi Agent 可以读两者,但三个 Agent 在项目约束上可能会产生分歧。通过在根目录创建一个共享的 COLLABORATION.md 后,在各 Agent 每条码的 CLUDE.md 或 AGENTS.md 首句用 @ 标注引用,将关键约束从”各写各的”调整为”一个文件管三个 Agent 的大脑”。
关键信息
- 类型:配置文件
- 用途:多见 Agent 协作时的“一致性文本”
- 文件名:COLLABORAITON.md(推荐位于项目根目录)
- 相关概念:最高指令软链接法、CLAUDE.md 行为驱动设计、VS Code 多 Agent 工作台、Agent 选型四步法
应该写入的内容
技术栈约定
- 使用的 AI Agent 名单(如 Claude Code / Codex / Pi Agent 角色)
- 前端/后端/数据层技术栈
- 包管理系统制定
文件命名规范
- 目录结构固定
- 模块命名规定
- 避免之间冲突日期的规则
禁区/不能动的文件
- 不可修改的文件、配置文件
- 关键凭据文件、环境变量位置
- 对安全有影响的目录/文件
管理方式
- git 分支策略(feature/dev/main 流程)
- commit 前缀规范
- 提交前检查列表
特殊红线
- 不自行执行 doomsday 操作(删除数据库、删除项目、破坏性 git 操作)
- 对无法恢复的操作需人工确认
使用建议
- 项目用多 Agent 时建立,但不需要一开始就建立——先用单 Agent 做 0→1 冷启动,项目规模越大越多 Agent 协同调整越需要建立
- 协作文档的生命周期管理:修改后需重新启动 Agent 重新加载