Prompt 模板集合

概述

本文档提供了团队 Vibe Coding 中常用的 Prompt 模板，涵盖开发、测试、重构、文档等各个环节。这些模板基于最佳实践，可以直接使用或根据具体需求进行调整。

开发类模板

功能开发模板

# 功能开发请求

## 需求描述
[详细描述要实现的功能]

## 技术要求
- 技术栈: [具体技术栈]
- 性能要求: [响应时间、并发量等]
- 兼容性: [浏览器、设备等要求]

## 实现约束
- 代码风格: [遵循的编码规范]
- 测试要求: [单元测试、集成测试等]
- 文档要求: [API文档、使用说明等]

## 参考信息
- 相关文件: [列出相关的代码文件]
- 依赖模块: [相关的依赖和模块]
- 设计文档: [相关的设计文档链接]

请按照以上要求实现功能，并提供完整的代码和测试用例。

API 开发模板

# API 接口开发

## 接口规格
- 路径: [API路径]
- 方法: [GET/POST/PUT/DELETE]
- 认证: [认证方式]

## 请求参数
```json
{
  "param1": "类型和说明",
  "param2": "类型和说明"
}

响应格式

{
  "code": 200,
  "message": "success",
  "data": {
    "result": "响应数据结构"
  }
}

业务逻辑

[详细描述业务处理逻辑]

错误处理

• 参数验证错误: 400
• 认证失败: 401
• 权限不足: 403
• 资源不存在: 404
• 服务器错误: 500

请实现这个API接口，包括参数验证、业务逻辑处理、错误处理和单元测试。

## 测试类模板

### 单元测试模板

单元测试开发

测试目标

函数/类: [要测试的函数或类名] 文件路径: [源代码文件路径]

测试场景

请为以下场景编写测试用例:

正常场景

• [场景1描述]
• [场景2描述]

边界场景

• [边界条件1]
• [边界条件2]

异常场景

• [异常情况1]
• [异常情况2]

测试要求

• 测试框架: [Jest/PyTest/其他]
• 覆盖率要求: [具体百分比]
• Mock策略: [需要Mock的依赖]

请生成完整的测试代码，确保覆盖所有场景。

### 集成测试模板

集成测试方案

测试范围

模块: [要测试的模块或服务] 集成点: [模块间的集成接口]

测试流程

1. [步骤1]
2. [步骤2]
3. [步骤3]

测试数据

• 输入数据: [测试输入]
• 预期输出: [期望结果]
• 环境要求: [测试环境配置]

验证点

• [验证点1]
• [验证点2]

请设计集成测试方案，包括测试脚本和数据准备。

## 重构类模板

### 代码重构模板

代码重构请求

重构目标

文件/模块: [要重构的代码位置] 重构原因: [为什么需要重构]

重构目标

• 提升可读性: [具体改进点]
• 性能优化: [性能问题描述]
• 架构改进: [架构问题说明]
• 消除技术债务: [技术债务描述]

约束条件

• 保持功能不变: [不能改变的行为]
• 兼容性要求: [向后兼容要求]
• 性能要求: [性能不能降低]

重构策略

• 重构方式: [渐进式/一次性]
• 测试策略: [如何保证重构安全]
• 回滚方案: [出现问题时的回滚策略]

请提供重构方案和具体的代码改进建议。

### 架构优化模板

架构优化方案

当前架构问题

• 问题1: [具体问题描述]
• 问题2: [具体问题描述]

优化目标

• 性能提升: [具体指标]
• 可扩展性: [扩展需求]
• 可维护性: [维护改进点]

技术方案

• 方案选择: [技术选型理由]
• 实施步骤: [分阶段实施计划]
• 风险评估: [潜在风险和应对]

迁移计划

• 数据迁移: [数据迁移策略]
• 服务迁移: [服务切换方案]
• 回滚预案: [紧急回滚方案]

请提供详细的架构优化方案和实施路径。

## 调试类模板

### Bug 修复模板

Bug 修复请求

Bug 描述

• 现象: [Bug的具体表现]
• 复现步骤: [如何复现这个Bug]
• 影响范围: [Bug影响的功能和用户]
• 紧急程度: [高/中/低]

环境信息

• 操作系统: [OS版本]
• 浏览器: [浏览器版本]
• 软件版本: [应用版本]

错误信息

[粘贴具体的错误日志或堆栈信息]

相关代码

文件: [相关的代码文件] 函数: [可能有问题的函数]

预期行为

[描述正确的行为应该是什么样的]

请帮助定位Bug原因并提供修复方案。

### 性能调优模板

性能优化请求

性能问题

• 问题描述: [具体的性能问题]
• 性能指标: [当前的性能数据]
• 目标指标: [期望达到的性能]

分析数据

• 监控数据: [性能监控截图或数据]
• 日志信息: [相关的日志信息]
• 用户反馈: [用户报告的问题]

怀疑原因

• [可能的原因1]
• [可能的原因2]

优化约束

• 不能影响功能: [功能完整性要求]
• 资源限制: [硬件或预算限制]
• 时间要求: [优化完成时间]

请分析性能瓶颈并提供优化方案。

## 文档类模板

### API 文档模板

API 文档生成

接口信息

• 服务名称: [API服务名称]
• 版本: [API版本]
• 基础URL: [API基础地址]

需要文档化的接口

• [接口1路径和功能]
• [接口2路径和功能]

文档要求

• 格式: [OpenAPI/Markdown/其他]
• 包含内容: [参数、响应、示例等]
• 示例代码: [需要的编程语言]

参考代码

[粘贴相关的API实现代码]

请生成完整的API文档，包括接口说明、参数定义、响应格式和使用示例。

### 技术文档模板

技术文档编写

文档类型

[设计文档/用户手册/开发指南/部署文档]

目标读者

[开发者/运维人员/产品经理/最终用户]

文档内容

• 背景和目标: [为什么需要这个文档]
• 核心概念: [需要解释的关键概念]
• 操作流程: [具体的操作步骤]
• 注意事项: [重要的注意点和限制]

文档结构

1. [章节1]
2. [章节2]
3. [章节3]

参考资料

• [相关的代码文件]
• [现有的文档]
• [外部参考资料]

请按照技术写作规范，生成结构清晰、内容准确的技术文档。

## 代码审查模板

### 代码审查请求

代码审查请求

审查范围

• 文件列表: [需要审查的文件]
• 变更类型: [新功能/Bug修复/重构/其他]
• 代码行数: [大概的代码量]

审查重点

• 代码质量: [关注代码规范和最佳实践]
• 安全性: [检查安全漏洞和风险]
• 性能: [评估性能影响]
• 可维护性: [代码的可读性和可维护性]

业务背景

[简要说明这次变更的业务背景和目标]

测试情况

• 单元测试: [测试覆盖情况]
• 集成测试: [集成测试结果]
• 手动测试: [手动测试情况]

请对代码进行全面审查，提供改进建议和潜在问题。

## 部署类模板

### 部署方案模板

部署方案设计

部署环境

• 环境类型: [开发/测试/预生产/生产]
• 基础设施: [云平台/物理服务器/容器]
• 资源配置: [CPU、内存、存储要求]

应用信息

• 应用类型: [Web应用/API服务/数据处理等]
• 技术栈: [具体的技术栈]
• 依赖服务: [数据库、缓存、消息队列等]

部署要求

• 可用性: [可用性要求]
• 扩展性: [扩展需求]
• 安全性: [安全要求]
• 监控: [监控和日志要求]

部署流程

1. [部署步骤1]
2. [部署步骤2]
3. [部署步骤3]

请设计完整的部署方案，包括配置文件、脚本和操作手册。

## 使用指南

### 模板选择原则
1. **任务匹配**: 根据具体任务选择对应的模板
2. **复杂度适配**: 简单任务用简化版，复杂任务用完整版
3. **团队习惯**: 结合团队的工作习惯和规范

### 模板定制建议
1. **项目特化**: 根据项目特点调整模板内容
2. **工具集成**: 结合使用的开发工具和平台
3. **持续优化**: 根据使用效果不断改进模板

### 最佳实践
1. **信息完整**: 提供充分的上下文信息
2. **目标明确**: 清楚表达期望的结果
3. **约束清晰**: 明确限制条件和要求
4. **示例丰富**: 提供具体的示例和参考

通过合理使用这些 Prompt 模板，可以显著提升与 AI 协作的效率和质量，确保获得更精准、更有用的帮助。