Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vibe Coding Handbook Logo  Vibe Coding 正式项目工作手册

面向 Claude Code、Codex 与其他编程 Agent 的正式项目工程方法。
从单 Agent 长期开发,到多 Agent、多 Worktree、多机协作,都有清晰的项目真相、执行边界与交付门禁。

简体中文 · English

Latest release GitHub stars Last commit

当前最新版:v6 · Multi-Agent Native。v5.2 与 v5.3 继续作为低复杂度稳定路径保留,不需要为了“追新”而强制升级。

这是什么

这不是一套让 AI “多写代码”的提示词,而是一套让 AI 参与正式软件交付的工程手册。它把需求、设计、计划、决策、任务状态、代码、证据与发布连接成一条可检查、可恢复、可交接的链路。

它重点解决四类问题:

常见问题 手册给出的机制
功能都完成了,产品旅程却是断的 按用户旅程切垂直里程碑,每个里程碑独立走查与验收
长会话丢上下文,换 Agent 后重新猜项目 用 PRD、PLAN、DECISIONS、DESIGN 等文件保存项目真相
多个 Agent 同时修改,互相覆盖或抢任务 Ownership、Task Claim、Writable Scope、Worktree Isolation
“测试过了”只有一句话,没有可复核证据 Evidence Chain、Deterministic Checks、Integration / Merge Gate

选择适合你的版本

版本 适用场景 状态模型 入口
v5.2 · Single-Agent Solid 单人 + 单个 Claude Code 会话,长期正式项目 人读文档 手册 · 发布版
v5.3 · Multi-Agent Ready 多会话 / 多 Worktree,或 Claude + Codex 混合开发 PLAN 中的人读任务状态 手册 · 发布版
v6 · Multi-Agent Native 多 Agent、多机、长期并行与自动调度 .vibe/ 机器可读项目状态 最新手册 · 发布版

完整差异见 VERSION-DIFF.md

v6 的协作模型

flowchart LR
    A["Project Truth<br/>PRD · PLAN · DECISIONS · .vibe"] --> B["Task Claim<br/>Owner · Scope · Worktree"]
    B --> C1["Claude Code"]
    B --> C2["Codex"]
    B --> C3["Other Agents"]
    C1 --> D["Handoff Packet<br/>Changes · Checks · Evidence"]
    C2 --> D
    C3 --> D
    D --> E["Integration Gate<br/>Contract · CI · Journey"]
    E --> F["Merge & Release"]
Loading

核心原则是:Agent runtime 可以更换,project truth 必须留在仓库里。 Agent 可以拥有自己的临时记忆和工具配置,但任务状态、契约、交接包、检查结果与集成结论不能只存在于某个会话中。

快速开始

  1. 根据上表选择版本。单人项目优先从 v5.2 开始;真实并行协作再选 v5.3 或 v6。
  2. 把对应模板复制到项目根目录。v6 至少保留 AGENTS.mdENGINEERING.md.vibe/PRD.mdPLAN.mdDECISIONS.mdCHANGELOG.mdDESIGN.md
  3. 先完成阶段 0 的规则和安全基线,再依次建立 PRD、设计系统、计划与决策日志。
  4. 每个任务明确 Owner、状态、Worktree、可写范围、完成定义和验证命令;一次会话只处理一个任务或一批同类任务。
  5. 每个里程碑必须通过用户旅程走查、确定性检查、CI 和集成门禁,之后再合并与记录版本。

新会话可从这句开始:

读取 AGENTS.md、ENGINEERING.md、PRD.md、PLAN.md、DECISIONS.md、SELFCHECK.md 和 .vibe/,
确认当前项目真相、任务 Owner、可写范围与集成门禁;只认领一个未被占用的任务再开始工作。

仓库内容

主手册与迁移

文件 作用
Vibe-Coding-正式项目工作手册v6.md v6 完整方法与执行模板
VERSION-DIFF.md v5.2 / v5.3 / v6 的选型边界
MIGRATION-v5.2-to-v5.3.md 从单 Agent 稳定模式升级到 Multi-Agent Ready
MIGRATION-v5.3-to-v6.md 从人读任务状态升级到机器可读状态
VIBE-CLI.md v6 任务状态、确定性检查与集成门禁的 CLI 设计

项目真相模板

文件 作用
AGENTS.md 所有 Agent 的通用入口、Ownership、Claim、Scope 与 Handoff 规则
ENGINEERING.md 与厂商无关的命令、契约、CI、分支和集成规则
CLAUDE.md Claude Code 适配层;跨工具规则仍以上述通用文件为准
PRD.md 业务规则、用户旅程、契约指针与验收标准
PLAN.md 当前里程碑、任务边界与收口门禁
DECISIONS.md 只增不改的架构与产品决策日志
DESIGN.md 前端设计系统的单一真相
CHANGELOG.md 版本与里程碑交付记录
SELFCHECK.md 面向大模型的机读自查与防遗忘协议

Multi-Agent Native

  • .vibe/project.json:持久化项目状态与调度拓扑。
  • .vibe/tasks/*.json:机器可执行的任务、Owner、Scope、依赖、状态与证据。
  • .vibe/checks/default.json:确定性检查集合。
  • .vibe/.schema/:项目和任务状态的 JSON Schema。
  • examples/:任务认领、Worktree、交接包和证据链示例。

设计原则

  • 项目真相属于仓库:不依赖某个模型、会话或开发者的记忆。
  • 兼容优先:v6 是可选增强层,不会让 v5.2 用户的稳定流程失效。
  • 人机双读:Markdown 保持可讨论,.vibe/ 让状态可校验、可调度。
  • 集成是一种角色:实现 Agent 不能自行宣布合并完成,集成负责人负责跨任务验证。
  • 证据先于结论:命令、输出、提交、PR 与旅程记录组成 Evidence Chain。
  • 自动化必须确定:CLI 负责状态转换和门禁,不替代 PRD、设计与业务判断。

使用边界

这套方法提高的是 AI 编程项目的交付下限,不是让 AI 无所不能。你仍然需要判断需求是否正确、体验是否连贯、风险是否可接受。自动化越强,越要保留可回滚的提交、明确的停止点和最终的人类责任。

欢迎通过 Issues 提交实战反馈,通过 Releases 下载各稳定版本。

About

Production engineering handbook for Claude Code, Codex & multi-agent delivery | 面向 AI 编程与多 Agent 协作的正式项目工作手册

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors