Skip to content

Commit bb85786

Browse files
committed
Merge branch '3.6.x'
2 parents 9d0b0c2 + b0ed57a commit bb85786

File tree

18 files changed

+2354
-0
lines changed

18 files changed

+2354
-0
lines changed

.ai-agents/QUICKSTART.md

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
# 多 AI 协作快速开始指南
2+
3+
本指南帮助你快速上手 FIT Framework 的多 AI 协作功能。
4+
5+
## 🚀 5分钟快速开始
6+
7+
### 1. 创建你的第一个协作任务
8+
9+
```bash
10+
# 复制任务模板
11+
cp .ai-agents/templates/task.md .ai-workspace/tasks/active/TASK-{yyyyMMdd}-{task-id}.md
12+
```
13+
14+
编辑任务文件,填写:
15+
- 任务标题
16+
- 任务描述
17+
- 选择工作流(feature-development/bug-fix/code-review/refactoring)
18+
19+
### 2. 使用 Claude 分析需求
20+
21+
在 Claude Code 中:
22+
```
23+
请分析 .ai-workspace/tasks/active/TASK-{yyyyMMdd}-{task-id}.md 中的任务
24+
```
25+
26+
Claude 会:
27+
1. 读取任务描述
28+
2. 分析相关代码
29+
3. 创建需求分析报告:`.ai-workspace/context/TASK-{yyyyMMdd}-{task-id}/analysis.md`
30+
31+
### 3. Claude 设计技术方案
32+
33+
```
34+
请为 TASK-{yyyyMMdd}-{task-id} 设计技术方案
35+
```
36+
37+
Claude 会创建:
38+
- `.ai-workspace/context/TASK-{yyyyMMdd}-{task-id}/plan.md`
39+
40+
**人工检查点**:审查方案是否合理
41+
42+
### 4. 切换到 ChatGPT 实现代码
43+
44+
在 ChatGPT/Cursor 中:
45+
```
46+
请根据 .ai-workspace/tasks/active/TASK-{yyyyMMdd}-{task-id}.md 实现代码。
47+
参考方案:.ai-workspace/context/TASK-{yyyyMMdd}-{task-id}/plan.md
48+
```
49+
50+
ChatGPT 会:
51+
1. 读取任务和方案
52+
2. 编写代码实现
53+
3. 编写单元测试
54+
4. 创建实现报告:`.ai-workspace/context/TASK-{yyyyMMdd}-{task-id}/implementation.md`
55+
56+
### 5. 切换回 Claude 审查代码
57+
58+
在 Claude Code 中:
59+
```
60+
请审查 TASK-{yyyyMMdd}-{task-id} 的实现
61+
```
62+
63+
Claude 会:
64+
1. 读取实现报告
65+
2. 审查代码变更
66+
3. 创建审查报告:`.ai-workspace/context/TASK-{yyyyMMdd}-{task-id}/review.md`
67+
68+
### 6. 根据审查结果决定
69+
70+
**如果审查通过**
71+
```
72+
/commit
73+
```
74+
75+
**如果需要修改**
76+
切换到 ChatGPT 修复问题,然后重新审查。
77+
78+
---
79+
80+
## 📋 常见场景
81+
82+
### 场景 1:修复 Bug
83+
84+
```bash
85+
# 1. 创建 Bug 任务
86+
cp .ai-agents/templates/task.md .ai-workspace/tasks/active/BUG-{yyyyMMdd}-{task-id}.md
87+
# 编辑:type: bugfix, workflow: bug-fix
88+
89+
# 2. Claude 分析 Bug
90+
"请分析 BUG-{yyyyMMdd}-{task-id} 中的问题"
91+
92+
# 3. ChatGPT 修复 Bug
93+
"请修复 BUG-{yyyyMMdd}-{task-id}"
94+
95+
# 4. Claude 审查修复
96+
"请审查 BUG-{yyyyMMdd}-{task-id} 的修复"
97+
98+
# 5. 提交
99+
/commitcp .ai-agents/templates/task.md .ai-workspace/tasks/active/BUG-{yyyyMMdd}-{task-id}.md
100+
```
101+
102+
### 场景 2:代码审查
103+
104+
```bash
105+
# 1. 创建审查任务
106+
cp .ai-agents/templates/task.md .ai-workspace/tasks/active/REVIEW-PR-{task-id}.md
107+
# 编辑:type: review, workflow: code-review
108+
109+
# 2. Claude 执行审查
110+
/review {task-id}
111+
#
112+
"请审查 PR #{task-id}"
113+
114+
# 3. 根据审查报告采取行动
115+
```
116+
117+
### 场景 3:代码重构
118+
119+
```bash
120+
# 1. 创建重构任务
121+
cp .ai-agents/templates/task.md .ai-workspace/tasks/active/REFACTOR-{yyyyMMdd}-{task-id}.md
122+
# 编辑:type: refactor, workflow: refactoring
123+
124+
# 2. Claude 分析和规划
125+
"请分析 REFACTOR-{yyyyMMdd}-{task-id} 并制定重构计划"
126+
127+
# 3. 审查重构计划(重要!)
128+
129+
# 4. Claude 或 ChatGPT 执行重构
130+
"请执行 REFACTOR-{yyyyMMdd}-{task-id} 的重构"
131+
132+
# 5. 审查 + 提交
133+
```
134+
135+
---
136+
137+
## 🎯 最佳实践
138+
139+
### 1. 任务命名规范
140+
141+
```
142+
TASK-{yyyyMMdd-序号}.md # 一般任务
143+
BUG-{yyyyMMdd-序号}.md # Bug修复
144+
FEAT-{yyyyMMdd-序号}.md # 新功能
145+
REFACTOR-{yyyyMMdd-序号}.md # 重构
146+
REVIEW-PR-{pr-number}.md # PR审查
147+
```
148+
149+
### 2. 关键检查点
150+
151+
每个任务至少有2个人工检查点:
152+
1. **方案设计后**:确保技术方案合理
153+
2. **最终提交前**:确保所有变更正确
154+
155+
### 3. 上下文完整性
156+
157+
确保每个步骤都创建完整的输出文件:
158+
- `analysis.md` - 需求分析
159+
- `plan.md` - 技术方案
160+
- `implementation.md` - 实现报告
161+
- `review.md` - 审查报告
162+
163+
这样任何 AI 都能接手。
164+
165+
### 4. AI 切换时机
166+
167+
**切换到 Claude**
168+
- 需要系统性分析
169+
- 代码审查
170+
- 架构设计
171+
- 安全审计
172+
173+
**切换到 ChatGPT**
174+
- 快速实现功能
175+
- 编写单元测试
176+
- 修复简单问题
177+
- 代码重构
178+
179+
### 5. 灵活应对
180+
181+
工作流是推荐,不是强制:
182+
- 简单任务可以跳过某些步骤
183+
- 可以根据实际情况调整顺序
184+
- 人类始终拥有最终决策权
185+
186+
---
187+
188+
## 🔍 故障排查
189+
190+
### 问题 1:AI 不知道任务在哪里
191+
192+
**解决方案**:明确指定任务文件
193+
```
194+
请处理 .ai-workspace/tasks/active/TASK-{yyyyMMdd}-{task-id}.md
195+
```
196+
197+
### 问题 2:上下文丢失
198+
199+
**解决方案**:检查 context 目录
200+
```bash
201+
ls -la .ai-workspace/context/TASK-{yyyyMMdd}-{task-id}/
202+
```
203+
204+
确保每个步骤都创建了输出文件。
205+
206+
### 问题 3:任务状态不清楚
207+
208+
**解决方案**:查看任务文件
209+
```bash
210+
cat .ai-workspace/tasks/active/TASK-{yyyyMMdd}-{task-id}.md
211+
```
212+
213+
检查 `current_step``assigned_to` 字段。
214+
215+
### 问题 4:工作流程不清楚
216+
217+
**解决方案**:查看工作流定义
218+
```bash
219+
cat .ai-agents/workflows/feature-development.yaml
220+
```
221+
222+
---
223+
224+
## 📚 进一步学习
225+
226+
- **协作总指南**`.ai-agents/README.md`
227+
- **工作流定义**`.ai-agents/workflows/`
228+
- **任务模板**`.ai-agents/templates/`
229+
- **Claude 配置**`.claude/README.md`
230+
- **ChatGPT 配置**`.ai-agents/chatgpt/README.md`
231+
- **Gemini 配置**`.ai-agents/gemini/README.md`
232+
233+
---
234+
235+
## 💡 提示
236+
237+
1. **先小后大**:从简单任务开始熟悉流程
238+
2. **保持沟通**:在任务文件和输出文件中写清楚
239+
3. **人工确认**:关键步骤一定要人工审查
240+
4. **定期清理**:完成的任务可以移到 completed 目录
241+
5. **灵活调整**:根据实际情况调整工作流
242+
243+
---
244+
245+
**祝协作愉快!** 🎉
246+
247+
有问题查看 `.ai-agents/README.md` 或询问项目维护者。

0 commit comments

Comments
 (0)