展开知识库目录
AGENTS.md 和 CLAUDE.md 怎么写:构建命令、规范、禁区和完成标准
AGENTS.md 或 CLAUDE.md 不需要介绍公司历史。
项目规则文件要让 Agent 能行动和停下
AGENTS.md 或 CLAUDE.md 不需要介绍公司历史。它应给出适用目录、真实构建测试命令、源文件与生成物、代码规范、禁区、高风险动作和完成证据。
适用范围
说明规则覆盖目录、子目录覆盖方式和多文件优先级。
通过标准:Agent 知道当前文件受哪组规则约束
把涉及的文件、目录、版本、命令和实际输出写进记录;代码变化同时保留 diff 与测试结果。
项目入口
列依赖、启动、构建、测试、格式化和生成命令及工作目录。
通过标准:命令已在当前仓库实测
确认“项目入口”已经有可回查结果,再进入“编辑边界”;依据仍然来自猜测时,把缺口单列并停在当前步骤。
编辑边界
指出权威内容源、生成物、禁止目录、用户改动处理和允许的重构范围。
通过标准:不会误改产物或覆盖他人工作
确认“编辑边界”已经有可回查结果,再进入“风险与权限”;依据仍然来自猜测时,把缺口单列并停在当前步骤。
风险与权限
部署、删除、迁移、密钥、网络和生产操作的确认要求。
通过标准:不可逆动作有明确停止点
确认“风险与权限”已经有可回查结果,再进入“完成标准”;依据仍然来自猜测时,把缺口单列并停在当前步骤。
完成标准
要求 diff、测试、截图、日志、回滚和未验证项。
通过标准:完成可被另一人复核
需要修改时先限定文件和行为范围,无法说明回滚方式或影响面的动作先不执行。 完成后把证据归入“可执行项目规则文件”。
用两个真实任务测试规则
一个正常任务应能顺利完成,一个越界任务应触发停止。规则过长导致关键命令难找时拆到更近的子目录或引用已有文档。
