CLAUDE.MD

概述

CLAUDE.MD 是为 AI agent 提供最优项目入门上下文的特殊文件，在每次 Claude Code 对话中自动包含，是让 AI agent 了解代码库的主要入门文档。

关键内容

1. 核心原则：
2. LLM 是无状态的：CLAUDE.MD 是每次对话中唯一会自动包含的文件
3. 少即是多：前沿 LLM 大约能遵循 150-200 条指令，Claude Code 的系统提示词本身已占约 50 条，因此 CLAUDE.MD 必须聚焦且简洁
4. 只放通用信息：只包含每次会话都适用的内容

5. 不要把 Claude 当成 lint 工具：风格指南会膨胀上下文并降低指令遵循效果

6. 内容策略 (WHAT, WHY, HOW)：

7. WHAT - 技术与结构：技术栈概览、项目组织方式、关键目录及其用途
8. WHY - 目的与背景：项目功能、架构决策原因、各组件职责

9. HOW - 工作流与约定：开发流程、测试命令、构建方法、关键"坑点"

10. 渐进式披露策略：

11. 对较大项目建议创建 agent_docs/ 文件夹
12. 例如 agent_docs/building_the_project.md、agent_docs/running_tests.md

13. 在 CLAUDE.MD 中引用这些文件，避免内容过多

14. 必备章节结构：

15. 技术栈（主语言、关键框架、数据库）
16. 项目结构（对 monorepo 尤其重要）
17. 开发命令（安装、测试、构建）
18. 关键约定（只保留非显而易见、高影响的约定）
19. 已知问题/坑点（常让开发者踩坑的内容）

来源

• raw/assets/claude-howto/03-skills/claude-md/SKILL.md — 官方技能文档
• Claude How To Slash Commands Reference — 配置指南

相关

• Claude Code — part_of
• Skills — relates_to
• AGENTS.MD 项目约定文件 — relates_to
• Context Engineering — relates_to