# ai-collab-starter

**Repository Path**: mapleKirito/ai-collab-starter

## Basic Information

- **Project Name**: ai-collab-starter
- **Description**: 一套用于多角色 AI 辅助协同开发的规则模板与提示词。通过标准化角色定义（架构师、开发、测试等），引导 AI 在项目中分工协作，提升开发效率与输出质量。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-14
- **Last Updated**: 2026-05-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 多角色 AI 辅助协同开发规则模板

让 AI 成为你的协作开发团队——角色分工、规范协作、开箱即用。

## 项目简介

本项目提供了一套结构化的规则说明与提示词模板，用于在多角色 AI 辅助协同开发场景中，引导不同 AI 角色按照统一规范参与项目。适合使用 AI 编程助手（如 Trae、Cursor、Copilot 等）的团队或个人开发者。

## 核心文件

| 文件 | 说明 |
|------|------|
| `MULTI-ROLE-COLLABORATION-PROMPT.md` | 完整规范模板，可直接复制到项目中作为协作基准 |
| `QUICK-START-GUIDE.md` | 快速参考指南，帮助团队成员快速上手 |
| `INIT-COLLABORATION-PROMPT.md` | 初始化提示词，开启新对话时使用，设定协作上下文 |
| `SYNC-TEMPLATE-PROMPT.md` | 规范同步提示词，用于将模板与具体项目规范同步 |

## 版本特性（v3.0）

### 核心改进

1. **文档结构重构**
   - `PROMPT-xxx.md`：具体角色对话发起提示词（包含角色名称、角色身份、初始描述、职责边界四个栏目）
   - `TASKS-DASHBOARD.md`：任务面板（统筹策划读写，任务执行只读）
   - `TASKS-REPORT-xxx.md`：各执行角色的任务执行状态变更记录
   - `WORKFLOW.md`：全局通用规范（对所有角色生效）

2. **身份设定优化**
   - 统筹策划：明确只操作 `.collab/` 文档，不做代码编写；对 `.collab/` 以外的文档变动建议用户手动操作
   - 任务执行：权限边界由初始化后的具体角色单独限制

3. **Git 流程简化**
   - 从 14 步简化为 6 步
   - 强调重置工作空间确保与远端一致
   - 明确异常处理原则：及时终止，反馈给用户

4. **任务协同机制**
   - 统筹策划通过 TASKS-DASHBOARD.md 派发任务
   - 任务执行通过 TASKS-REPORT-xxx.md 反馈状态
   - 任务执行无法修改 TASKS-DASHBOARD.md，只能读取

### 角色体系

```
统筹策划（PLANNER）── 固定身份，通用设定
  └── 具体角色实例（初始化时确认，通常 1 个）
        例如：DESIGNER

任务执行（EXECUTOR）── 固定身份，通用设定
  ├── 具体角色实例 1（初始化时确认）
  │     例如：FE（前端开发）
  ├── 具体角色实例 2（初始化时确认）
  │     例如：BE（后端开发）
  └── ... 可按需扩展更多执行角色
```

### 文档结构

```
.collab/
├── PROMPT-xxx.md              # 具体角色的对话发起提示词
├── PROJECT-STATUS.md          # 项目整体进度状态的持久化记录
├── TASKS-DASHBOARD.md         # 任务面板（统筹策划读写，任务执行只读）
├── TASKS-REPORT-xxx.md        # 各执行角色的任务执行状态变更记录
└── WORKFLOW.md                # 全局通用规范（对所有角色生效）
```

## 适用场景

- 个人开发者使用多 AI 角色协同完成复杂项目
- 小团队统一 AI 辅助开发的工作规范
- 探索 AI 编程助手的高效协作模式

## 使用方式

### 快速开始

1. 将模板文件夹复制到你的项目根目录 `.collab/`
2. 使用 `INIT-COLLABORATION-PROMPT.md` 中的初始化提示词开启新对话
3. AI 会通过交互对话确认项目信息和角色配置
4. 自动生成完整的协同开发文档

### 详细步骤

请参考 `QUICK-START-GUIDE.md` 获取完整的初始化步骤。

## 自定义建议

- **具体角色**：根据项目实际分工增减执行角色数量
- **职责边界**：在 PROMPT-xxx.md 中为每个具体角色定义补充性质约束（强度最高，覆盖其他级别）
- **扩展设定**：为每个具体角色补充软件环境、技术栈约束、补充约束等
- **流程规范**：可结合项目开发流程（如需求评审、代码审查）补充协作规则

## 文件结构

```
ai-collab-starter/
├── README.md                           # 项目说明
├── MULTI-ROLE-COLLABORATION-PROMPT.md  # 完整规范模板
├── QUICK-START-GUIDE.md                # 快速参考指南
├── INIT-COLLABORATION-PROMPT.md        # 初始化提示词
└── SYNC-TEMPLATE-PROMPT.md             # 规范同步提示词
```

## 版本历史

| 版本 | 日期 | 更新内容 |
|------|------|----------|
| v3.0 | 2026-05-18 | 文档结构重构：PROMPT-xxx.md、TASKS-DASHBOARD.md、TASKS-REPORT-xxx.md；身份设定优化；Git 流程简化为 6 步 |
| v2.0 | 2026-05-18 | 重构角色体系：两大类固定身份（PLANNER/EXECUTOR）+ 可自定义子角色 |
| v1.3 | 2026-05-16 | 新增读写边界、推送前强制检查、合并规范由用户完成 |
| v1.0 | 2026-05-13 | 初始版本 |

## 贡献

欢迎提交 Issue 和 Pull Request 来完善这套模板。

## 许可证

MIT