如何快速搭一个本地提示工程知识库:5 分钟跑通 Prompt Engineering Guide
【免费下载链接】Prompt-Engineering-Guide🐙 Guides, papers, lessons, notebooks and resources for prompt engineering, context engineering, RAG, and AI Agents.项目地址: https://gitcode.com/GitHub_Trending/pr/Prompt-Engineering-Guide
给大语言模型做应用时,你大概率会先撞上这样一个场面:同一条提示词,第一次跑输出很对,第二次就跑偏了。想定位原因,你得回头翻提示技巧、查模型行为说明、核对上下文里塞了哪些信息——这些资料散落在一堆博客和论文里,找起来比调试本身还慢。
Prompt Engineering Guide 就是把这些零散内容整理成可本地运行的文档站:论文清单、技巧讲解、应用案例、可运行的 notebook,全部按章节归置,并且提供 13 种语言版本,每章内容都是你能直接读到、改到、翻译的源文件。
这篇文章带你用几分钟把它跑起来,再用两个真实任务走一遍它的核心内容,最后把新手容易踩的坑列成一张清单。
30 秒认识项目
这个仓库本质上是一个"内容 + 站点"的文档工程:基于 Nextra 文档框架,所有章节放在 pages/ 目录下,每章一个子目录,同一主题按语言拆成带后缀的文件(.en.mdx、.zh.mdx、.ar.mdx 等),侧边栏顺序则由各目录下的 _meta 文件控制。
内容上它覆盖五条线:提示基础、提示技巧、RAG 与 AI Agents、应用案例、模型与风险。如果你是给团队搭提示规范的开发者,或需要接手文档翻译与维护,这个仓库是一个能直接开工的起点。
站点的第一印象来自一个很小的例子:模型收到 "The sky is",补全出 "blue"。
这个入门章节的开篇例子,直接点出了整个项目想回答的问题:你输入什么、怎么说,决定模型输出什么。
最短路径跑起来
前提是 Node 18 以上,并已安装 pnpm。四步走完:
git clone https://gitcode.com/GitHub_Trending/pr/Prompt-Engineering-Guide cd Prompt-Engineering-Guide pnpm install pnpm dev终端出现就绪提示后,浏览器打开 http://localhost:3000/ ,左侧就是完整导航:Introduction、Prompting Techniques、AI Agents、Applications、Prompt Hub、Models。每个导航项对应 pages/ 下的一个目录,你在页面上看到的内容,几秒内就能追溯到对应的 .mdx 源文件。
用一个真实任务走通核心功能
任务一:读懂"什么才算 Agent"
目标:把 AI Agent 和普通聊天调用区分开。
做法:从侧边栏进入 AI Agents 章节,第一页就会看到这张组件图:
图里把 Agent 拆成三块:模型负责推理,工具负责行动(调 API、查数据库),记忆负责留存上下文。
结果:拿着这个框架,你再读同章节的 function calling 和 deep agents 页面,每一页正好对应其中一个组件,阅读顺序自然就有了。
任务二:用 Few-Shot 练一个日志分级提示
目标:让模型稳定输出日志级别。
做法:与其在提示里解释"什么算警告",不如直接把几个样例贴进去,格式本身就是指令:
ERROR: 数据库连接超时,重试 3 次失败 WARN: 缓存命中率低于 80% INFO: 订单服务启动成功 磁盘使用率达到 91%,请分级:结果:模型给出 WARN。Few-Shot 这一章里还有一个反直觉的发现——样例的标签贴错也没关系,模型真正学到的是标签集合和输出格式,而不是每条样例的对错。
关键机制拆解
仓库里的内容,串起来其实是一条"输入 → 处理 → 输出"的链路,三段各解决一个具体问题。
输入端:给模型一个参照系
它解决的问题:指令模糊时,输出空间太大,模型只能蒙。
做法:把输入拆成四个部分——指令、上下文、输入数据、示例(elements 页面有逐项说明)。任务难就加示例,像上面的日志分级;模型缺它不知道的知识,就先从外部文档库检索相关片段塞进上下文,这就是 RAG 章节覆盖的事。
处理端:让模型把推理摊开
它解决的问题:模型急着给结论,中间一步算错全错。
做法:在提示里要求它逐步作答,即 Chain-of-Thought。技巧章节的 Auto-CoT 实验把这种"先拆步再给答案"的模式量化了出来:
换成你自己的任务感受一下:
顾客退 5 件商品中的 2 件,每件 39 元, 另退运费补贴 8 元,包装费 15 元不退。 第 1 步:商品退款 = 2 × 39 = 78 第 2 步:合计退款 = 78 + 8 = 86 元结果:中间步骤摆出来后,哪一步错了肉眼可见。同目录的 Self-Consistency 页面再进一步:多跑几次取多数答案,稳定性还能再提一档。
输出端:让结果能被程序接住
它解决的问题:自然语言式的输出没法直接解析,下游脚本一行格式对不上就中断。
做法:把输出格式写进提示——要 JSON、要表格、要固定字段顺序;量大了之后加一道校验,让模型对照约束自查,或交给格式校验器兜底。research 目录里关于结构化输出的章节有现成方案可抄。
踩坑清单
现象:pnpm dev 启动时报端口占用。原因:3000 端口已有别的进程在跑。解法:结束占用进程后重启,或换一个空闲端口再启动。
现象:安装或构建报错,依赖拉不下来。原因:Node 版本低于 18。解法:升到 Node 18 以上,删掉 node_modules 重新执行 pnpm install。
现象:新写了章节文件,侧边栏里却不显示。原因:只加了 mdx 文件,没在该目录的 _meta.xx.json 里登记条目。解法:在对应语言的 _meta 文件里补上键值对,键和文件名一致,值写显示名称。
现象:翻译完一章,页面打不开或内容缺失。原因:文件名后缀和目录约定没对齐,每章是"名称.语言.mdx"的命名格式。解法:对照同目录已有文件的命名;注意阿拉伯语单独放在 ar-pages/ 目录,其他语言才进 pages/ 下的语言后缀文件。
往哪走
刚上手的话,按顺序读完 introduction 目录的五页,再进 techniques 挑一个和你业务对口的页面把例子跑一遍。技巧过完之后,自然的下一站是 agents(function calling、deep agents 两条线),以及 guides 目录下较新的主题:上下文工程、深度研究、推理模型。
想参与贡献,门槛最低的是翻译:在 pages/ 下挑一种语言的 mdx 和 _meta 文件逐节补全即可。内容型贡献走 guides/ 目录,每个文件就是一个独立主题(prompts-intro.md、prompts-basic-usage.md 这类)。拿不准就开一个 issue 先讨论,或者直接提 PR。
这个仓库把"提示怎么写"从零散的博文变成了一套可本地运行、可逐章修改、可翻译的文档工程。现在就可以执行 pnpm dev,等侧边栏跳出来后,挑一个最贴近你业务的技巧页面,把示例完整做一遍。
【免费下载链接】Prompt-Engineering-Guide🐙 Guides, papers, lessons, notebooks and resources for prompt engineering, context engineering, RAG, and AI Agents.项目地址: https://gitcode.com/GitHub_Trending/pr/Prompt-Engineering-Guide
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考