跳转到内容
AI 编程入门手册

读项目指令：让 Codex / Claude Code 先只读，不改文件

这页适合第一次打开陌生项目的人。目标不是让 Codex / Claude Code 立刻改代码，而是先把项目地图画出来。

先别做什么

Section titled “先别做什么”
  • 不要让 agent 直接“帮我优化整个项目”。
  • 不要让 agent 先安装依赖。
  • 不要运行会写入文件、改配置、提交代码的命令。
  • 不要把私人仓库地址、Token、cookie 直接贴到公开工具里。

可复制提示词

Section titled “可复制提示词”
我是新手。请先只读这个项目，不要修改文件，也不要运行会写入文件的命令。


请用 6 部分解释：
1. 这个项目大概是做什么的
2. 主要目录分别有什么用
3. 启动项目通常要看哪些文件
4. 页面入口、配置文件、依赖文件分别在哪里
5. 新手最容易改错哪里
6. 如果我要改一个页面标题，应该先看哪些文件


如果你需要运行命令，只能先列出命令、作用、是否联网、是否写文件、失败后怎么恢复，等我确认。

成功标志

Section titled “成功标志”
  • 你能说出入口文件、页面文件、配置文件分别在哪里。
  • agent 没有擅自改文件。
  • agent 没有直接运行安装、格式化、删除或提交命令。
  • 下一步任务变成一个小动作，例如“只改一个页面标题”。

读完项目后，输出应该长什么样

Section titled “读完项目后，输出应该长什么样”

下面是一个合格输出的样子。它不一定和你的项目文件名完全一致，但必须具体到“文件、作用、下一步”。

项目判断：
这是一个前端站点项目，核心代码在 src/，构建配置在 package.json 和框架配置文件里。


我会优先看：
1. package.json：确认脚本、框架和依赖
2. src/pages/ 或 src/app/：确认页面入口
3. src/components/：确认复用组件
4. 配置文件：确认路由、站点元信息、构建方式


如果目标是“改首页按钮文案”：
- 先看首页入口文件
- 再看按钮组件是否复用
- 最小交付是只改一个按钮文案
- 不碰样式系统、依赖、路由和构建配置


验证：
- 启动本地页面或构建后打开首页
- 确认按钮文案变化
- 确认其他页面没有被顺手改动

不合格输出通常长这样：

我会全面分析项目结构，优化代码质量，提升用户体验，并给出最佳实践建议。

看到这种输出，不要继续。直接追问：

这还是通用建议。请只基于当前仓库，列出你已经确认存在的文件路径、每个文件和我的目标有什么关系，以及下一步最多应该改哪 1-3 个文件。

常见错误

Section titled “常见错误”
  • 提示词太大：比如“帮我完整理解这个项目并优化”。这会让 AI 输出空话。
  • 没有限制权限：没有写“不要修改文件”，AI 可能直接开始改。
  • 不问验证方式：读懂项目后仍然不知道下一步怎么确认。

下一步

Section titled “下一步”

读完项目后，再进入 改小功能提示词。如果中途报错，先用 报错排查提示词。

来源与日期

Section titled “来源与日期”