研发团队通用 Prompt (提示词) 模板库 v1.0

这是一份《研发团队通用 Prompt (提示词) 模板库 v1.0》

为什么需要这份库?

AI 的输出质量完全取决于输入质量(Garbage In, Garbage Out)。为了避免团队成员生成“不可维护的垃圾代码”或“无效的文档”,必须将 Prompt 工程化、标准化。

请将此文档集成到您团队的 Cursor / GitHub Copilot / 内部 GPT 平台 的常用命令或 Snippets 中。


⚡ 研发团队通用 Prompt 模板库 v1.0

通用公式 (The Golden Formula):

Prompt = 角色 (Role) + 背景 (Context) + 任务 (Task) + 约束 (Constraints) + 输出格式 (Output)


1. 开发辅助类 (Development)

1.1 生成新功能代码 (New Feature)

目的: 生成健壮、防御性强、符合规范的代码。

复制模板:

Markdown

你是一位资深的 [语言,如 Java/Python] 工程师。
**任务:** 请编写一个函数/类,用于 [描述具体功能,如:解析上传的 Excel 文件并存入数据库]。
**约束条件:**
1. **防御性编程:** 必须处理边缘情况(如输入为空、格式错误、文件过大)。
2. **错误处理:** 不要直接吞掉异常,使用自定义异常抛出。
3. **性能:** 思考到 [如:百万级数据] 的场景,请优化内存使用。
4. **注释:** 为关键逻辑添加 [中文/英文] 注释。
5. **库限制:** 仅使用 [如:Pandas/Apache POI] 库,不要引入新的冷门依赖。

1.2 代码重构与优化 (Refactoring)

目的: 优化“屎山”代码,提升可读性。

复制模板:

Markdown

你是一位代码重构专家 (Clean Code Expert)。
**任务:** 请审查并重构以下代码。
**目标:**
1. **提高可读性:** 将复杂的嵌套 `if-else` 扁平化,或提取为独立函数。
2. **命名规范:** 变量名需符合 [驼峰/下划线] 命名法,且语义清晰。
3. **逻辑保持:** **绝对不要**改变代码原有的业务逻辑。
**代码片段:**
[粘贴代码]

1.3 解释复杂代码 (Explanation)

目的: 快速理解接手的旧代码或复杂正则。

复制模板:

Markdown

请像给初级工程师讲解一样,解释这段代码。
**要求:**
1. 不要逐行翻译,请通过“数据流向”来解释业务逻辑。
2. 指出这段代码中潜在的风险点或性能瓶颈。
3. 如果其中有正则表达式,请分步拆解其匹配规则。
**代码片段:**
[粘贴代码]


2. ️ 质量与安全类 (QA & Security)

2.1 生成单元测试 (Unit Tests)

目的: 满足 Code Review 中“高覆盖率”的要求。

复制模板:

Markdown

你是一位 QA 自动化专家。
**任务:** 为以下函数编写单元测试,使用 [框架,如 JUnit 5 / Jest]。
**要求:**
1. **覆盖率:** 必须覆盖 Happy Path (正常路径) 和 Sad Path (异常路径)。
2. **边界值:** 包含 Null、空字符串、负数、最大值等边界测试。
3. **独立性:** 使用 Mock 对象 (如 Mockito) 隔离外部依赖(数据库/网络)。
**待测代码:**
[粘贴代码]

2.2 自测/预审查 (Self-Check)

目的: 在提交 Code Review 前,自己先过一遍,减少被骂的概率。

复制模板:

Markdown

你是一位严格的代码审查员 (Code Reviewer) 和安全专家。
**任务:** 审查我写的这段代码,寻找 Bug 和安全漏洞。
**重点检查:**
1. 是否存在 SQL 注入、XSS 或 RCE 风险?
2. 是否存在资源未释放 (Memory Leak) 问题?
3. 是否处理了所有可能的异常?
**输出格式:** 请列出问题列表,并按“严重程度”排序,最后给出修复后的代码。
**代码片段:**
[粘贴代码]

2.3 生成测试数据 (Mock Data)

目的: 生成脱敏的、逼真的测试数据。

复制模板:

Markdown

请生成 [数字] 条 JSON 格式的测试数据,用于测试 [某场景,如电商订单系统]。
**字段要求:**
– user_id (UUID)
– email (看起来真实的虚拟邮箱)
– amount (10.00 到 5000.00 之间的浮点数)
– status (随机分布在:Pending, Paid, Failed)
**注意:** 不要使用任何真实存在的个人信息。


3. 需求与文档类 (PM & Docs)

3.1 需求转用户故事 (PRD to User Story)

目的: 协助 PM 快速拆解需求。

复制模板:

Markdown

你是一位灵敏产品经理 (Agile PM)。
**背景:** 我们要开发一个 [功能,如:用户积分兑换] 系统。
**任务:** 根据以下原始需求,拆解为 3-5 个标准的 User Story。
**格式:**
– **标题:** 作为 [角色],我想要 [功能],以便于 [价值]。
– **验收标准 (AC):** 使用 Gherkin 语法 (Given/When/Then)。
**原始需求:**
[粘贴一句话需求或草稿]

3.2 SQL 生成与解释 (SQL Helper)

目的: 辅助非技术人员查数,或开发人员写复杂查询。(注意:严禁粘贴真实表结构,请使用假名)

复制模板:

Markdown

我有一个表 `Orders` (字段: id, user_id, created_at, amount) 和表 `Users` (字段: id, signup_date)。
**任务:** 请写一个 SQL 查询。
**目标:** 找出 2024 年注册的用户中,订单总金额最高的 Top 10 用户。
**方言:** MySQL 8.0


4. ⚠️ 特殊技巧:思维链 (Chain of Thought)

当任务超级复杂时,要求 AI “一步步思考”,准确率会显著提高。

通用后缀模板:

Markdown

… (你的任务描述)

请一步步思考 (Let's think step by step):

先分析需求的核心难点。

设计大致的算法思路或伪代码。

最后生成完整的代码。


© 版权声明
THE END
如果内容对您有所帮助,就支持一下吧!
点赞0 分享
评论 共6条

请登录后发表评论