用途:创建或整理告诉编码智能体如何在仓库中工作的 CLAUDE.md 或 AGENTS.md 文件。核心原则是只写真实、仓库特有、且无法通过浏览代码自行推导的内容,其余都会消耗上下文。目标长度低于 100 行,超出则属于文档,应放入 docs/ 并在此处留指针。
应包含:不明显的命令,如本仓库的开发、构建、测试、lint 和单测命令及易忘参数(示例:npm run dev、npm test -- <file>);用五行说明架构,入口点、数据层位置、调用关系;linter 无法捕获的约定,如错误处理、状态管理、应复用的工具、命名模式;陷阱,即曾让人耗费一小时的坑;硬规则,如不得提交到 main、不得手改生成文件、不得擅自加依赖。
不应包含:通用编程建议、智能体能秒读的依赖列表或目录树、尚未实现的设想、长代码示例(改为指向示例文件)。
构建方式:阅读 README、package.json 脚本、CI 配置和贡献文档;浏览顶层目录与核心导入文件;查看 git log 中变更最多的部分;向用户询问陷阱,这是无法自行推断的部分;写完后再删减三分之一。结构建议:# 项目名、一句话说明、## Commands、## Architecture、## Conventions、## Traps、## Rules。
维护:当智能体犯下本可由该文件避免的仓库特有错误时补充;发现某条指令不成立时立即修正。嵌套文件可用:在包或应用目录内放置 CLAUDE.md 可作用于该子树,适用于 monorepo 中各包差异明显的情况。资料未提供该技能的具体安装命令、平台与收费信息。