Type: concept
Confidence: 0.70
Created: 2026-04-25
Updated: 2026-04-25
Tags: ai-engineeringdocumentationagent-guidanceAI工程

CLAUDE.md文档

概述

CLAUDE.md是为AI Agent(特别是Claude Code)设计的配置文档,用于定义项目规则、架构约束和开发规范,使Agent能够理解并遵循项目的特定要求。

关键内容

  1. 作用与意义
  2. 为AI Agent提供项目的架构规范、命名约定、错误处理策略
  3. 包含"禁止做什么"的负面清单和其他约束条件
  4. 作为Agent的行为准则和操作指南

  5. 演变过程

  6. 初始时可能只包含基本指导原则
  7. 随着Agent犯错,逐步添加规则、调整约束、补充上下文
  8. 经过多次迭代后可能变成数百行的详细文档

  9. Harness Engineering体现

  10. 代表Harness Engineering的核心理念:写CLAUDE.md花的时间比写代码还多,但这不是浪费时间
  11. 体现了"设计让代码被正确写出来的系统"这一理念
  12. 将项目规则写下来让机器能读懂,而非依赖人工review和口头传达

  13. 最佳实践

  14. 保持文档结构化组织,便于Agent按需加载
  15. 明确列出架构约束和质量标准
  16. 定期更新以反映项目变化和Agent学习结果
  17. 与CI/CD流程集成以自动验证Agent输出

来源

相关