告别重复 Prompt,调教 AI 从一份好的 Prompt 模板开始
你是否有过这样的经历:每次让 AI 帮忙写代码审查,都要重新描述一遍审查要点;每次让 AI 生成单元测试,都要重复说明测试框架。Common Prompt 正是为了解决这些问题而生。
为什么需要 Prompt 模板库?
作为一个每天和 AI 打交道的研发,我深刻体会到:好的 Prompt 是 AI 工具效率的关键。
但现实是:
- 每次都要重新组织语言描述任务
- Prompt 质量参差不齐,效果不稳定
- 团队成员各自为战,Prompt 无法复用
- 好的经验散落在聊天记录里,难以沉淀
Common Prompt 致力于打造一个研发团队共享的高质量 Prompt 模板库,让 AI 真正成为开发效率的倍增器。
项目简介
Common Prompt 是一个专注于研发场景的 Prompt 集合,覆盖软件开发全流程:
commonPrompt/
├── prompts/
│ ├── api-design/ # API 设计指南
│ ├── code-review/ # 代码审查助手
│ ├── code-refactor/ # 代码重构分析
│ ├── docs-generation/ # 项目文档生成
│ ├── tech-design/ # 技术方案设计
│ └── testing/ # 单元测试生成
核心 Prompt 一览
1. 代码审查助手 - 让 Code Review 更专业
还在为 Code Review 不知道审什么而烦恼?Code Review Guide 提供了多维度的审查框架:
- P0 级别:代码正确性、安全性
- P1 级别:代码风格、性能、可维护性
- P2 级别:测试覆盖
输入代码后,它会输出结构化的审查报告,清晰标注严重问题、建议改进和最佳实践。
2. 单元测试生成器 - 测试覆盖率翻倍
还在为写单元测试而头疼?Unit Test Generator 帮你自动生成高质量测试用例:
- 边界条件测试
- 异常场景覆盖
- 参数化测试支持
- Mock 配置建议
3. 技术方案设计助手 - 从需求到架构
每次写技术方案都要从头开始排版?Tech Design Guide 提供完整的技术方案模板:
- 需求分析
- 架构设计
- 技术选型对比
- 风险评估
- 实施计划
4. API 设计指南 - RESTful 规范全覆盖
还在为 API 命名纠结?API Design Guide 帮你规范 API 设计:
- URI 命名规范
- HTTP 方法语义
- 统一响应格式
- 错误码定义
- 版本管理策略
5. 项目文档生成器 - 新项目快速上手
接手新项目不知道从哪开始?Project Docs Generator 自动生成三层文档体系:
- 第一层(10分钟):快速概览,帮你判断项目是否适合
- 第二层(1-2小时):核心入门,帮你快速上手开发
- 第三层(按需阅读):深度手册,支持文件级细节参考
6. 代码重构指南 - 技术债务清理利器
遗留代码难以维护?Code Refactor Guide 提供系统化的重构方案:
- 代码异味识别
- 分步骤重构计划
- 风险评估与回滚方案
- 重构前后对比
快速使用
方式一:直接复制
# 在 AI 对话中粘贴
请使用代码审查助手帮我审查以下代码:
{paste code here}
方式二:作为上下文引用
将 Prompt 文件内容作为上下文,让 AI 理解你的项目规范。
文件结构规范
每个 Prompt 包含两个文件,职责分明:
| 文件 | 用途 |
|---|---|
{name}.md | 功能说明、使用场景、示例 |
{name}_prompt.md | 完整的 Prompt 原文 |
欢迎贡献
Common Prompt 不仅是工具,更是团队知识沉淀的平台。我们欢迎任何形式的贡献:
贡献方式
- 提交新的 Prompt:发现研发中常用的场景,贡献你的 Prompt 模板
- 改进现有 Prompt:优化描述、补充示例、提升效果
- 报告问题:遇到不适用的场景,提交 Issue 反馈
- 分享使用心得:在 Issues 中分享你的使用经验
贡献规范
# 创建新 Prompt
prompts/
└── new-category/ # 分类目录(小写,多词用-分割)
├── new-prompt.md # 功能说明
└── new-prompt_prompt.md # Prompt 原文
质量标准:
- 清晰的场景描述
- 可运行的示例
- 无歧义的指令
- 适配主流 AI 模型
项目愿景
我们希望 Common Prompt 能够成为:
- 研发团队的 Prompt 共享平台
- AI 提效经验的沉淀地
- 新人快速融入团队的辅助工具
一个人的 Prompt,经过团队的验证和优化,会变得越来越好用。
最后
如果你也觉得有用,欢迎:
- Star 支持一下
- Fork 基于此项目构建你的私有 Prompt 库
- PR 贡献你的经验和模板
让我们一起,用更好的 Prompt,调教出更聪明的 AI。
GitHub 地址:shxlsp@github.com/shxlsp/comm…
在线文档:shxlsp@github.com/shxlsp/comm…
期待你的参与!
好的工具需要不断打磨,好的 Prompt 也需要持续迭代。 加入我们,一起打造研发团队的 AI 提效利器。