Cursor 怎么给项目加文档索引
模型给的接口用法还是旧版本,改起来比重写还慢。加文档索引能让它按当前版本文档回答,这篇讲怎么加、怎么更新、抓没抓到。
用编辑器里的 AI 写代码,最烦的是它给的接口签名对不上当前版本:参数名改了、方法废弃了,报错还得自己查。原因是模型的训练数据有时间差。文档索引就是补这个缺口,把官方文档抓进项目上下文,提问时让它按文档回答。
入口在哪
- 对话输入框里打一个 at 符号会弹出引用列表,列表里有添加文档的入口。
- 设置里有文档管理相关的面板,能看到已加的文档、抓取状态和删除入口。
- 不同版本的位置和叫法略有差别,先试输入框里的引用列表,那里最直接。
具体步骤
- 找对文档地址。优先用官方文档首页或对应版本的文档,不要用博客教程页,博客里的示例常停留在两三个大版本之前。
- 填地址时尽量指到具体章节,整站抓取会把过期页面和历史版本一起带进来。
- 给它起个能看懂的名字,例如某框架加版本号,后面引用时靠这个名字选。
- 等抓取完成,进度走完之前提问拿不到内容。
- 在对话里引用这份文档再提问,问题带上版本号和函数名,比泛泛问怎么用更准。
- 项目升级后重新加一次,旧文档删掉,两份同名文档同时存在会互相干扰。
几个坑
- 抓到的是渲染前的空页面。靠脚本渲染的文档站,抓下来可能只有导航,等于没引用。
- 文档版本和项目版本不一致,回答越自信错得越准。先确认文档页上的版本号。
- 索引不是实时的。文档更新后不会自动同步,改过就重新添加。
- 把内部私有文档地址加进去。内容会被送去抓取,涉密的别加,用本地规则文件代替。
怎么验证
挑一个只在这个版本文档里出现的函数名去问,回答能给出正确签名和参数,说明抓到了。再问一个近期废弃的方法,看它是否会提示已废弃。最后在引用列表里确认这条文档是选中状态,没选中时回答其实没用到它。连续换两个问题都不对,就回到文档页核对自己引用的到底是哪一份;回答里冒出文档中根本没有的参数名,说明它仍在用训练数据里的旧写法。
常见问题
加了文档还是答错版本
多半是提问时没引用这份文档,或者项目里还留着旧版本的条目。删掉旧的,提问时明确引用新的那份。
能加多少份文档
数量上有上限,具体看当前版本说明。实际用两三份核心文档就够,加太多反而稀释了相关性。
抓取失败怎么办
先换一个更具体的页面地址,只抓单个章节成功率更高。还失败就把关键几页导出成文本放进项目,用文件引用代替文档索引。
一句话总结:文档索引解决的是版本差,指到具体章节、名字带版本、提问时显式引用,升级后记得换掉旧的。