diff --git a/.cursor/ai/modes.mdc b/.cursor/ai/modes.mdc new file mode 100644 index 0000000000000000000000000000000000000000..a3ac8685be7195ea6b0ead3259e14685a4057393 --- /dev/null +++ b/.cursor/ai/modes.mdc @@ -0,0 +1,111 @@ +--- +description: +globs: +alwaysApply: true +--- +# 结构化模式 + +## 概述 + +结构化模式提供工作流程指导，帮助在特定阶段保持思维专注。模式为指导性工具，用户可自主选择是否遵循。 + +## 模式定义 + +### 研究模式 (RESEARCH) +**目的**: 信息收集和深度理解 +**核心思维**: 系统思维 +**适用场景**: 分析问题、收集信息、理解需求 +**工作方式**: 读取文件、分析代码结构、识别技术约束、提出问题 + +### 创新模式 (INNOVATE) +**目的**: 头脑风暴潜在方法 +**核心思维**: 辩证思维、创新思维 +**适用场景**: 探索解决方案、评估选项、设计架构 +**工作方式**: 讨论多种解决方案、评估优缺点、探索架构替代方案 + +### 规划模式 (PLAN) +**目的**: 创建详尽的技术规范 +**核心思维**: 系统思维、批判思维 +**适用场景**: 制定计划、设计架构、定义接口 +**工作方式**: 详细计划、精确文件路径、函数签名、完整架构概述 + +### 执行模式 (EXECUTE) +**目的**: 精确实施规划内容 +**核心思维**: 专注实施 +**适用场景**: 代码编写、功能实现、测试执行 +**工作方式**: 严格按照计划实施、标记进度、更新任务状态 + +### 审查模式 (REVIEW) +**目的**: 验证实施与计划的一致性 +**核心思维**: 批判思维、系统思维 +**适用场景**: 代码审查、质量检查、结果验证 +**工作方式**: 逐行比较、技术验证、标记偏差、检查完整性 + +## 模式切换 + +### 切换指令 +```bash +@ai mode research # 进入研究模式 +@ai mode innovate # 进入创新模式 +@ai mode plan # 进入规划模式 +@ai mode execute # 进入执行模式 +@ai mode review # 进入审查模式 + +# 快捷命令 +@ai mode r # 研究模式 +@ai mode i # 创新模式 +@ai mode p # 规划模式 +@ai mode e # 执行模式 +@ai mode v # 审查模式 +``` + +### 工作流程示例 +```bash +# 典型开发任务流程 +@ai mode research # 1. 分析任务需求和技术约束 +@ai mode innovate # 2. 探索多种解决方案 +@ai mode plan # 3. 制定详细实施计划 +@ai mode execute # 4. 严格按照计划执行 +@ai mode review # 5. 验证实施结果 + +# 问题解决流程 +@ai mode research # 1. 深入分析问题原因 +@ai mode innovate # 2. 考虑多种解决思路 +@ai mode plan # 3. 制定修复方案 +@ai mode execute # 4. 实施修复措施 +@ai mode review # 5. 验证修复效果 +``` + +## 使用指南 + +### 何时使用 +- 复杂任务需要系统性分析 +- 需要多角度思考解决方案 +- 重要决策需要严格验证 +- 团队协作需要标准化流程 + +### 最佳实践 +1. 从研究模式开始，充分理解问题 +2. 在创新模式中探索多种可能性 +3. 在规划模式中制定详细计划 +4. 在执行模式中严格按计划实施 +5. 在审查模式中验证结果质量 + +### 注意事项 +- 模式为指导性工具，非强制约束 +- 可根据需要灵活切换模式 +- 保持模式专注，避免混合操作 +- 每个会话独立，无状态依赖 + +## 集成说明 + +本模式与项目的其他功能完全兼容： +- 可以随时切换到普通指令 +- 不影响项目的其他规则和配置 +- 作为可选功能，用户自主决定是否使用 +- 支持灵活的自定义配置 + + + + + diff --git a/docs/ai/prompts.md b/.cursor/ai/prompts.mdc similarity index 50% rename from docs/ai/prompts.md rename to .cursor/ai/prompts.mdc index effc22a1bcd222a6c222f103531c517c0fc4d712..86ba4d3d62964ff5b1d88a83452ab923bb68673b 100644 --- a/docs/ai/prompts.md +++ b/.cursor/ai/prompts.mdc @@ -1,12 +1,13 @@ -# AI提示词库 +--- +description: +globs: +alwaysApply: true +--- +# AI 指令系统 -## 文档信息 -- **创建日期**: 2025-06-20 -- **最后更新**: 2025-06-21 -- **版本**: v3.4 -- **说明**: 通用Cursor规则项目模板，适用于各种软件开发项目 +## 概述 ---- +本文件提供 Cursor Rules 项目的 AI 指令系统快速参考。 ## 快捷指令 @@ -32,22 +33,42 @@ | 06 | u | 文档同步检查 | `@ai u` | `@ai #06` | | 07 | g | Git提交 | `@ai g` | `@ai #07` | | 08 | r | 规则检查 | `@ai r` | `@ai #08` | +| 09 | mode | 结构化模式 | `@ai mode` | `@ai #09` | ### 记忆技巧 - h: Help, m: Memory, d: Document, c: Code review - t: Troubleshoot, s: Summary, u: Unified check -- g: Git commit, r: Rules check +- g: Git commit, r: Rules check, mode: 结构化模式 ### 快速查询方法 忘记指令时，使用：`@ai h` 或 `@ai #00` 快速查看所有指令 --- +## 结构化模式使用示例 + +帮助在特定阶段保持思维专注，可随时使用普通指令（@ai h）退出。 + +```bash +# 模式切换 +@ai mode research # 研究模式 (r) 1. 分析问题 +@ai mode innovate # 创新模式 (i) +@ai mode plan # 规划模式 (p) 2. 制定计划 +@ai mode execute # 执行模式 (e) 3. 执行实施 +@ai mode review # 审查模式 (v) 4. 审查结果 + +# 状态管理 +@ai mode status # 查看状态 +@ai mode reset # 重置模式 +``` + +--- + ## 核心指令列表 ### #00 (h) 帮助查询 **功能**: 快速查询所有可用指令 -**执行内容**: 显示快捷指令部分（使用方法、指令对照表、记忆技巧、快速查询方法） +**执行内容**: 只显示快捷指令部分（使用方法、指令对照表、记忆技巧、快速查询方法） ### #01 (m) 更新开发记忆 **功能**: 更新项目上下文记忆文档 @@ -81,6 +102,16 @@ **功能**: 确保AI正确遵循项目规范 **执行内容**: 检查语言规范、响应格式、项目结构、文档规范、Git规范，强制重新加载规则文件 +### #09 (mode) 结构化模式 +**功能**: 启用结构化开发工作流 +**执行内容**: 进入结构化模式，按照研究→创新→规划→执行→审查的流程进行开发 + +--- + +## 结构化模式指令 + +> **详细模式定义和管控机制请参考 ./modes.mdc。* + --- ## 通用提示词模板 @@ -95,107 +126,46 @@ ### 代码审查模板 ``` -请对以下代码进行全面审查，重点关注： +请对以下代码进行全面的代码审查，包括： 1. 代码质量和可读性 -2. 性能优化机会 -3. 潜在的安全问题 -4. 是否遵循最佳实践 -5. 架构合理性 -6. 改进建议 - -代码： -[代码内容] +2. 性能优化建议 +3. 安全问题识别 +4. 最佳实践建议 +5. 架构评估 -技术栈：[使用的技术栈] -项目背景：[项目背景] +代码内容： +[代码片段] ``` ### 问题诊断模板 ``` -我遇到了以下问题，请帮助分析和解决： - -问题描述：[具体问题] -环境信息：[环境配置] -错误信息：[错误日志] -已尝试方案：[尝试过的解决方法] -技术栈：[使用的技术栈] +请帮助诊断和解决以下问题： +问题描述：[详细描述遇到的问题] +错误信息：[如果有错误信息] +环境信息：[操作系统、版本等] +已尝试的解决方案：[已尝试的方法] 请提供： -1. 问题原因分析 +1. 问题分析 2. 解决方案 3. 预防措施 -4. 相关最佳实践 +4. 最佳实践建议 ``` -### 文档更新模板 +### 项目总结模板 ``` -请帮我更新项目文档，当前情况： - -更新类型：[新增功能/修复问题/架构调整等] -变更内容：[具体变更描述] -影响范围：[影响的功能模块] -技术栈：[使用的技术栈] - -请更新： -1. 产品文档（功能说明、用户故事等） -2. 开发文档（技术实现、架构说明等） -3. 相关配置和依赖 +请对当前项目进行阶段性总结： +项目阶段：[当前阶段] +时间范围：[开始时间 - 结束时间] +主要成果：[完成的功能和任务] +遇到的问题：[遇到的困难和挑战] +经验教训：[学到的经验和教训] +下阶段规划：[下一步的计划和目标] +技术债务：[需要处理的技术债务] +风险预警：[潜在的风险和问题] ``` -### 文档同步检查模板 -``` -请检查项目所有文档的同步性和一致性： -项目背景：[项目描述] -最近变更：[最近的变更内容] -技术栈：[使用的技术栈] -请检查： -1. 产品文档与开发文档的一致性 -2. AI记忆与项目实际状态的一致性 -3. README与目录结构的一致性 -4. 版本信息与更新日期的一致性 -5. 提供具体的同步更新建议 -``` - -### Git提交模板 -``` -请根据变更内容生成Git提交信息： -变更内容：[具体变更描述] -变更类型：[feat/fix/docs/style/refactor/perf/test/chore/revert/build] -影响范围：[scope，如：web/api/docs等] -请提供： -1. 符合规范的提交信息 -2. 建议的git命令 -3. 提交前检查建议 -``` - -### 规则检查模板 -``` -请检查并确保AI正确遵循项目规范： - -检查内容： -1. 语言规范：确保使用中文回复 -2. 响应格式：确保以"收到"开头 -3. 项目结构：确保遵循目录组织规范 -4. 文档规范：确保遵循文档格式要求 -5. Git规范：确保遵循提交信息格式 - -项目规则文件： -- .cursor/rules/general.mdc：通用规范 -- .cursor/rules/git.mdc：Git提交规范 -- .cursor/rules/docs-structure.mdc：文档结构规范 - -规则优先级： -- 最高优先级：语言规范（中文回复、格式要求） -- 次优先级：文档规范（格式、结构） -- 技术优先级：Git规范、代码规范等 - -强制执行要求： -- 强制重新加载并应用这些规则 -- 确保后续回复严格遵循项目规范 -- 规则冲突时，基础规范优先 -- 每次操作前必须检查规则状态 -``` \ No newline at end of file diff --git a/.cursor/rules/general.mdc b/.cursor/rules/general.mdc index ee94378b79b30b7855150936b54955bc341a873e..fb82f9fae6ad0db5b4cccc9d1c92412be7a0f3fa 100644 Binary files a/.cursor/rules/general.mdc and b/.cursor/rules/general.mdc differ diff --git a/README.md b/README.md index cab23e56e05269e2b00f9dd0b567f7fa7b7a32f5..556b45eca196314a61f0924d64ce62fe2706f3c2 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ - **规则驱动**：所有规范集中于 `.cursor/rules/` 目录，AI 可自动遵循。 - **多技术栈支持**：内置主流前后端、移动端、样式框架及语言规范。 - **AI 快捷指令**：一行指令即可调用常用协作、文档、总结等自动化操作。 +- **工作流程指导**：提供结构化开发流程，帮助保持思维专注。 - **团队友好**：文档模板、命名、版本管理、归档机制一应俱全，便于新成员快速上手。 ## 重要说明 @@ -39,22 +40,31 @@ cursor-rules/ │ ├── 01-产品文档.md # 产品需求和设计 │ ├── 02-开发文档.md # 开发规范和流程 │ └── ai/ # AI 相关文档 -│ ├── prompts.md # AI 指令定义 -│ └── memory.md # 项目记忆 +│ ├── memory.md # 项目记忆 +│ └── history/ # 历史记录目录 +│ ├── code-reviews/ # 代码审查历史 +│ ├── summaries/ # 项目总结历史 +│ └── troubleshooting/ # 问题诊断历史 ├── .cursor/ # 规则与配置目录 -│ └── rules/ # 规则定义目录 -│ ├── general.mdc # 通用规范 -│ ├── git.mdc # Git提交规范 -│ ├── docs-structure.mdc # 文档结构规范 -│ ├── framework/ # 各类主流框架规范 -│ │ ├── angular.mdc -│ │ ├── vuejs.mdc -│ │ ├── flutter.mdc -│ │ ├── nextjs.mdc -│ │ ├── springboot.mdc -│ │ └── tailwind.mdc -│ └── language/ # 语言规范 -│ └── typescript.mdc +│ ├── rules/ # 规则定义目录 +│ │ ├── general.mdc # 通用规范 +│ │ ├── git.mdc # Git提交规范 +│ │ ├── gitflow.mdc # Gitflow工作流规范 +│ │ ├── docs-structure.mdc # 文档结构规范 +│ │ ├── framework/ # 各类主流框架规范 +│ │ │ ├── angular.mdc +│ │ │ ├── vuejs.mdc +│ │ │ ├── flutter.mdc +│ │ │ ├── nextjs.mdc +│ │ │ ├── springboot.mdc +│ │ │ └── tailwind.mdc +│ │ └── language/ # 语言规范 +│ │ └── typescript.mdc +│ └── ai/ # AI 指令系统目录 +│ ├── prompts.mdc # 指令系统和快速参考 +│ ├── modes.mdc # 结构化模式定义和工作流程 +│ └── sessions/ # 会话状态记录目录 +│ └── YYYY-MM-DD_HH-MM_[研究主题].md ├── LICENSE # 开源协议 └── README.md # 项目说明（本文件） ``` @@ -64,13 +74,14 @@ cursor-rules/ 1. **查阅规范**：所有文档结构与协作规范详见 `.cursor/rules/` 目录。 2. **文档维护**：仅需维护 2 个核心文档，AI 记忆与归档自动管理。 3. **AI 协作**：通过 `@ai [字母]` 或 `@ai #[编号]` 快捷指令，快速调用常用操作。 -4. **团队协作**：新成员可通过 docs/README.md 快速了解项目结构与协作方式。 +4. **工作流程**：使用结构化模式指导开发流程，保持思维专注。 +5. **团队协作**：新成员可通过项目根目录 README.md 快速了解项目结构与协作方式。 --- ## AI 快捷指令系统 -### 核心指令（8个） +### 核心指令（9个） | 指令 | 功能 | 使用场景 | |------|------|----------| @@ -83,13 +94,42 @@ cursor-rules/ | `@ai u` | 文档同步检查 | 项目变更后检查 | | `@ai g` | Git提交 | 代码提交前生成信息 | | `@ai r` | 规则检查 | 确保AI遵循项目规范 | +| `@ai mode` | 结构化模式 | 复杂任务时启用专注工作流 | + +### 结构化模式 + +提供工作流程指导，帮助在特定阶段保持思维专注。 + +#### 工作流程 +- **研究模式**：信息收集和深度理解 +- **创新模式**：头脑风暴潜在方法 +- **规划模式**：创建详尽的技术规范 +- **执行模式**：精确实施规划内容 +- **审查模式**：验证实施与计划的一致性 + +#### 模式切换 +```bash +@ai mode research # 研究模式 (r) 1. 分析问题 +@ai mode innovate # 创新模式 (i) +@ai mode plan # 规划模式 (p) 2. 制定计划 +@ai mode execute # 执行模式 (e) 3. 执行实施 +@ai mode review # 审查模式 (v) 4. 审查结果 +``` + +#### 使用特点 +- **指导性工具**：模式为指导性，非强制约束 +- **灵活切换**：可根据需要自由切换模式 +- **工作流程**：提供研究→创新→规划→执行→审查的指导 +- **会话独立**：每个会话独立，无状态依赖 ### 指令优势 -- **极简记忆**：只需记住8个核心指令 +- **极简记忆**：只需记住9个核心指令 - **语义清晰**：字母对应功能含义（m=Memory, d=Document等） - **高频使用**：覆盖日常开发90%的AI协作需求 - **即插即用**：适用于任何软件开发项目 - **规范确保**：`@ai r` 指令确保AI始终遵循项目规范 +- **专注工作流**：`@ai mode` 提供结构化开发流程，适合复杂任务处理 +- **工作流程指导**：帮助保持思维专注，提升工作质量 ---