CLAUDE.md文档
概述
CLAUDE.md是为AI Agent(特别是Claude Code)设计的配置文档,用于定义项目规则、架构约束和开发规范,使Agent能够理解并遵循项目的特定要求。
关键内容
- 作用与意义:
- 为AI Agent提供项目的架构规范、命名约定、错误处理策略
- 包含"禁止做什么"的负面清单和其他约束条件
-
作为Agent的行为准则和操作指南
-
演变过程:
- 初始时可能只包含基本指导原则
- 随着Agent犯错,逐步添加规则、调整约束、补充上下文
-
经过多次迭代后可能变成数百行的详细文档
- 代表Harness Engineering的核心理念:写CLAUDE.md花的时间比写代码还多,但这不是浪费时间
- 体现了"设计让代码被正确写出来的系统"这一理念
-
将项目规则写下来让机器能读懂,而非依赖人工review和口头传达
-
最佳实践:
- 保持文档结构化组织,便于Agent按需加载
- 明确列出架构约束和质量标准
- 定期更新以反映项目变化和Agent学习结果
- 与CI/CD流程集成以自动验证Agent输出
来源
- Harness Engineering的本质是什么? - riba2534 的回答 — 关于CLAUDE.md文档重要性和作用的讨论
相关
- Harness-Engineering — relates_to
- Claude-Code — relates_to
- Agent-Guidance — relates_to
- Context-Management — relates_to
- OpenAI百万行代码实验 — relates_to