freedakgmail
88 lines
2.9 KiB
Markdown
88 lines
2.9 KiB
Markdown
# Cursor 规则文档索引
|
|
|
|
本目录包含 Cursor AI 辅助开发的核心协作规范和工作流文档。
|
|
|
|
## 文档概览
|
|
|
|
### 核心工作流
|
|
|
|
1. **[ai-coding-workflow.md](./ai-coding-workflow.md)** - Cursor 全局 AI Coding 协作规则
|
|
- 五阶段工作流：0-req → 1-prd → 2-task → 开发执行
|
|
- 统一编号体系和执行前读取顺序
|
|
- Definition of Done 标准
|
|
|
|
2. **[quick-reference.md](./quick-reference.md)** - AI Coding 工作流快速参考
|
|
- 新项目强制检查点
|
|
- 阶段与产出对照表
|
|
- Definition of Ready & Done
|
|
- 禁止行为清单和紧急降级策略
|
|
|
|
3. **[new-project-checkpoint.md](./new-project-checkpoint.md)** - 新项目初始化检查点
|
|
- 新项目识别条件
|
|
- 强制启动流程
|
|
- 检查点通过条件
|
|
|
|
### 专项规范
|
|
|
|
4. **[AGENTS.md](./AGENTS.md)** - AI 辅助开发协作规范（项目级）
|
|
- 文档阅读顺序
|
|
- 代码修改原则
|
|
- 任务管理和测试纪律
|
|
- 提交规范和已知问题
|
|
|
|
5. **[change-management.md](./change-management.md)** - 需求变更管理
|
|
- 7 维度影响评估表
|
|
- 六步变更流程
|
|
- 变更文档模板
|
|
|
|
6. **[architecture-and-design.md](./architecture-and-design.md)** - 架构与设计原则
|
|
- ADR 架构决策记录
|
|
- API/DB 变更约束
|
|
- 实体唯一代码规范
|
|
- 代码质量、测试、安全
|
|
|
|
7. **[ui-components-standard.md](./ui-components-standard.md)** - UI/UX 与公共组件规范
|
|
- UI/UX 设计原则
|
|
- 公共组件抽取原则
|
|
- UI 公共组件登记表
|
|
- 组件参数膨胀应对策略
|
|
|
|
## 使用指南
|
|
|
|
### 新项目启动
|
|
|
|
1. 阅读 `new-project-checkpoint.md` 了解新项目初始化流程
|
|
2. 阅读 `ai-coding-workflow.md` 了解五阶段工作流
|
|
3. 按照 `quick-reference.md` 中的阶段对照表推进
|
|
|
|
### 日常开发
|
|
|
|
1. 执行任务前，按 `ai-coding-workflow.md` §3.1.2 的顺序读取上下文
|
|
2. 遵循 `AGENTS.md` 的代码修改原则
|
|
3. 需求变更时，参考 `change-management.md` 的六步流程
|
|
4. 重大技术决策时，参考 `architecture-and-design.md` 创建 ADR
|
|
|
|
### 快速查询
|
|
|
|
遇到以下情况，快速查阅对应文档：
|
|
|
|
- **不确定当前阶段** → `quick-reference.md` 阶段对照表
|
|
- **需要变更需求** → `change-management.md` 7 维评估
|
|
- **API/DB 变更** → `architecture-and-design.md` 变更检查清单
|
|
- **UI 组件重复** → `ui-components-standard.md` 抽取原则
|
|
- **项目特定规则** → `AGENTS.md` 项目协作规范
|
|
|
|
## 文档维护
|
|
|
|
- 这些规则文档来源于 Cursor 全局规则
|
|
- 项目级调整应在项目根目录的 `AGENTS.md` 中说明
|
|
- 规则冲突时，优先级：用户明确指令 > 项目规则 > 全局规则
|
|
|
|
## 相关文档
|
|
|
|
项目其他重要文档：
|
|
|
|
- `../pmdocs/` - 项目需求、PRD、任务文档
|
|
- `../run.md` - 项目运行手册
|
|
- `../.windsurfrules` - 项目精简规则（如果存在）
|
|
- `../AGENTS.md` - 项目级 AI 协作规范（如果存在） |