77 lines
3.5 KiB
Markdown
77 lines
3.5 KiB
Markdown
### 1. 产品愿景与 MVP 范围书 (`PRD_MVP.md`)
|
||
|
||
AI 需要知道“终点”在哪里，以及“当前阶段”的界限。
|
||
|
||
- **核心功能清单：** 明确第一阶段（MVP）必须实现的 3-5 个核心功能。
|
||
|
||
- **非目标 (Out of Scope)：** 明确哪些功能在 MVP 阶段**绝对不做**，防止 Claude 在生成代码时过度设计。
|
||
|
||
- **用户故事：** 简单的 `As a [user], I want to [action], so that [value]`，这有助于 Claude 理解业务逻辑的优先级。
|
||
|
||
|
||
### 2. 技术栈与规范定义 (`TECH_STACK.md`)
|
||
|
||
Vibe Coding 最怕 AI 随意引入不兼容的库。
|
||
|
||
- **固定技术栈：** 例如 Frontend (Next.js 14, Tailwind), Backend (Supabase/PostgreSQL), Auth (Clerk)。
|
||
|
||
- **代码风格：** 比如“使用 Functional Components”、“优先使用 TypeScript 严格模式”、“所有的 API 调用必须遵循 RESTful 规范”。
|
||
|
||
- **项目结构：** 预定义文件夹结构（如 `/components`, `/hooks`, `/lib`, `/types`），让 AI 生成的代码能够准确归位。
|
||
|
||
|
||
### 3. 领域模型与数据库 Schema (`DATA_MODEL.md`)
|
||
|
||
这是项目的“骨架”。即便你使用 NoSQL，也要先定义好数据关系。
|
||
|
||
- **实体关系图 (ERD)：** 描述 User, Project, Task 等实体的关系。
|
||
|
||
- **Schema 定义：** 提供 SQL DDL 或 Prisma Schema 示例。
|
||
|
||
- **核心业务状态机：** 如果有复杂逻辑（如订单状态、工作流状态），定义好状态转换矩阵。
|
||
|
||
|
||
### 4. UI/UX 风格与组件指南 (`UI_SYSTEM.md`)
|
||
|
||
为了让生成的页面不至于太丑或不统一：
|
||
|
||
- **设计语言：** 明确使用哪个组件库（如 shadcn/ui, Ant Design）。
|
||
|
||
- **核心页面路由：** 定义 MVP 阶段的所有 URL 路径及对应的功能页面。
|
||
|
||
- **全局布局：** 描述 Header, Sidebar, Footer 的行为。
|
||
|
||
|
||
### 5. AI 指令手册 (`.cursorrules` 或 `AI_INSTRUCTIONS.md`)
|
||
|
||
这是 Vibe Coding 的“灵魂”，专门给 Claude 看的“说明书”。
|
||
|
||
- **角色设定：** “你是一个资深的 Full-stack Engineer，擅长编写可维护的、高性能的 React 代码。”
|
||
|
||
- **禁止事项：** “禁止使用任何未在 TECH_STACK.md 中定义的第三方库。”
|
||
|
||
- **报错处理：** “如果遇到错误，优先检查类型定义，并输出详细的 Debug Log。”
|
||
|
||
## 针对 Vibe Coding 的特化建议
|
||
|
||
### 1. 采用“模块化文档”而非“长篇大论”
|
||
|
||
不要给 Claude 一个 5000 字的文档。将文档拆分为上述的 `.md` 文件。在对话时，使用 `@` 功能（在 Cursor/OpenCode 中）按需引用。例如：“基于 `@DATA_MODEL.md` 实现 `@PRD_MVP.md` 中的用户注册流程。”
|
||
|
||
### 2. 准备“上下文脚手架”
|
||
|
||
在开始第一行代码前，先让 Claude 生成一个 `README.md`，概括整个项目的架构。这会成为后续对话中最重要的上下文参考。
|
||
|
||
### 3. 动态更新的“决策记录” (`ADR.md`)
|
||
|
||
在 Vibe Coding 过程中，AI 可能会建议一些架构改动。一旦你接受了某个改动，**立即**记录在 `Architecture Decision Records (ADR)` 中。这样当你在后续对话中开启新 Session 时，可以把这个文档丢给它，避免它推翻之前的设计方案。
|
||
|
||
---
|
||
|
||
## 建议的执行流程
|
||
|
||
1. **初始化阶段：** 编写上述 5 份 Markdown 文档。
|
||
|
||
2. **环境对齐：** 将文档喂给 Claude，问它：“基于这些文档，你认为实现 MVP 的第一步是什么？请列出任务清单。”
|
||
|
||
3. **循环迭代：** 按照 `任务清单 -> 生成代码 -> 测试反馈 -> 更新文档` 的循环进行。 |