# AI 提示词快速参考

> 💡 **快速查找常用提示词**。详细说明请参考 [AI 提示词指南](./ai-prompts-guide.md)

---

## 🧪 测试相关

| 场景 | 提示词 | 说明 |
|------|--------|------|
| **创建完整测试** | `为 [模块名] 创建完整测试，参考 Project 模块` | 创建 Repository、Service、API 三层测试 |
| **API 集成测试** | `为 [模块名] API 创建集成测试，参考 test_project_api.py` | 仅创建 API 测试，快速覆盖核心功能 |
| **Service 单元测试** | `为 [模块名] Service 创建单元测试，参考 test_project_service.py` | 测试业务逻辑 |
| **Repository 单元测试** | `为 [模块名] Repository 创建单元测试，参考 test_project_repository.py` | 测试数据访问 |
| **补充缺失测试** | `为 [模块名] 补充测试：已有 [X]，缺失 [Y]` | 补充部分测试 |

---

## 💻 开发相关

| 场景 | 提示词 | 说明 |
|------|--------|------|
| **创建新模块** | `创建 [模块名] 模块，包含 Model、Schema、Repository、Service、API，参考 Project 模块` | 完整模块开发 |
| **添加 API 端点** | `为 [模块名] 添加 [功能] API 端点，参考 [参考模块]` | 添加新端点 |
| **重构代码** | `重构 [文件路径]，要求：[要求列表]，保持功能不变` | 优化代码结构 |
| **修复 Bug** | `修复 [模块名] 的 Bug：问题 [X]，期望 [Y]，文件 [Z]` | 修复已知问题 |
| **添加功能** | `为 [模块名] 添加 [功能名] 功能，需求：[列表]` | 扩展功能 |

---

## 📝 文档相关

| 场景 | 提示词 | 说明 |
|------|--------|------|
| **创建 RFC** | `为 [功能名] 创建 RFC 文档，参考现有 RFC 格式` | 技术提案 |
| **创建 Changelog** | `为 [功能名] 创建 Changelog，变更：[列表]` | 记录变更 |
| **创建 API 文档** | `为 [模块名] API 创建文档，包含端点、示例、错误码` | API 文档 |
| **更新文档** | `更新 [文档路径]，同步变更：[列表]` | 同步文档 |

---

## 🗄️ 数据库相关

| 场景 | 提示词 | 说明 |
|------|--------|------|
| **创建迁移** | `创建数据库迁移：[变更描述]，变更：[列表]` | 修改数据库 |
| **创建新表** | `创建 [表名] 表的迁移脚本，字段：[列表]，索引：[列表]` | 添加新表 |
| **修改表结构** | `修改 [表名] 表：[变更描述]，创建迁移脚本` | 修改现有表 |

---

## 🔍 调试相关

| 场景 | 提示词 | 说明 |
|------|--------|------|
| **分析错误** | `分析以下错误：[错误信息]，相关代码：[代码]` | 错误诊断 |
| **性能优化** | `优化 [文件路径] 的性能，问题：[描述]` | 性能调优 |
| **代码审查** | `审查以下代码：[代码]，检查规范、问题、优化` | 代码审查 |

---

## 🎯 最常用提示词 TOP 5

### 1️⃣ 创建完整测试（最推荐）

```
为 [模块名] 创建完整测试，参考 Project 模块
```

**示例**：
```
为 Folder 模块创建完整测试，参考 Project 模块
```

---

### 2️⃣ 创建 API 集成测试（快速）

```
为 [模块名] API 创建集成测试，参考 test_project_api.py
```

**示例**：
```
为 Storyboard API 创建集成测试，参考 test_project_api.py
```

---

### 3️⃣ 创建新模块

```
创建 [模块名] 模块，包含 Model、Schema、Repository、Service、API，参考 Project 模块
```

**示例**：
```
创建 Comment 模块，包含 Model、Schema、Repository、Service、API，参考 Project 模块
```

---

### 4️⃣ 修复 Bug

```
修复 [模块名] 的 Bug：
- 问题：[描述]
- 期望：[描述]
- 文件：[路径]
```

**示例**：
```
修复 Project Service 的 Bug：
- 问题：删除项目时未检查权限
- 期望：只有所有者可以删除
- 文件：app/services/project_service.py
```

---

### 5️⃣ 创建数据库迁移

```
创建数据库迁移：[变更描述]
变更：[列表]
遵循项目迁移规范
```

**示例**：
```
创建数据库迁移：为 projects 表添加 archived_at 字段
变更：
1. 添加 archived_at TIMESTAMPTZ 字段
2. 添加索引
3. 添加字段注释
遵循项目迁移规范
```

---

## 💡 提示词技巧

### ✅ 好的提示词特征

1. **明确具体**：说清楚要做什么
2. **提供上下文**：说明问题背景
3. **参考现有代码**：指定参考文件
4. **分步执行**：复杂任务分步进行

### ❌ 避免的提示词

1. ❌ 过于简单："创建测试"
2. ❌ 缺少上下文："修复 Bug"
3. ❌ 没有参考："创建 API"
4. ❌ 过于复杂：一次要求太多

---

## 📋 提示词模板

### 测试模板

```
为 [模块名] 创建 [测试类型] 测试

[可选：具体要求]

参考 [参考文件]
```

### 开发模板

```
[创建/修改/重构] [目标]

[可选：需求/问题描述]

参考 [参考文件]
```

### 文档模板

```
为 [目标] 创建 [文档类型]

[可选：内容要求]

参考现有 [文档类型] 格式
```

---

## 🔗 相关文档

- [AI 提示词指南](./ai-prompts-guide.md) - 完整提示词指南
- [测试规范](../../server/tests/README.md) - 测试相关规范
- [后端架构](./backend-architecture.md) - 后端架构规范

---

**最后更新**: 2026-02-04  
**维护者**: Jointo 开发团队