跳到主要内容

提示词模板

50+经过验证的AI编程模板

现成的提示词模板可从AI助手获得更好的结果。按任务类型组织以便快速参考。

模板类别

🐛 调试

12个模板用于更快地找到和修复bugs。

🔄 重构

用于安全重构、迁移与代码整理的模板。

测试

用于单元/集成测试、边界情况与回归覆盖的模板。

📝 文档

用于 README、docstring、API 文档与排错指南的模板。

🔍 代码审查

用于审查清单、安全检查与可执行反馈的模板。

🧭 规划

用于任务拆解、风险检查与分步执行的模板。


读懂陌生代码库:沿一个命令找到调用链

打开一个陌生的小型代码库时,一个可行的切入点是选定一条命令,从入口函数出发,逐步跟踪它调用了哪些函数、每步做了什么,最后预测输出,再运行验证。


下载练习文件

下载 codebase-reading-lab.zip,解压后进入 codebase-reading-lab 目录。目录中包含五个文件:main.pyrepository.pyquery.pytasks.jsonREADME.md。本练习只需 Python 3 标准库,无需第三方包、网络连接、API 密钥或数据库。运行前请确认已安装 Python 3。


可复用 AI 提示词

将以下提示词复制到你常用的聊天窗口,再按说明填入文件内容和命令。

提示词说明: 本次练习将 [COMMAND] 替换为 python3 main.py;将 [目录树 / 带标签的相关文件] 替换为 main.pyrepository.pyquery.pytasks.json 四个文件的完整内容,每段内容前注明文件名。


我提供以下文件供你分析:[目录树 / 带标签的相关文件]

请执行以下步骤:

1. 先列出你能实际读到的文件,无法读取的文件不要假设其内容。
2. 找到命令 [COMMAND] 的真实入口点,说明程序从哪里开始执行。
3. 确定参数解析逻辑和各参数的默认值,直接引用源文件和行号。
4. 按实际调用顺序(包括嵌套情况)追踪每一步调用,引用具体的文件:行号
和相关代码片段,解释每步为何运行。
5. 区分两类内容:
- 基于源代码的推断(标注"源码分析")
- 实际执行的观察结果(标注"执行结果");
如未执行,请将预测结果标注为"预测"。
6. 在运行命令之前,先写出你对输出的预测,说明推断依据。
7. 如果某个导入文件未提供,不要假设它不存在于运行时,也不要根据函数名
猜测其实现逻辑。请向我说明缺少哪些文件,并等我补充后再预测完整输出。
8. 仅做阅读分析,不修改、重构或审查代码。
9. 如果你无法读取文件,请告诉我,我将以"文件名:内容"格式逐一粘贴文件文本。

提供文件的方式: 将四个文件的完整内容粘贴到同一条消息中,每段前注明文件名(例如 ### main.py)。如果你的聊天工具支持附件,也可以直接附上文件——但请先让助手确认它能读取附件,读取失败时改用粘贴文本。如果需要分多条消息发送,先告诉助手等你发完所有文件再开始分析,再逐条发送,最后用一条消息表示"文件已全部提供"。README.md 供你自己阅读参考,无需提供给助手。

提示不保证答案正确。 助手可能遗漏细节或填补假设。你必须自己对照源码核查每一处引用。


本次练习的参考答案

以下调用链均来自实际源码,可供你核查自己的分析:

  • 入口main.py:19–20if __name__ == "__main__": main() 触发执行。
  • 参数解析main.py:11–13--status 默认 "open"--data 默认为与 main.py 同目录的 tasks.json(与当前工作目录无关)。
  • 第一步调用main.py:14 调用 load_tasks(args.data)repository.py:4–6 打开文件并用 json.load 解析,返回列表。
  • 第二步调用main.py:15 调用 select_tasks(tasks, args.status)query.py:1–3status 字段过滤,再按 id 字段字典序排序,返回匹配列表。
  • 输出main.py:16print(json.dumps(...)) 将结果打印为一行 JSON。

main 依次独立调用 load_tasksselect_tasks,两者之间没有嵌套关系;json.dumps 先求值,其返回值再传给 print

T2 被默认排除,因为 tasks.json 中 T2 的 status"done",默认筛选条件是 "open"T1 出现在 T3 之前,因为 select_tasksid 字段字典序排序,"T1" < "T3",与输入文件中的顺序无关。

预测输出——python3 main.py(默认 --status open):

[{"id": "T1", "title": "Find the entry point", "status": "open"}, {"id": "T3", "title": "Write a usage note", "status": "open"}]

预测输出——python3 main.py --status done

[{"id": "T2", "title": "Run the example", "status": "done"}]

自查清单

运行命令后,对照以下几点确认你的分析:

  • 你是否在源码中找到了调用链每一步的具体行号,而不只是函数名?
  • 你是否能用 query.py 的排序逻辑解释为什么 T1 出现在 T3 之前?
  • 你是否在运行前写下了自己的预测,并在运行后与实际输出逐字对比?
  • 你是否用 --status done 验证了另一个结果,并确认源文件未被修改?

没有 Python 环境时,可以完成源码阅读和预测部分,但"运行验证"一步需等到有可用的 Python 3 环境后再完成。


用你自己的代码库试一试

选出你项目中一条你想理解的命令,找到与之直接相关的入口文件和它显式导入的模块(通常是少数几个文件)。将这些文件提供给助手,填入提示词后按同样步骤操作。这个练习只覆盖你选定的那条命令所经过的路径,不代表你理解了整个代码库的全部行为。


快速开始

  1. 选择上面的一个模板类别
  2. 复制你需要的模板
  3. 填写你的具体细节
  4. 粘贴到你的AI助手中
  5. 根据结果迭代

专业提示

  • 具体明确:添加上下文和约束条件
  • 提供示例:展示你想要的内容
  • 迭代:根据第一个响应进行细化
  • 保存赢家:保留那些有效的模板

FAQ

我应该先用哪个模板?

建议先从调试模板开始,能快速学会提供上下文和错误信息。

如何定制这些模板?

把占位符替换成真实代码、约束与验证方式。

怎么判断提示词有效?

输出应可验证,能通过测试或复现步骤确认正确。