CLAUDE.md 初始化示例

这份文件用于给 Claude Code 提供项目记忆。它应该放在仓库根目录，文件名保持为 CLAUDE.md。与 AGENTS.md 相比，CLAUDE.md 更偏向 Claude Code 的交互习惯、项目记忆、常用命令和团队偏好。

推荐放置位置

project-root/
  CLAUDE.md
  AGENTS.md
  README.md
  docs/
    project/
      requirements.md
      acceptance.md
      architecture.md
      test-strategy.md

可直接使用的模板

# CLAUDE.md

## 项目上下文

本项目是培训工作坊使用的 AI 项目交付看板。

目标是演示团队如何在清晰需求、验收标准、测试策略和审查纪律下使用 AI 编程工具。

## 产品目标

构建一个小而真实的看板，让团队可以：

- 创建交付任务。
- 分配负责人、优先级、状态和截止日期。
- 跟踪阻塞工作。
- 记录 AI 协助备注。
- 从看板视图查看交付健康度。

## 开发偏好

- 大改动前先询问或生成简短计划。
- 保持改动小而可审查。
- 优先选择可读代码，不追求炫技抽象。
- 没有明确理由时避免添加依赖。
- 沿用项目已有风格和命名。
- 不确定时先检查代码库，不要猜测。

## 常用命令

- 安装依赖：`npm install`
- 启动开发服务：`npm run dev`
- 构建生产资源：`npm run build`
- 运行测试：`npm run test`
- 运行 lint：`npm run lint`

如果某个命令因为脚本不存在而失败，检查 `package.json` 并报告可用替代命令。

## Claude Code 工作流

1. 阅读 `README.md`、`CLAUDE.md`、`AGENTS.md` 和 `docs/project/*.md`。
2. 总结需求和验收标准。
3. 创建简短实现计划。
4. 实现最小可用切片。
5. 运行构建或测试。
6. 总结修改文件、验证证据和剩余风险。

## 项目规则

- v1 不使用数据库。
- 培训演示使用 localStorage 做持久化。
- UI 同时适合开发和项目经理使用。
- 不创建营销首页；首屏直接进入工作看板。
- 不隐藏异常状态；必要时显示加载、空状态和错误状态。
- 不提交密钥或生成产物。

## 审查清单

- 实现是否符合 `docs/project/acceptance.md`？
- 任务状态流转是否容易理解？
- PM 不看代码是否能理解看板？
- 开发是否能按文档命令运行应用？
- 构建或测试是否通过？

## 常用提示词

### 计划

请先阅读项目文档并生成实现计划。暂时不要编辑文件。

### 实现

只实现第一个可用切片。保持 diff 聚焦，并运行相关验证命令。

### 审查

请审查当前改动中的 bug、遗漏的验收标准、安全问题和缺失测试。先列问题，再给摘要。

课堂讲解重点

CLAUDE.md 应该帮助 Claude Code 更快进入项目上下文，而不是替代需求文档。稳定规则写在这里；具体功能需求仍然放到 docs/project/requirements.md、docs/project/acceptance.md 和相关设计文档中。

Claude Code 操作提示

请阅读 CLAUDE.md、README.md 和 docs/project/*.md。
先不要修改文件，请输出你理解的项目目标、约束、可执行计划和验证命令。

确认后：

按计划实现第一个可演示版本。每一步保持小改动，并在最后运行构建或测试。

来源

• Claude Code overview
• Claude Code memory
• Claude Code settings
• Anthropic Claude Code GitHub