跳转到内容

目录树怎么交给 AI 看:用 AIGoCode 整理路径地图与待读文件清单

AIGoCode发布于 更新于

目录树与独立文件阅读清单

先给路径地图,再说明本次要解决的问题

把整个项目的文件名贴给 AI,并不能让它知道每个文件里的代码。目录树适合回答“东西大致放在哪里”,具体修改还需要文件内容、调用关系和本次任务范围。接手一个陌生项目时,可以把两类材料分开交付:一份简短的结构地图,以及一份与任务直接相关的待读文件清单。

AIGoCode 工具目录中的“目录树生成”用于把路径列表转为可放进 README 的 ASCII 目录树。下面给出的是人工整理交接材料的方法,不是工具会自动分析项目、读取代码或判断架构的承诺。

第一步:按任务选路径,先排除无关内容

假设要请 AI 排查“保存表单后列表没有更新”。不必从整个仓库开始,可以先整理保存入口、请求调用、列表读取和相关测试的路径。项目里的实际名称要自己核对,不要因为示例里写了某个目录,就要求 AI 去找同名文件。

一份虚构的小项目可能包含 src/pages/editor.tsx、src/api/save.ts、src/pages/list.tsx 与 tests/save-flow.test.ts。这是说明整理方式的示例,不代表 AIGoCode 的源码结构。

筛选时逐项判断:

  • 保存入口和列表入口分别在哪个文件?如果尚不清楚,就在清单里标“待定位”。
  • 是否存在自动生成文件、依赖包或构建产物?本次不需要阅读的路径可以先省略,并说明省略范围。
  • 路径名本身是否含客户名称、内部项目代号或个人信息?分享前先核对接收方权限。

保留一份原始路径列表,以便发现少项时回查。结构地图可以精简,但要注明它是本次任务选集;不要让接收方误以为这是整个项目的完整目录。

第二步:生成树后,人工核对层级和入口

从目录树生成工具整理路径后,把输出与原始列表并排看。首先检查同名文件是否仍能通过父目录区分,再检查任务所需入口有没有遗漏,最后确认复制进 README 或聊天窗口后缩进是否清楚。

例如,src/api/index.ts 和 src/components/index.ts 虽然文件名相同,承担的任务可能完全不同。交接时应使用完整的项目内相对路径,避免只写“看看 index.ts”。目录层级只能帮助定位,不能证明某个文件一定负责请求或渲染;这些职责应在读取源码后再确认。

如果拿到的只是同事手工整理的列表,也要问清它对应哪一个版本。路径存在于旧版本,并不代表当前分支仍有同一文件。可在交接说明中记录分支或提交标识、整理日期和项目根目录的含义。

第三步:在树旁附一张待读文件清单

目录树保持简洁,解释放在独立清单。建议每个文件只附三项:为什么要读、需要核对的问题、当前掌握的证据。暂时不了解内容时写“待核对”,不要把文件名推测写成已确认事实。

材料本次阅读目的仍待确认
表单页面路径找到触发保存的位置是否等待保存完成再更新界面
请求调用路径核对参数和错误处理失败是否被界面忽略
列表页面路径找到数据读取来源保存后有没有重新取得数据
相关测试路径判断现有验证范围是否覆盖保存后列表更新

表中是通用排查问题,不预判项目使用哪种框架、缓存或状态管理方案。实际交给 AI 时,再提供经授权的相应源码片段;如果工具可以读文件,则明确允许读取的目录与本轮任务,先让它报告找到的证据,再决定修改范围。

第四步:用接收方视角验收这份交接

发送前可以做一次简短检查:接收方能否凭完整路径找到文件,能否分清“已读确认”与“待检查”,能否知道还缺哪份材料?如果必须反复追问“这个文件是哪个”,说明地图还需要补上下文。

一份可直接使用的交接说明可以写成:本次目标是排查保存后列表未更新;目录树仅列出相关路径,未列出的部分暂不分析;先读保存入口、请求调用和列表读取,再用测试验证定位;当前没有确认根因,不凭文件名直接改代码。

目录树生成完成只是把结构表达清楚。交接是否有效,要看读者能不能沿着路径找到证据、理解当前任务,并知道下一步该读什么。这样既便于同事接手,也便于把后续 AI 对话限制在真正相关的材料里。