用途:让 AI 编程智能体(如 Claude Code、Cursor 等)在仓库中高效工作。核心是编写一份项目上下文文件(CLAUDE.md 或同类文件),把智能体无法自行推断的信息写清楚,避免它猜测架构、约定和命令。
主要能力:生成结构化 CLAUDE.md,包含项目是什么、架构与目录布局、关键约定(命名、模式、文件放置、风格)、构建/测试/lint/运行命令、护栏(不可触碰区域、完成前先跑测试、需人工批准的操作)以及维护习惯。强调“合适的高度”:足够快速定位,又不至于冗长到无人阅读。
必要输入:项目与栈、架构概况;约定;构建/测试/lint/运行命令;危险区域;目标智能体(文件名与位置可能不同)。
框架:Orient(先给地图)、Constrain(写清隐式约定与护栏)、Verify(给出命令让智能体自检)、Maintain(随项目更新,避免过期误导)。
输出格式:CLAUDE.md for [project],含 What this is、Layout、Conventions、Commands、Guardrails、Maintenance 等段落。
适用场景:新仓库接入 AI 智能体、智能体反复误解代码库、需要为项目建立 AI 上下文文件时。
限制:资料未提供具体安装命令、收费、价格、平台支持范围或效果数据;文件名称与位置因智能体而异,需按实际工具调整。