附录 C
附录 C:适用于 PM 工作流的 CLAUDE.md 示例
为你的项目复制并改编此模板。每节的详细指导见第三章。
文件位置
Claude Code 从多个位置读取 CLAUDE.md 文件,按以下顺序加载:
| 位置 | 范围 | 用例 |
|---|---|---|
| ~/.claude/CLAUDE.md | 所有项目 | 跨仓库的个人偏好 |
| ./CLAUDE.md | 本项目 | 团队共享上下文(提交到 git) |
| ./CLAUDE.local.md | 本项目 | 个人覆盖(gitignored) |
| .claude/rules/*.md | 本项目 | 将大型配置拆分为聚焦的文件 |
所有级别都被加载和合并。项目级设置覆盖用户级设置的冲突项。
CLAUDE.md 示例
# Acme Dashboard - Product Context
## About This Product
Acme Dashboard is a B2B analytics platform for e-commerce teams. Users connect
their store data, view sales metrics, and create custom reports. Primary users
are e-commerce managers and marketing analysts at mid-market retailers.
## Product Terminology
- **Workspace**: A team's shared environment. Users can belong to multiple
workspaces. Not the same as "account" (billing entity).
- **Connector**: Integration with external data source (Shopify, Google
Analytics). Each workspace can have multiple connectors.
- **Widget**: A single chart or metric on a dashboard. Widgets pull from
one or more data sources.
- **Pipeline**: Data processing job that syncs connector data. Runs hourly
by default. Not related to sales pipelines.
- **Activation**: When a user completes onboarding and creates their first
dashboard. Different from account activation (email verification).
## Key User Journeys
### New User Onboarding
1. Sign up and email verification → `src/auth/`
2. Workspace creation → `src/services/workspace-service.js`
3. First connector setup → `src/connectors/`
4. Dashboard creation → `src/components/DashboardBuilder/`
### Report Generation
- Entry point: `src/components/ReportBuilder/`
- Data queries: `src/services/query-engine/`
- Export: `src/services/export-service.js`
- Scheduling: `src/services/scheduler/`
### Billing and Subscription
- Pricing logic: `src/services/billing/pricing.js`
- Stripe integration: `src/services/billing/stripe-client.js`
- Usage metering: `src/services/billing/usage-tracker.js`
## Business Rules
- Free tier: 1 workspace, 2 connectors, 30-day data retention
- Pro tier: 5 workspaces, unlimited connectors, 1-year retention
- Enterprise: Custom limits, SSO, dedicated support
- Connector sync failures retry 3x before alerting user
- Dashboard exports limited to 10,000 rows (prevent memory issues)
- Widget refresh rate minimum 15 minutes (API rate limiting)
## Team Conventions
- All user-facing strings use i18n system in `src/locales/`
- Pricing calculations happen server-side only (never in frontend)
- Jira ticket IDs in commit messages: "Add export feature (ACME-1234)"
- Feature flags managed in `src/config/features.js`
- Database migrations require data team approval
## Code Patterns
- API endpoints follow REST conventions in `src/api/routes/`
- Business logic lives in `src/services/`, not controllers
- React components use hooks pattern, no class components
- Tests colocated with source files: `Component.test.tsx`
## Common PM Questions
- "How does pricing work?" → `src/services/billing/pricing.js`
- "Where is email content?" → `src/templates/email/`
- "How do we track usage?" → `src/services/billing/usage-tracker.js`
- "What triggers notifications?" → `src/services/notifications/`
- "Where are feature flags?" → `src/config/features.js`
## External Resources
- Product strategy: [internal wiki link]
- Design system: [Figma link]
- API docs: [internal docs link]
- Analytics: [dashboard link]
逐节指导
About This Product(2-3 句):它做什么?谁在使用它?这在任何调查之前为 Claude Code 提供定位。
Product Terminology(5-10 个术语):定义在你的领域中有特定含义或可能与其他常见术语混淆的词。防止误解。
Key User Journeys(3-5 个流程):将关键用户路径映射到代码位置。Claude Code 知道在哪里查找而无需探索。包含文件路径,而不仅仅是描述。
Business Rules(5-10 条规则):记录从代码中不明显的逻辑——限制、约束、定价层级、重试策略。帮助 Claude Code 正确解释行为。
Team Conventions(5-8 条规范):你的团队如何工作。防止建议违反实践。包含 commit 消息格式、代码组织规则、审批要求。
Code Patterns(3-5 个模式):高层架构指导。业务逻辑在哪里?代码库遵循什么模式?
Common PM Questions(5-10 个条目):常见调查的快速参考。通过直接指向相关文件来节省时间。
External Resources:Claude Code 不能跟踪的链接,但在会话中对你有用的提醒。
大小指南
- 大多数项目保持在 100 行以内
- 每节应可快速浏览,而非叙述性
- 使用列表项,而非段落
- 如果超过 150 行,拆分为 .claude/rules/ 目录
上面的示例大约 80 行,每次会话消耗大约 2,000 token——对于显著的上下文改善来说成本极低。
快速开始
在任何项目中运行 /init,基于代码库分析生成一个 starter CLAUDE.md。编辑生成的文件以添加产品上下文、术语和 PM 特定的节。
在会话期间使用 /memory 验证加载了什么。
在你的理解增长时更新你的 CLAUDE.md。当你在调查中学到有价值的东西时,添加进去。活文档胜过陈旧文档。