> ## Documentation Index
> Fetch the complete documentation index at: https://aicoding.cscitech.top/llms.txt
> Use this file to discover all available pages before exploring further.

# CLAUDE.md 怎么写

> 掌握 CLAUDE.md 的作用域、内容边界和可维护写法

# `CLAUDE.md` 怎么写

`CLAUDE.md` 适合放稳定、可验证、与协作直接相关的规则，不适合变成百科全书或秘密存储。

适合写：安装、测试和构建命令；目录职责；必须同步更新的文件；代码风格、兼容性和提交约定；常见陷阱及验证要求。不适合写：Key、密码、Cookie、客户数据、一次性路径、无法验证的绝对断言，以及替代权限和审批的“禁止执行”文字。

项目根目录说明通常影响整个项目，更深层目录可以补充局部规则，用户级说明适合个人跨项目习惯。发现范围和优先级可能变化，修改后应通过小任务验证。

```markdown theme={null}
- 修改 API 响应结构时，先运行 `npm test -- api`，因为客户端契约测试依赖该结构。
- 不要直接编辑 `generated/`，请运行 `npm run generate`，避免构建覆盖手工修改。
```

把规则分成必须、建议和背景说明，并定期删除已失效内容。