Skip to content

Repository files navigation

AI Coding Template

AI 协作开发框架模板 - 让 AI 成为你的开发伙伴

1. 这是什么?

一套经过实战验证的 AI 协作开发框架,包含:

  • 8 阶段工作流 - 可裁剪,按需选用(Phase 0-7)
  • 标准化模板 - Context、Spec、Design、Test 等文档模板
  • Claude Code 工具库 - Slash Commands + Skills + Subagents
  • Phase Gate 机制 - 质量门禁,确保每个阶段的交付质量

2. 核心理念

Human-AI Loop = 人类决策 + AI 执行 + 质量把控
  • 人类负责:目标定义、架构决策、质量审批
  • AI 负责:代码生成、文档编写、任务执行
  • 流程保障:Phase Gate 机制确保每个阶段的质量

3. 快速开始

给 AI 看的版本:如果你正在使用 Claude Code,可以让 AI 直接读取 CLAUDE_INIT.md 并执行初始化,省去手动操作。 只需说:「读取 CLAUDE_INIT.md 并帮我初始化项目」

1. 克隆仓库

git clone https://github.com/oowanghuan/ai-coding-template.git my-project
cd my-project
rm -rf .git && git init  # 初始化为自己的仓库

2. 安装 Claude Code 工具

./scripts/init-claude-tools.sh --target=.

3. 创建第一个功能

在 Claude Code 中执行:

/new-feature user-login

这会自动生成功能文档目录:

docs/user-login/
├── 10_CONTEXT.md           # 待填写:功能背景和目标
├── 90_PROGRESS_LOG.yaml    # 自动更新:进度日志
├── PHASE_GATE.yaml         # 质量关卡配置
└── PHASE_GATE_STATUS.yaml  # 关卡状态

4. 开始开发

# 每天开始时
/start-day

# 恢复之前的工作
/iresume

# 检查 Phase Gate 状态
/check-gate user-login

# 每天结束时
/end-day

4. 目录结构

my-project/
├── .claude/                  # Claude Code 配置
│   ├── commands/             # Slash 命令
│   ├── skills/               # Skills 定义
│   ├── hooks/                # Hook 脚本
│   └── settings.json         # 项目设置
│
├── CC_COLLABORATION/         # 协作框架(核心)
│   ├── _gui_config/          # GUI 依赖配置(HA Loop Desk)
│   ├── _project_context/     # 项目背景与协作理念
│   │   ├── FRAMEWORK_PRINCIPLES.md   # 框架核心原则
│   │   ├── COLLABORATION_GUIDE.md    # 人机协作指南
│   │   └── ROLES_GUIDE.md            # 角色定义
│   ├── 01_workflow/          # 工作流文档(统一入口)
│   │   ├── 01_QUICKSTART.md          # 5 分钟快速入门
│   │   ├── 02_FRAMEWORK_OVERVIEW.md  # 框架整体说明
│   │   ├── 03_DAILY_OPERATIONS.md    # 每日操作指南
│   │   ├── 04_REFERENCE.md           # 完整参考手册
│   │   ├── 05_PM_DRIVER_WORKFLOW.md  # PM Driver 工作流详解 ⭐
│   │   └── recipes/                  # 工作流 Recipes
│   │       ├── PARALLEL_DEVELOPMENT.md  # 多 Feature 并行开发 ⭐
│   │       └── ...
│   ├── 03_templates/         # 文档模板
│   │   ├── 00_foundation/    # Phase 0: 项目基础设施模板
│   │   │   ├── _planning/              # 规划文档模板
│   │   │   ├── PROJECT_TRACKER_TEMPLATE.yaml    # 项目追踪器 ⭐
│   │   │   ├── PROJECT_PM_STATE_TEMPLATE.yaml   # Project PM 状态 ⭐
│   │   │   └── PROJECT_ACTIVITY_LOG_TEMPLATE.yaml # 活动日志 ⭐
│   │   ├── 01_kickoff/       # Phase 1 模板
│   │   ├── 02_spec/          # Phase 2 模板
│   │   └── ...               # Phase 3-7 模板
│   ├── 05_tools/             # 工具定义
│   │   ├── slash-commands/   # Slash 命令定义
│   │   │   ├── project-pm.md         # 项目级 PM Driver ⭐
│   │   │   ├── ai-pm.md              # 功能级 AI PM Driver ⭐
│   │   │   └── ...
│   │   ├── skills/           # Skills 定义
│   │   └── subagents/        # Subagents 定义
│   ├── 07_phase_gate/        # Phase Gate 定义
│   └── 08_legacy_integration/ # 现有项目整合指南
│
├── docs/                     # 功能文档(按功能组织)
│   ├── _foundation/          # 项目级文档 ⭐
│   │   ├── _planning/                # 规划文档
│   │   ├── PROJECT_TRACKER.yaml      # 项目追踪器
│   │   ├── PROJECT_PM_STATE.yaml     # Project PM 状态
│   │   └── PROJECT_ACTIVITY_LOG.yaml # 活动日志
│   └── {feature}/            # 功能模块文档
│       ├── AI_PM_ORCHESTRATION_STATE.yaml  # AI PM 状态 ⭐
│       └── ...
│
└── scripts/                  # 工具脚本

5. 8 阶段工作流

Phase 名称 核心产出 价值
0 Foundation 系统基础设施 项目级配置和规范
1 Kickoff 10_CONTEXT.md 明确目标和范围
2 Spec 21_UI_FLOW_SPEC.md 精确可执行的规格
3 Demo 交互原型 用户体验验证
4 Design 40_DESIGN_FINAL.md 技术方案设计
5 Code 功能代码 AI 按设计实现
6 Test 测试报告 质量验证
7 Deploy 发布说明 上线交付

详细说明见 CC_COLLABORATION/01_workflow/

6. 工具列表

Slash Commands

命令 用途
/new-feature 创建新功能目录
/start-day 每日开始,同步上下文
/end-day 每日结束,生成总结
/iresume 恢复上次工作
/check-progress 检查进度状态
/check-gate 检查 Phase Gate 状态
/approve-gate 审批 Phase Gate
/next-phase 进入下一阶段
/expert-review 调用 OpenAI 独立专家评审
/run-tests 执行测试
/release 发布流程

完整列表见 CC_COLLABORATION/05_tools/

7. 可视化工作台

如果你需要可视化的项目管理界面,推荐使用 HA Loop Desk

  • 📊 甘特图视图 - 追踪多功能模块进度
  • 🔄 Daily Standup - 每日站会面板
  • 🚦 Phase Gate 状态 - 可视化质量关卡

HA Loop Desk 是本框架的可视化伴侣工具,读取 docs/ 目录下的 YAML 文件,提供图形化的项目状态视图。

# 下载 HA Loop Desk
# https://github.com/oowanghuan/ha-loop-desk/releases

# 打开后选择你的项目目录即可

8. 核心机制

本框架解决 AI 协作开发中的三大核心问题:

8.1 Phase Gate - 质量门禁

问题:AI 生成度快,但质量参差不齐。没有检查点,容易「一路狂奔到错误的终点」。

解决方案:在每个阶段设置质量关卡,必须通过检查才能进入下一阶段。我自己在用的过程中不仅要审核代码,也会审核每个环节产生的各种方案的完整性。

参考文档https://www.wanghuan.ai/blog/ai-planning-and-reflection 我在这个里面详细调戏了Claude Code以下,问了他很详细的他自己怎么判断用户意图,怎么搞开发质量控制

# 检查当前阶段的 Gate 状态
/check-gate user-login --phase=2

# 审批通过 Gate
/approve-gate user-login --phase=2 --role=PM

# 进入下一阶段
/next-phase user-login

Gate 检查三要素

检查项 说明 示例
必需产出物 文档是否齐全 Phase 2 必须有 21_UI_FLOW_SPEC.md
质量检查 内容是否符合要求 Spec 必须包含错误处理章节
审批状态 相关角色是否已审批 PM + Architect 双重审批

8.2 Expert Review - 独立专家评审

问题:AI 自己写、自己审,「既当运动员又当裁判」,没有真正的质量门禁。

解决方案:引入第三方 AI(OpenAI GPT-4)作为独立评审方,打破「自己审自己」的困境。这个其实已经不是光审代码的事情了,其实写出来的方案也可以审,我的理念就是“让AI互卷”产生可靠结果。

# 使用 OpenAI GPT-4 作为独立评审方
/expert-review docs/my-feature --phase=4

# 评审结果:
# - GO: 无问题,可继续
# - REVISE: 有建议,可选修复
# - BLOCK: 有严重问题,必须修复

为什么需要独立评审

  • Claude 写的设计,Claude 自己审,容易「护短」
  • 不同 AI 模型有不同的知识盲区,交叉审核能发现更多问题
  • 评审结果写入 REVIEW_ACTIONS.yaml,形成可追溯的审核记录
# 配置 OpenAI API Key
export OPENAI_API_KEY="sk-your-api-key"

8.3 上下文恢复 - 对抗遗忘

问题:Claude Code 的 context window 有限(约 200K tokens),长对话会被自动压缩(compact),之前讨论的需求细节、设计决策会丢失。第二天继续工作时,AI「失忆」了。

解决方案:将关键信息持久化到标准化文档,需要时通过 /iresume/start-day 重新加载。 设想下,人睡了一觉起来,昨天干了啥可能都忘了,得看下笔记本上做的notes,好记性不如烂笔头,那就适当的把内容写到文档里(哪些该写哪些不该写其实我觉得是各家agent工具里面对于memory抽象最重要的核心能力),等起床之后再看。 对AI来说也是,Compact就是他打了个盹,或者不是Compact,你Cli就是莫名其妙崩溃了,他怎么恢复上下文,应该有个地方让他想起来。 我的实践就是一个规范化的90_PROGRESS_LOG.yaml配合 /check-progress 和 /iresume 来实现。 所以,文档有时候不是给人看的,有时候是给AI看的,明确什么时候谁该看什么,是我们流程磨合的重要任务。

┌─────────────────────────────────────────────────────────────┐
│  对话中产生的信息 → 写入标准化文档 → compact 后从文档恢复  │
└─────────────────────────────────────────────────────────────┘

核心文档与恢复内容

文档 恢复的信息 写入时机
10_CONTEXT.md 功能背景、目标、范围、非目标 Phase 1 Kickoff
21_UI_FLOW_SPEC.md 页面流程、交互规格、边界条件 Phase 2 Spec
40_DESIGN_FINAL.md 技术方案、架构决策、接口定义 Phase 4 Design
90_PROGRESS_LOG.yaml 已完成任务、当前进度、下一步 每次任务完成

日常工作流

# 每天开始 - 恢复昨天的上下文
/start-day

# 中途断点恢复 - 读取进度日志
/iresume

# 每天结束 - 保存今天的进度
/end-day

8.4 接口契约解析 - 对抗字段名猜测

问题:AI 在编写前端代码时会「猜测」后端接口字段名,导致 Mock 切换到 Real API 时页面空白。

// AI 写的前端代码
const user = await api.getUser(id);
console.log(user.userName);      // undefined!
console.log(user.createdAt);     // undefined!

// 实际后端返回
{
  "username": "zhangsan",        // 是 username 不是 userName
  "created_at": "2026-01-03"     // 是 snake_case 不是 camelCase
}

解决方案:使用 contract_resolver skill,在编码前查询真实的字段定义(SSoT)。

场景 1: 写前端组件
─────────────────
❌ 之前: AI 猜测 { userName: string }
✅ 之后: 先查 contract → { username: string }

场景 2: Mock → Real 切换
─────────────────
❌ 之前: 切换后字段对不上,页面空白
✅ 之后: 验证 mock 与 real 的 contract 一致性

SSoT 查找优先级

1. 项目 Contract 文件 → shared/contracts/{entity}.yaml
2. OpenAPI / Swagger → openapi.yaml
3. API Spec 文档 → docs/{feature}/20_API_SPEC.md
4. 后端 Schema 定义 → app/schemas/{entity}.py (Pydantic)
5. 后端 Model 定义 → app/models/{entity}.py (SQLAlchemy)
6. 前端类型定义 → src/types/{entity}.ts (最低优先级)

使用示例

# 输入:查询 Agent 实体
input:
  entity: "Agent"
  project_path: "./backend"

# 输出:真实字段名
output:
  fields:
    - name: "agent_type"           # 不是 agentType
    - name: "system_message"       # 不是 systemMessage
    - name: "created_at"           # 不是 createdAt
  confidence: 0.95

在 CLAUDE.md 中配置规则(推荐):

## 接口编码规则

在编写前端接口调用代码时,必须先调用 contract_resolver skill 查询真实字段定义:
1. 用户说「写一个 Agent 列表组件」
2. 先查 contract: entity="Agent"
3. 得到真实字段名: agent_type, created_at, ...
4. 按真实字段名写代码

详细说明见 CC_COLLABORATION/08_legacy_integration/README.md.claude/skills/contract_resolver.md

8.5 PM Driver - 自动化编排

问题:多个 Feature 并行开发时,缺乏统一协调。人工跟踪进度、管理依赖关系容易出错和遗漏。

解决方案:引入两级 PM Driver 自动化编排系统:

┌─────────────────────────────────────────────────────────────────┐
│                     Human(开发者/PM)                           │
│  • 执行初始化命令、分发 Agent 命令、审批 Gate                    │
└────────────────────────────┬────────────────────────────────────┘
                             │
                             ▼
┌─────────────────────────────────────────────────────────────────┐
│              Project PM Driver(/project-pm)                    │
│  • 从 MODULE_DECOMPOSITION 解析 Feature 列表和依赖              │
│  • 计算 Ready Set(可执行任务集合)                              │
│  • 生成 dev agent 命令、汇总进度                                 │
└────────────────────────────┬────────────────────────────────────┘
                             │
              ┌──────────────┼──────────────┐
              ▼              ▼              ▼
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│  AI PM Driver   │ │  AI PM Driver   │ │  AI PM Driver   │
│  (feature-a)    │ │  (feature-b)    │ │  (feature-c)    │
│  Phase 1-7 执行 │ │  Phase 1-7 执行 │ │  Phase 1-7 执行 │
└─────────────────┘ └─────────────────┘ └─────────────────┘

Project PM Driver(项目级)

# 初始化项目追踪(需要 Foundation Gate 通过)
/project-pm init

# 查看可执行任务(Ready Set)
/project-pm ready

# 生成 dev agent 命令
/project-pm assign

# 检查并更新进度
/project-pm check

# 查看项目整体状态
/project-pm status

AI PM Driver(功能级)

# 启动自动编排(在独立 CLI 会话中执行)
/ai-pm start user-auth --mode=full_auto --from-phase=1

# 查看状态
/ai-pm status user-auth

# 控制执行
/ai-pm pause user-auth    # 暂停
/ai-pm resume user-auth   # 恢复
/ai-pm stop user-auth     # 停止

运行模式

模式 说明 适用场景
full_auto 全自动执行,仅在 stuck 时暂停 常规功能、成熟流程
human_confirm 每个阶段通过后等待人工确认 关键功能、支付/安全相关

典型工作流

# 1. Foundation 完成后,初始化 Project PM
/project-pm init

# 2. 查看可执行任务
/project-pm ready

# 3. 生成 dev agent 命令
/project-pm assign
# 输出:
# Agent 1: /ai-pm start user-auth --mode=full_auto
# Agent 2: /ai-pm start config-service --mode=full_auto

# 4. 在多个 CLI 窗口分别执行
# (CLI 1) /ai-pm start user-auth --mode=full_auto
# (CLI 2) /ai-pm start config-service --mode=full_auto

# 5. 定期检查进度
/project-pm check
/project-pm status

# 6. 继续分配新解锁的任务
/project-pm assign

详细说明见 CC_COLLABORATION/01_workflow/05_PM_DRIVER_WORKFLOW.md

9. 最佳实践

  1. 每天开始执行 /start-day - 让 AI 快速恢复上下文
  2. 每天结束执行 /end-day - 自动生成进度总结
  3. 保持文档更新 - Context 和 Spec 是 AI 理解需求的关键
  4. 先 Spec 后 Code - 先定义清楚再动手
  5. 关键阶段使用 Expert Review - 让独立 AI 评审你的设计

参考文档https://www.wanghuan.ai/blog/ai-coding-template-to-workflow 当方法被固化、被模板化、被流程化之后,AI 才真正成为了可规模化协作的一部分。

10. 相关项目

项目 说明
HA Loop Desk 可视化工作台(桌面应用)

11. License

MIT


让 AI 成为你的编程伙伴,而不是替代品

About

AI 协作开发框架模板 - Claude Code 工具库 + 8 阶段工作流 + 标准化文档模板

Resources

Stars

55 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages