跳到正文
教程31 篇

Claude Code第 2 / 4 篇

让 CLAUDE.md 成为可靠的项目说明

记录稳定事实,减少跨会话的重复沟通。

入门约 8 分钟练习资料核实

学习目标

保留简短、正确、能在新会话核对的项目级指引。

对照示意什么该写进 CLAUDE.md
  1. 长期规则

    项目用途、验证入口、目录职责和不能自行补写的业务边界。

  2. 本次任务

    具体目标、测试地址、一次性数据和临时进度。

长期事实留在仓库指引,本次任务的目标和数据留在对话。

适用场景

Claude Code 能改代码,但经常选错测试入口,或者每次都要重新解释目录职责。

准备条件

  • 可以核对项目 README、脚本和目录结构。
  • 能够查看已存在的 CLAUDE.md 与 AGENTS.md。

操作步骤

  1. 先看已经加载的项目指引

    先确认项目使用哪份指引,避免为同一规则维护多份互相冲突的副本。Claude Code 支持根目录 CLAUDE.md 或 .claude/CLAUDE.md。

  2. 需要起始文件时用 /init

    /init 能基于仓库生成起始说明。生成后检查测试命令、目录和架构是否符合实际,删掉没有依据的约定。

    Claude Code 交互命令
    /init
  3. 将长久有效的约定写成短句

    写项目用途、常用检查、职责边界。不要把每次任务的所有对话抄进去;配置权限与指引内容也应分别维护。

    项目指引结构示意
    ## 项目概况
    说明产品用途与核心目录。
    
    ## 验证方式
    填写已核对的构建、测试与页面验证入口。
    
    ## 业务边界
    说明哪些规则必须保留,哪些未知项不能自行补写。
  4. 在下一次会话核对加载效果

    可用 /memory 查看记忆入口,并让 Claude 指出本任务引用的规则。项目结构变化后修正相关条目,不以文件存在代替有效性检查。

    核对提示词
    请指出这次任务加载并适用的项目指引、相关检查入口和不能自行推断的业务规则。
    若指引与仓库现状不一致,请先给出具体差异。

常见误区

把 CLAUDE.md 当作强制权限配置
行为指引和客户端执行权限分别配置,不能用文字替代权限机制。
多个指引重复同一内容却不同步
选定事实来源并减少重复,核对当前版本实际加载了哪些文件。

验收清单

  • 启动和检查入口与当前项目配置一致。
  • 指引没有密钥和一次性任务长记录。
  • 新会话能说明使用的指引和仍然未知的事项。

资料与版本

本文为原创整理,示例需按项目调整;工具界面与功能以当前版本为准。