项目指令与记忆


保存项目约定

CLAUDE.md 是供 Claude Code 读取的 Markdown 指令文件,适合保存需要在多次会话中持续使用的项目约定,例如运行方式、测试要求、目录用途和业务规则。将这些内容写入文件后,可减少每次开始任务时重复说明的工作。

在项目目录启动 Claude Code 后,输入 /init,可根据现有代码生成初始项目指令。已有 CLAUDE.md 时,该命令会提出改进建议。生成后应核对其中的命令和规则,尤其检查是否将临时尝试误写为固定要求。

image-20261026102758188

常见文件位置如下,可结合 配置目录说明 核对:

文件位置适用范围适合保存的内容
~/.claude/CLAUDE.md本机当前用户的各个项目个人表达偏好与通用工作习惯
项目根目录的 CLAUDE.md当前项目项目结构、开发约定与检查要求
项目内的 .claude/CLAUDE.md当前项目与根目录文件相同的项目指令用途
项目根目录的 CLAUDE.local.md本人当前项目个人环境说明与本地操作习惯

项目共享规则应通过版本管理维护。个人项目文件宜加入 .gitignore ,避免将仅适用于个人环境的内容提交给其他成员。指令文件中不得保存密码、访问令牌或其他凭据。

以下为虚构项目“溪亭书目”的简短规则示例。使用前应按照实际项目修改,不应直接将示例要求视为通用开发规范。

# {听溪书单}项目约定

## 项目用途
本项目用于管理个人阅读记录,界面采用简体中文。

## 开发要求
- 修改前阅读 README.md 及相关功能的现有实现。
- 优先沿用项目已经使用的依赖与代码风格。
- 调整数据结构时,说明对已有记录的影响。
- 界面日期统一显示为 YYYY-MM-DD。

## 检查要求
- 根据本次改动选择相关测试和构建检查。
- 记录实际执行的命令及结果。
- 无法执行的检查应说明原因,不标记为通过。

## 交付要求
- 使用正式中文说明修改内容、验证结果和待处理事项。
- 提供涉及文件的位置,便于复核。

规则应简洁、具体,并且能够持续适用。详细操作流程宜放入技能,特定模块的规则可拆分至 .claude/rules/ 。如需检查项目指令是否载入,可运行 /context ,查看其中的 Memory files。

image-20261026103043740

管理自动记忆

自动记忆由 Claude 根据交流中的偏好、反馈和项目背景整理,适合保留后续工作可能继续需要的信息。与用户维护的 CLAUDE.md 相比,自动记忆更侧重在任务过程中逐步积累的上下文。

一般本地会话默认开启自动记忆,可通过 /memory 查看和管理。其默认位置为 ~/.claude/projects/<project>/memory/ ,同一 Git 仓库的相关工作树与子目录共享该记忆目录;这些文件保存在本机,不应视为自动跨设备同步的资料。

MEMORY.md 用于组织记忆索引,会话开始时,系统载入其前 200 行或前 25KB,以先达到的限制为准,详细条目可保存在其他文件中。因此,不宜将完整需求文档、日志或大量代码堆入记忆索引。

image-20261026103057339

需要整理已积累的约定时,可提出以下要求:

请检查当前项目可用的指令与记忆,整理与《{听溪书单}》有关的有效约定。

重点检查:
{界面语言、日期格式、数据保存方式和验证要求}。

请区分长期规则、阶段性决定和已经失效的内容。
发现冲突时,列出具体位置及冲突原因。
本轮先输出整理建议,不修改相关文件。

维护有效规则

长期项目应定期清理不再适用的指令。例如,项目完成数据库迁移后,旧数据库的操作说明不应继续与新方案并列;已经取消的功能要求,也应从当前执行规则中移除。

修改规则时,宜说明调整原因、适用范围及原要求是否仍然有效。仅增加新条目而不处理旧条目,容易形成相互矛盾的执行依据。

请更新《{听溪书单}》的项目规则。

原要求:{阅读记录仅保存在浏览器本地}。
新要求:{当前版本通过后端接口保存记录}。

新要求替代原有存储方案。
请检查相关说明是否仍引用旧方案,并提出必要修改。
不得据此改动业务代码或迁移实际数据。

项目指令和自动记忆用于指导模型理解任务,不能替代文件权限、工具权限或系统隔离。涉及必须阻止的操作,应结合实际权限配置处理,而不能仅依赖文件中的文字约定。

评论

登录后查看