用途:指导创建有效的 CLAUDE.md 文件,为 Claude 提供项目必要上下文。其核心前提是 LLM 无状态,CLAUDE.md 会进入每次对话,因而成为上下文管理的主要工具。
主要能力与方法:采用 WHAT-WHY-HOW 框架组织内容——WHAT 指技术栈、项目结构与代码组织;WHY 指项目目的与组件职责;HOW 指命令、测试流程与验证方式。文件应包含构建与测试命令、项目结构概览、关键架构决策、本代码库特有模式与约定,以及 file:line 形式的文件引用,而非代码片段。
使用方式:先审计代码库,找出构建命令、测试流程与关键模式;起草最小内容,只保留 WHAT-WHY-HOW 要点;把任务特定内容移入 .claude/docs/ 等独立文件,并在 CLAUDE.md 中引用;以 file:line 替代代码片段;最后用“这会在每次会话中都有帮助吗?”检验普适性。文中给出的命令区块示例包括 Build、Test、Lint、Type check 等命令行。
限制与注意:前沿 LLM 可靠遵循约 150-200 条指令,Claude Code 系统提示已含约 50 条,留给 CLAUDE.md 的空间有限;目标控制在 300 行以内,最好少于 60 行,且每行应对所有会话都有普遍价值。不要把 CLAUDE.md 当作 linter,代码风格应交由 ESLint、Prettier、Biome 等确定性工具,并配置 hooks 自动运行格式化工具。避免自动生成,应手工撰写,不用 /init 命令。避免重复信息与代码片段。其他机制可按需替代:格式化用 hooks,任务特定指令用斜杠命令,近期变更上下文用引用版本控制的命令,一次性流程用独立 Markdown 文件。原文另附模板与参考资料路径 references/examples.md、references/anti-patterns.md;具体示例内容暂未提供。