|
| 1 | +# AI 协作快速参考 |
| 2 | + |
| 3 | +本文档提供 FIT Framework AI 协作的快速参考,包括 Slash Commands 和自然语言使用示例。 |
| 4 | + |
| 5 | +## 📌 Slash Commands |
| 6 | + |
| 7 | +### 核心命令 |
| 8 | + |
| 9 | +| 命令 | 用途 | 示例 | |
| 10 | +|------|------|------| |
| 11 | +| `/analyze-issue <number>` | 分析 GitHub Issue 并创建任务 | `/analyze-issue 207` | |
| 12 | +| `/plan <task-id>` | 为任务设计技术方案 | `/plan TASK-20251227-104654` | |
| 13 | +| `/implement <task-id>` | 实施任务(编写代码和测试) | `/implement TASK-20251227-104654` | |
| 14 | +| `/task-status <task-id>` | 查看任务当前状态和进度 | `/task-status TASK-20251227-104654` | |
| 15 | +| `/sync-issue <task-id>` | 同步任务进度到 GitHub Issue | `/sync-issue TASK-20251227-104654` | |
| 16 | + |
| 17 | +### 已有命令 |
| 18 | + |
| 19 | +| 命令 | 用途 | 示例 | |
| 20 | +|------|------|------| |
| 21 | +| `/commit [message]` | 提交变更到 Git | `/commit` 或 `/commit "feat: xxx"` | |
| 22 | +| `/pr [branch]` | 创建 Pull Request | `/pr` 或 `/pr main` | |
| 23 | +| `/review <pr-number>` | 审查 Pull Request | `/review 369` | |
| 24 | +| `/code-review:code-review` | 代码审查(使用插件) | `/code-review:code-review` | |
| 25 | + |
| 26 | +### 工具命令 |
| 27 | + |
| 28 | +| 命令 | 用途 | 示例 | |
| 29 | +|------|------|------| |
| 30 | +| `/fix-permissions` | 检查和修复文件权限 | `/fix-permissions` | |
| 31 | +| `/test` | 执行完整测试流程 | `/test` | |
| 32 | +| `/upgrade-dep <package> <from> <to>` | 升级依赖 | `/upgrade-dep swagger-ui 5.30.0 5.30.2` | |
| 33 | + |
| 34 | +## 💬 自然语言示例 |
| 35 | + |
| 36 | +### 需求分析 |
| 37 | + |
| 38 | +``` |
| 39 | +"分析 issue 207" |
| 40 | +"帮我分析 fastjson 迁移需求" |
| 41 | +"需求分析 #207" |
| 42 | +``` |
| 43 | + |
| 44 | +**等效命令**:`/analyze-issue 207` |
| 45 | + |
| 46 | +**AI 会做什么**: |
| 47 | +1. 获取 Issue 信息 |
| 48 | +2. 创建任务文件 |
| 49 | +3. 执行需求分析 |
| 50 | +4. 输出 analysis.md |
| 51 | +5. 更新任务状态 |
| 52 | + |
| 53 | +### 方案设计 |
| 54 | + |
| 55 | +``` |
| 56 | +"设计 TASK-20251227-104654 的技术方案" |
| 57 | +"plan TASK-xxx" |
| 58 | +"给我一个实施计划" |
| 59 | +``` |
| 60 | + |
| 61 | +**等效命令**:`/plan TASK-20251227-104654` |
| 62 | + |
| 63 | +**AI 会做什么**: |
| 64 | +1. 读取需求分析 |
| 65 | +2. 设计技术方案 |
| 66 | +3. 输出 plan.md |
| 67 | +4. 标记为等待人工审查 |
| 68 | + |
| 69 | +### 代码实施 |
| 70 | + |
| 71 | +``` |
| 72 | +"实施 TASK-20251227-104654" |
| 73 | +"开始实现 fastjson 迁移" |
| 74 | +"implement TASK-xxx" |
| 75 | +``` |
| 76 | + |
| 77 | +**等效命令**:`/implement TASK-20251227-104654` |
| 78 | + |
| 79 | +**AI 会做什么**: |
| 80 | +1. 读取技术方案 |
| 81 | +2. 编写代码和测试 |
| 82 | +3. 运行测试验证 |
| 83 | +4. 输出 implementation.md |
| 84 | + |
| 85 | +### 任务状态 |
| 86 | + |
| 87 | +``` |
| 88 | +"查看 TASK-20251227-104654 的状态" |
| 89 | +"任务进度如何" |
| 90 | +"TASK-xxx 当前在哪一步" |
| 91 | +``` |
| 92 | + |
| 93 | +**等效命令**:`/task-status TASK-20251227-104654` |
| 94 | + |
| 95 | +**AI 会输出**: |
| 96 | +- 任务基本信息 |
| 97 | +- 当前步骤和进度 |
| 98 | +- 已完成的上下文文件 |
| 99 | +- 下一步建议 |
| 100 | + |
| 101 | +### 同步进度 |
| 102 | + |
| 103 | +``` |
| 104 | +"同步任务进度到 Issue" |
| 105 | +"更新 Issue 进展" |
| 106 | +"sync TASK-xxx to issue" |
| 107 | +``` |
| 108 | + |
| 109 | +**等效命令**:`/sync-issue TASK-20251227-104654` |
| 110 | + |
| 111 | +**AI 会做什么**: |
| 112 | +1. 读取任务和上下文文件 |
| 113 | +2. 生成清晰的进度摘要 |
| 114 | +3. 发布到对应的 GitHub Issue |
| 115 | +4. 更新任务同步时间 |
| 116 | + |
| 117 | +## 🔄 完整工作流 |
| 118 | + |
| 119 | +### 从 Issue 到提交的标准流程 |
| 120 | + |
| 121 | +```bash |
| 122 | +# 1. 分析 Issue |
| 123 | +/analyze-issue 207 |
| 124 | + |
| 125 | +# 2. 审查需求分析(人工) |
| 126 | +# 查看 .ai-workspace/context/TASK-xxx/analysis.md |
| 127 | + |
| 128 | +# 3. 设计技术方案 |
| 129 | +/plan TASK-xxx |
| 130 | + |
| 131 | +# 4. 审查技术方案(人工)⚠️ 必需 |
| 132 | +# 查看 .ai-workspace/context/TASK-xxx/plan.md |
| 133 | + |
| 134 | +# 5. 同步进度到 Issue(可选,推荐在重要节点) |
| 135 | +/sync-issue TASK-xxx |
| 136 | + |
| 137 | +# 6. 实施任务 |
| 138 | +/implement TASK-xxx |
| 139 | + |
| 140 | +# 7. 代码审查 |
| 141 | +/code-review:code-review |
| 142 | + |
| 143 | +# 8. 同步最终进度(可选) |
| 144 | +/sync-issue TASK-xxx |
| 145 | + |
| 146 | +# 9. 提交代码(人工确认后) |
| 147 | +/commit |
| 148 | +``` |
| 149 | + |
| 150 | +### 使用自然语言的流程 |
| 151 | + |
| 152 | +``` |
| 153 | +1. "分析 issue 207" |
| 154 | + → AI 创建任务并完成需求分析 |
| 155 | +
|
| 156 | +2. (人工审查 analysis.md) |
| 157 | +
|
| 158 | +3. "设计 TASK-xxx 的技术方案" |
| 159 | + → AI 设计方案并输出 plan.md |
| 160 | +
|
| 161 | +4. (人工审查 plan.md)⚠️ 必需 |
| 162 | +
|
| 163 | +5. "实施 TASK-xxx" |
| 164 | + → AI 编写代码和测试 |
| 165 | +
|
| 166 | +6. "审查代码" |
| 167 | + → AI 执行代码审查 |
| 168 | +
|
| 169 | +7. /commit |
| 170 | + → 提交变更 |
| 171 | +``` |
| 172 | + |
| 173 | +## 📋 任务 ID 格式 |
| 174 | + |
| 175 | +任务 ID 格式:`TASK-{yyyyMMdd-HHmmss}` |
| 176 | + |
| 177 | +示例: |
| 178 | +- `TASK-20251227-104654` |
| 179 | +- `TASK-20251229-150530` |
| 180 | + |
| 181 | +## 📂 文件路径约定 |
| 182 | + |
| 183 | +### 任务文件 |
| 184 | + |
| 185 | +- 活动任务:`.ai-workspace/tasks/active/TASK-xxx.md` |
| 186 | +- 已完成:`.ai-workspace/tasks/completed/TASK-xxx.md` |
| 187 | +- 已阻塞:`.ai-workspace/tasks/blocked/TASK-xxx.md` |
| 188 | + |
| 189 | +### 上下文文件 |
| 190 | + |
| 191 | +- 需求分析:`.ai-workspace/context/TASK-xxx/analysis.md` |
| 192 | +- 技术方案:`.ai-workspace/context/TASK-xxx/plan.md` |
| 193 | +- 实现报告:`.ai-workspace/context/TASK-xxx/implementation.md` |
| 194 | +- 审查报告:`.ai-workspace/context/TASK-xxx/review.md` |
| 195 | + |
| 196 | +## ⚠️ 人工检查点 |
| 197 | + |
| 198 | +以下步骤需要人工确认: |
| 199 | + |
| 200 | +1. **需求分析后**:确认需求理解正确(建议) |
| 201 | +2. **技术方案设计后**:审查方案是否合理(**必需**) |
| 202 | +3. **代码审查后**:确认审查结果和修改建议(建议) |
| 203 | +4. **最终提交前**:确认所有变更无误(**必需**) |
| 204 | + |
| 205 | +## 🎯 最佳实践 |
| 206 | + |
| 207 | +### 使用 Slash Commands 的场景 |
| 208 | + |
| 209 | +- **精确任务**:知道具体要执行什么操作 |
| 210 | +- **标准流程**:按照工作流逐步执行 |
| 211 | +- **批量操作**:快速执行多个相似任务 |
| 212 | + |
| 213 | +### 使用自然语言的场景 |
| 214 | + |
| 215 | +- **探索性任务**:不确定从哪里开始 |
| 216 | +- **灵活表达**:用自己的话描述需求 |
| 217 | +- **上下文对话**:在对话中自然提及任务 |
| 218 | + |
| 219 | +### 提示 |
| 220 | + |
| 221 | +1. **优先使用 Slash Commands**:更精确、快速、标准化 |
| 222 | +2. **自然语言作为补充**:提供灵活性和对话式体验 |
| 223 | +3. **明确任务 ID**:避免歧义,确保操作正确的任务 |
| 224 | +4. **遵循工作流**:不要跳过人工检查点 |
| 225 | + |
| 226 | +## 🆘 常见问题 |
| 227 | + |
| 228 | +### Q: 如何知道任务当前在哪一步? |
| 229 | + |
| 230 | +```bash |
| 231 | +/task-status TASK-xxx |
| 232 | +``` |
| 233 | + |
| 234 | +### Q: 忘记任务 ID 怎么办? |
| 235 | + |
| 236 | +```bash |
| 237 | +# 查看活动任务列表 |
| 238 | +ls .ai-workspace/tasks/active/ |
| 239 | + |
| 240 | +# 或通过 Issue 号查找 |
| 241 | +grep -r "#207" .ai-workspace/tasks/active/ |
| 242 | +``` |
| 243 | + |
| 244 | +### Q: 可以跳过某些步骤吗? |
| 245 | + |
| 246 | +工作流是推荐流程,可以灵活调整,但不建议跳过人工检查点。 |
| 247 | + |
| 248 | +### Q: 自然语言识别不准确怎么办? |
| 249 | + |
| 250 | +使用 Slash Commands 更精确。 |
| 251 | + |
| 252 | +### Q: 多个 AI 如何协作? |
| 253 | + |
| 254 | +所有 AI 都可以读取 `.ai-workspace/` 下的任务和上下文文件,实现无缝切换。 |
| 255 | + |
| 256 | +### Q: 什么时候应该同步进度到 Issue? |
| 257 | + |
| 258 | +建议在以下时机使用 `/sync-issue`: |
| 259 | +- 完成重要阶段后(需求分析、技术方案、实现完成) |
| 260 | +- 遇到阻塞问题需要讨论时 |
| 261 | +- 长时间任务需要定期更新进展时 |
| 262 | + |
| 263 | +**避免**:在每个小步骤都同步,会产生过多评论。 |
| 264 | + |
| 265 | +## 📚 更多信息 |
| 266 | + |
| 267 | +- **详细文档**:`.ai-agents/README.md` |
| 268 | +- **快速开始**:`.ai-agents/QUICKSTART.md` |
| 269 | +- **工作流定义**:`.ai-agents/workflows/` |
| 270 | +- **项目规则**:`.claude/project-rules.md` |
| 271 | + |
| 272 | +--- |
| 273 | + |
| 274 | +**提示**:收藏本文档,随时查阅! |
0 commit comments