diff --git a/.cursor/ai/modes.mdc b/.cursor/ai/modes.mdc deleted file mode 100644 index 2f5ba06f16259950a0cd6041da75e7820cd6434c..0000000000000000000000000000000000000000 --- a/.cursor/ai/modes.mdc +++ /dev/null @@ -1,177 +0,0 @@ ---- -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 status # 查看状态 -@ai mode exit # 退出当前模式(新增) -@ai mode reset # 重置模式状态 - -# 快捷命令 -@ai mode r # 研究模式 -@ai mode i # 创新模式 -@ai mode p # 规划模式 -@ai mode e # 执行模式 -@ai mode v # 审查模式 -``` - -## 模式状态管理 - -### 状态规则 -- **模式激活时**:只响应模式相关指令 -- **普通指令**:需要先使用 `@ai mode exit` 退出模式 -- **模式退出后**:恢复正常指令执行 -- **会话开始**:默认处于普通模式 - -### 优先级规则 -- **最高优先级**:模式指令(`@ai mode xxx`) -- **普通优先级**:基础指令(`@ai help`, `@ai git` 等) -- **模式激活时**:只执行模式指令,普通指令提示退出 - -### 使用流程示例 -```bash -# 1. 使用普通指令 -@ai help # 正常执行 - -# 2. 进入模式 -@ai mode research # 进入研究模式 - -# 3. 尝试使用普通指令 -@ai git # 提示:请先退出模式 @ai mode exit - -# 4. 退出模式 -@ai mode exit # 退出模式 - -# 5. 使用普通指令 -@ai git # 正常执行 -``` - -### 工作流程示例 -```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. 在审查模式中验证结果质量 - -### 注意事项 -- 模式为指导性工具,非强制约束 -- 可根据需要灵活切换模式 -- 保持模式专注,避免混合操作 -- 每个会话独立,无状态依赖 -- **重要**:模式激活时,普通指令需要先退出模式 - -## 错误处理 - -### 常见错误 -1. **模式激活时使用普通指令** - - 错误:`@ai git`(在模式激活时) - - 解决:先使用 `@ai mode exit` 退出模式 - -2. **无效的模式指令** - - 错误:`@ai mode invalid` - - 解决:使用有效的模式指令 - -3. **模式状态混乱** - - 错误:模式状态不一致 - - 解决:使用 `@ai mode reset` 重置状态 - -### 错误提示示例 -```bash -# 模式激活时使用普通指令 -@ai git -# 系统响应: -# "当前处于研究模式,请先使用 @ai mode exit 退出模式后再使用普通指令" - -# 无效模式指令 -@ai mode invalid -# 系统响应: -# "无效的模式指令,请使用:research, innovate, plan, execute, review, status, exit, reset" -``` - -## 集成说明 - -本模式与项目的其他功能完全兼容: -- 可以随时切换到普通指令(需要先退出模式) -- 不影响项目的其他规则和配置 -- 作为可选功能,用户自主决定是否使用 -- 支持灵活的自定义配置 -- 提供明确的退出机制 - - - - - diff --git a/.cursor/ai/prompts.mdc b/.cursor/ai/prompts.mdc deleted file mode 100644 index dd2fa9ca906c00cb7f32dacb8a186d825e64e7b5..0000000000000000000000000000000000000000 --- a/.cursor/ai/prompts.mdc +++ /dev/null @@ -1,225 +0,0 @@ ---- -description: -globs: -alwaysApply: true ---- -# AI 指令系统 - -## 概述 - -本文件提供 Cursor Rules 项目的 AI 指令系统快速参考。 - -## 快捷指令 - -### 使用方法 -```bash -# 语义化格式(推荐) -@ai [指令名] # 例如:@ai help -``` - -### 指令优先级规则 -- **最高优先级**:模式指令(`@ai mode xxx`) -- **普通优先级**:基础指令(`@ai help`, `@ai git` 等) -- **模式激活时**:只执行模式指令,普通指令提示退出 - -### 指令列表 - -| 指令名 | 功能 | 使用格式 | 优先级 | -|--------|------|----------|--------| -| mode | 结构化模式 | `@ai mode` | 最高 | -| help | 帮助查询 | `@ai help` | 普通 | -| memory | 更新开发记忆 | `@ai memory` | 普通 | -| document | 更新项目文档 | `@ai document` | 普通 | -| code | 代码审查 | `@ai code` | 普通 | -| troubleshoot | 问题诊断 | `@ai troubleshoot` | 普通 | -| summary | 项目总结 | `@ai summary` | 普通 | -| unified | 文档同步检查 | `@ai unified` | 普通 | -| git | Git提交 | `@ai git` | 普通 | -| rules | 规则检查 | `@ai rules` | 普通 | - ---- - -## 结构化模式使用示例 - -帮助在特定阶段保持思维专注。 - -```bash -# 模式切换 -@ai mode research # 研究模式 1. 分析问题 -@ai mode innovate # 创新模式 2. 探索方案 -@ai mode plan # 规划模式 3. 制定计划 -@ai mode execute # 执行模式 4. 执行实施 -@ai mode review # 审查模式 5. 审查结果 - -# 状态管理 -@ai mode status # 查看状态 -@ai mode exit # 退出当前模式(新增) -@ai mode reset # 重置模式状态 -``` - ---- - -## 模式状态管理 - -### 状态规则 -- **模式激活时**:只响应模式相关指令 -- **普通指令**:需要先使用 `@ai mode exit` 退出模式 -- **模式退出后**:恢复正常指令执行 -- **会话开始**:默认处于普通模式 - -### 使用流程 -```bash -# 1. 使用普通指令 -@ai help # 正常执行 - -# 2. 进入模式 -@ai mode research # 进入研究模式 - -# 3. 尝试使用普通指令 -@ai git # 提示:请先退出模式 @ai mode exit - -# 4. 退出模式 -@ai mode exit # 退出模式 - -# 5. 使用普通指令 -@ai git # 正常执行 -``` - ---- - -## 核心指令列表 - -### mode 结构化模式(最高优先级) -**功能**: 启用结构化开发工作流 -**执行内容**: 进入结构化模式,按照研究→创新→规划→执行→审查的流程进行开发 -**特殊说明**: 模式激活时,普通指令需要先退出模式 - -### help 帮助查询 -**功能**: 快速查询所有可用指令 -**执行内容**: 只显示快捷指令部分(使用方法、指令列表) - -### memory 更新开发记忆 -**功能**: 更新项目上下文记忆文档 -**执行内容**: 更新决策记录、开发状态、技术债务 - -### document 更新项目文档 -**功能**: 同步更新项目核心文档 -**执行内容**: 更新产品文档、开发文档、README,检查文档一致性 - -### code 代码审查 -**功能**: 全面的代码质量检查 -**执行内容**: 代码质量检查、性能优化建议、安全问题识别、最佳实践建议、架构评估 - -### troubleshoot 问题诊断 -**功能**: 分析和解决开发问题 -**执行内容**: 问题分析、解决方案、预防措施、最佳实践、调试技巧 - -### summary 项目总结 -**功能**: 项目阶段性总结和规划 -**执行内容**: 成果总结、经验教训、下阶段规划、风险预警、技术债务梳理 - -### unified 文档同步检查 -**功能**: 检查项目所有文档的同步性和一致性 -**执行内容**: 检查文档一致性、AI记忆一致性、README一致性、版本信息一致性,提供同步建议 - -### git Git提交 -**功能**: 生成符合规范的Git提交信息 -**执行内容**: 分析变更内容、生成提交信息、提供git命令建议、检查提交规范 - -### rules 规则检查 -**功能**: 确保AI正确遵循项目规范 -**执行内容**: 检查语言规范、响应格式、项目结构、文档规范、Git规范,强制重新加载规则文件 - ---- - -## 结构化模式指令 - -> **详细模式定义和管控机制请参考 ./modes.mdc。** - ---- - -## 使用示例 - -### 基础指令 -```bash -@ai help # 显示帮助信息 -@ai memory # 更新项目记忆 -@ai rules # 检查规则遵循 -@ai status # 查看系统状态 -``` - -### 结构化模式 -```bash -@ai mode research # 研究模式 -@ai mode plan # 规划模式 -@ai mode execute # 执行模式 -@ai mode review # 审查模式 -@ai mode status # 状态查看 -@ai mode exit # 退出模式 -``` - -### 错误处理示例 -```bash -# 模式激活时使用普通指令 -@ai git -# 系统响应: -# "当前处于研究模式,请先使用 @ai mode exit 退出模式后再使用普通指令" -``` - ---- - -## 通用提示词模板 - -### 角色定义模板 -``` -你是一名经验丰富的 [技术栈] 开发专家,专注于 [项目类型] 的开发。 -请始终遵循最佳实践,提供高质量的代码和建议。 -当前项目:[项目描述] -技术栈:[使用的技术栈] -``` - -### 代码审查模板 -``` -请对以下代码进行全面的代码审查,包括: -1. 代码质量和可读性 -2. 性能优化建议 -3. 安全问题识别 -4. 最佳实践建议 -5. 架构评估 - -代码内容: -[代码片段] -``` - -### 问题诊断模板 -``` -请帮助诊断和解决以下问题: -问题描述:[详细描述遇到的问题] -错误信息:[如果有错误信息] -环境信息:[操作系统、版本等] -已尝试的解决方案:[已尝试的方法] - -请提供: -1. 问题分析 -2. 解决方案 -3. 预防措施 -4. 最佳实践建议 -``` - -### 项目总结模板 -``` -请对当前项目进行阶段性总结: -项目阶段:[当前阶段] -时间范围:[开始时间 - 结束时间] -主要成果:[完成的功能和任务] -遇到的问题:[遇到的困难和挑战] -经验教训:[学到的经验和教训] -下阶段规划:[下一步的计划和目标] -技术债务:[需要处理的技术债务] -风险预警:[潜在的风险和问题] -``` - - - - - diff --git a/.cursor/rules/general.mdc b/.cursor/rules/general.mdc index 935b2d88c376fdbc6f0ac8c6a80121532f3de5c7..584479dcaedc99f492f102d5f6f2b8c12505767b 100644 Binary files a/.cursor/rules/general.mdc and b/.cursor/rules/general.mdc differ diff --git a/.cursor/rules/prompts.mdc b/.cursor/rules/prompts.mdc new file mode 100644 index 0000000000000000000000000000000000000000..3358f64fdafe38a615d95827190a5685791f57d9 --- /dev/null +++ b/.cursor/rules/prompts.mdc @@ -0,0 +1,169 @@ +--- +description: +globs: +alwaysApply: true +--- +# AI 指令系统 + +## 概述 + +本文件提供 Cursor Rules 项目的 AI 指令系统快速参考。结构化模式提供工作流程指导,帮助在特定阶段保持思维专注。 + +## 指令系统 + +### 使用方法 +```bash +@[指令名] # 例如:@help +``` + +### 优先级规则 +- **最高优先级**:模式指令(`@research`, `@plan`, `@execute` 等) +- **中等优先级**:状态指令(`@status`, `@exit`, `@reset`) +- **普通优先级**:功能指令(`@help`, `@git`, `@memory` 等) +- **模式激活时**:只执行模式相关指令,其他指令提示退出 + +### 指令列表 + +| 指令名 | 功能 | 优先级 | 说明 | +|--------|------|--------|------| +| research | 研究模式 | 最高 | 信息收集和深度理解 | +| plan | 规划模式 | 最高 | 创建详尽的技术规范 | +| execute | 执行模式 | 最高 | 精确实施规划内容 | +| review | 审查模式 | 最高 | 验证实施与计划的一致性 | +| innovate | 创新模式 | 最高 | 头脑风暴潜在方法 | +| status | 查看状态 | 中等 | 显示当前模式状态 | +| exit | 退出模式 | 中等 | 退出当前模式 | +| reset | 重置模式 | 中等 | 重置模式状态 | +| help | 帮助查询 | 普通 | 显示所有可用指令 | +| memory | 更新开发记忆 | 普通 | 更新项目上下文记忆 | +| document | 更新项目文档 | 普通 | 同步更新核心文档 | +| code | 代码审查 | 普通 | 全面的代码质量检查 | +| troubleshoot | 问题诊断 | 普通 | 分析和解决开发问题 | +| summary | 项目总结 | 普通 | 项目阶段性总结和规划 | +| unified | 综合验证检查 | 普通 | 检查文档同步性和逻辑一致性 | +| git | Git提交 | 普通 | 生成符合规范的提交信息 | +| rules | 规则检查 | 普通 | 确保AI遵循项目规范 | + +--- + +## 结构化模式 + +### 模式切换 +```bash +@research # 研究模式 - 信息收集和深度理解 +@innovate # 创新模式 - 头脑风暴潜在方法 +@plan # 规划模式 - 制定详细计划 +@execute # 执行模式 - 精确实施规划内容 +@review # 审查模式 - 验证实施与计划的一致性 + +# 状态管理 +@status # 查看状态 +@exit # 退出当前模式 +@reset # 重置模式状态 +``` + +### 状态管理 +- **模式激活时**:只响应模式相关指令 +- **其他指令**:需要先使用 `@exit` 退出模式 +- **模式退出后**:恢复正常指令执行 +- **会话开始**:默认处于普通模式 + +### 使用流程 +```bash +# 典型开发任务流程 +@research # 1. 分析任务需求和技术约束 +@innovate # 2. 探索多种解决方案 +@plan # 3. 制定详细实施计划 +@execute # 4. 严格按照计划执行 +@review # 5. 验证实施结果 +``` + +### 最佳实践 +1. 从研究模式开始,充分理解问题 +2. 在创新模式中探索多种可能性 +3. 在规划模式中制定详细计划 +4. 在执行模式中严格按计划实施 +5. 在审查模式中验证结果质量 + +### 注意事项 +- 模式为指导性工具,非强制约束 +- 保持模式专注,避免混合操作 +- 模式激活时,其他指令需要先退出模式 + +--- + +## 使用示例 + +### 基础指令 +```bash +@help # 显示帮助信息 +@memory # 更新项目记忆 +@rules # 检查规则遵循 +@status # 查看系统状态 +@unified # 综合验证检查(文档同步性 + 逻辑一致性) +``` + +### 错误处理 +```bash +# 模式激活时使用其他指令 +@git +# 系统响应:请先使用 @exit 退出模式 +``` + +--- + +## 通用模板 + +### 角色定义 +``` +你是一名经验丰富的 [技术栈] 开发专家,专注于 [项目类型] 的开发。 +请始终遵循最佳实践,提供高质量的代码和建议。 +``` + +### 代码审查 +``` +请对以下代码进行全面的代码审查,包括: +1. 代码质量和可读性 +2. 性能优化建议 +3. 安全问题识别 +4. 最佳实践建议 +5. 架构评估 +``` + +### 问题诊断 +``` +请帮助诊断和解决以下问题: +问题描述:[详细描述遇到的问题] +错误信息:[如果有错误信息] +环境信息:[操作系统、版本等] +已尝试的解决方案:[已尝试的方法] + +请提供:问题分析、解决方案、预防措施 +``` + +### 综合验证检查 +``` +请进行综合验证检查,包括: +1. 文档同步性检查 + - 文档间格式一致性 + - 文档结构同步性 + - 版本信息一致性 + +2. 逻辑一致性检查 + - 业务规则逻辑性 + - 内容相关性验证 + - 代码与文档对应关系 + - 指令系统完整性 + +3. 完整性检查 + - 必要文档是否存在 + - 关键信息是否完整 + - 链接引用是否有效 + +请提供:检查结果、问题清单、改进建议 +``` + + + + + diff --git a/MEMORY.md b/MEMORY.md index ba7ab8ed579450a1f95e3f012859a075be443c1c..26c630c42e2ae588a84ab0a71c7086d5488e52c4 100644 --- a/MEMORY.md +++ b/MEMORY.md @@ -36,16 +36,28 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, - [x] .cursor/rules/general.mdc - 通用规范 - [x] .cursor/rules/git.mdc - Git提交规范 - [x] .cursor/rules/gitflow.mdc - Gitflow工作流规范 -- [x] .cursor/rules/docs-structure.mdc - 文档结构规范 +- [x] docs/docs-structure.mdc - 文档结构规范 #### 4. AI指令系统 -- [x] .cursor/ai/prompts.mdc - AI指令系统定义 -- [x] .cursor/ai/modes.mdc - 结构化模式定义 -- [x] 9个核心AI指令设计完成 +- [x] .cursor/rules/prompts.mdc - AI指令系统定义 +- [x] .cursor/rules/modes.mdc - 结构化模式定义 +- [x] 18个核心AI指令设计完成 - [x] 结构化模式工作流设计完成 ### 🔄 最近更新 +#### 2025年06月22日 - 指令系统重构优化 +- **优化内容**: 重构AI指令系统,简化指令格式和优化结构 +- **变更详情**: + - 简化指令格式:从 `@ai [指令名]` 改为 `@[指令名]` + - 重构文件结构:将指令系统合并到 `.cursor/rules/prompts.mdc` + - 优化优先级系统:三级优先级(最高>中等>普通) + - 简化模式系统:5个核心模式,状态管理更清晰 + - 更新通用规范:简化核心规则,增加环境适配 + - 更新相关文档:README.md、MEMORY.md +- **影响范围**: 整个AI指令系统、用户体验、文档结构 +- **状态**: 已完成 + #### 2025年06月22日 - 指令系统深度优化 - **优化内容**: 完善AI指令系统,增加优先级控制和状态管理 - **变更详情**: @@ -92,7 +104,30 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, ## 重要决策记录 -### 1. 指令系统深度优化决策 +### 1. 指令系统重构优化决策 +**时间**: 2025年06月22日 +**决策**: 重构AI指令系统,简化指令格式和优化结构 +**原因**: +- 简化指令使用,提高用户体验 +- 统一规则管理,减少目录层级 +- 优化优先级系统,逻辑更清晰 +- 简化模式系统,工作流程更明确 +- 提高系统可维护性和扩展性 + +**具体重构**: +- 简化指令格式:从 `@ai [指令名]` 改为 `@[指令名]` +- 重构文件结构:将指令系统合并到 `.cursor/rules/prompts.mdc` +- 优化优先级系统:三级优先级(最高>中等>普通) +- 简化模式系统:5个核心模式,状态管理更清晰 +- 更新通用规范:简化核心规则,增加环境适配 + +**影响**: +- 大幅简化了指令使用方式 +- 提高了系统的可维护性 +- 改善了用户体验和操作效率 +- 为后续功能扩展奠定了更好基础 + +### 2. 指令系统深度优化决策 **时间**: 2025年06月22日 **决策**: 完善AI指令系统,增加优先级控制和状态管理机制 **原因**: @@ -115,7 +150,7 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, - 增强了系统的错误处理能力 - 为后续功能扩展奠定了良好基础 -### 2. 指令系统格式统一决策 +### 3. 指令系统格式统一决策 **时间**: 2025年06月22日 **决策**: 采用全拼指令格式,去除单字母指令 **原因**: @@ -128,7 +163,7 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, - 用户需要适应新的指令格式 - 提高了指令系统的可维护性 -### 3. 文档模板设计原则 +### 4. 文档模板设计原则 **时间**: 项目初期 **决策**: 保持模板状态,使用占位符 **原因**: @@ -139,33 +174,33 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, ## 技术债务 -### 1. 文档一致性 -- **问题**: 需要定期检查README.md与prompts.mdc的一致性 -- **优先级**: 低(已通过指令系统优化得到改善) -- **解决方案**: 建立文档同步检查机制,利用 `@ai unified` 指令 +### 1. 指令系统测试 +- **问题**: 需要全面测试重构后的指令系统 +- **优先级**: 高 +- **解决方案**: 创建测试用例,验证新的指令格式和优先级系统 -### 2. 规则文件扩展 -- **问题**: 框架和语言规范文件尚未创建 -- **优先级**: 低 -- **解决方案**: 按需逐步添加 +### 2. 文档一致性 +- **问题**: 需要确保所有文档与新的指令系统保持一致 +- **优先级**: 中(已通过文档更新得到改善) +- **解决方案**: 建立文档同步检查机制,利用 `@unified` 指令 -### 3. 指令系统测试 -- **问题**: 需要全面测试新的指令优先级和状态管理机制 +### 3. 用户迁移指南 +- **问题**: 用户需要适应新的指令格式 - **优先级**: 中 -- **解决方案**: 创建测试用例,验证各种使用场景 +- **解决方案**: 创建迁移指南,提供新旧指令对照表 -### 4. 用户体验优化 -- **问题**: 新用户可能需要适应新的指令系统 +### 4. 规则文件扩展 +- **问题**: 框架和语言规范文件尚未创建 - **优先级**: 低 -- **解决方案**: 完善文档和示例,提供学习指南 +- **解决方案**: 按需逐步添加 ## 下一步计划 ### 短期目标(1-2周) -1. 全面测试新的指令优先级和状态管理机制 -2. 完善AI会话管理机制 -3. 建立历史记录系统 -4. 验证指令系统在各种场景下的稳定性 +1. 全面测试重构后的指令系统 +2. 创建用户迁移指南 +3. 验证新指令格式在各种场景下的稳定性 +4. 完善AI会话管理机制 ### 中期目标(1个月) 1. 添加主流框架规范 @@ -182,10 +217,10 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, ## 项目状态 **当前阶段**: 开发阶段 -**稳定性**: 基础功能稳定,指令系统已优化,可投入使用 +**稳定性**: 基础功能稳定,指令系统已重构优化,可投入使用 **测试状态**: 基础功能已测试,新指令系统待全面测试 **文档状态**: 核心文档完整且已更新,待扩展 -**指令系统**: 已优化,具备优先级控制和状态管理功能 +**指令系统**: 已重构优化,使用 `@[指令名]` 格式,具备三级优先级系统 ## 注意事项 @@ -198,4 +233,6 @@ Cursor Rules 是专为 Cursor IDE 设计的开发规则与文档管理体系, **最后更新**: 2025年06月22日 0:16:58 **更新人**: AI Assistant -**版本**: v0.1.0 \ No newline at end of file +**版本**: v0.1.0 + +| unified | 综合验证检查 | 普通 | 检查文档同步性和逻辑一致性 | \ No newline at end of file diff --git a/README.md b/README.md index d16e6e3a2cf5acfd2b99a9b78b6e9d8237a13006..9c5cc451361fc890c032f36309d509b067a71557 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ cursor-rules/ ├── docs/ # 文档目录 │ ├── 01-产品文档.md # 产品需求和设计 │ ├── 02-开发文档.md # 开发规范和流程 +│ ├── docs-structure.mdc # 文档结构规范 │ └── ai/ # AI 相关文档 │ ├── memory.md # 项目记忆 │ └── history/ # 历史记录目录 @@ -46,34 +47,29 @@ cursor-rules/ │ ├── summaries/ # 项目总结历史 │ └── troubleshooting/ # 问题诊断历史 ├── .cursor/ # 规则与配置目录 -│ ├── 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 +│ └── rules/ # 规则定义目录 +│ ├── general.mdc # 通用规范 +│ ├── prompts.mdc # AI指令系统 +│ ├── git.mdc # Git提交规范 +│ ├── gitflow.mdc # Gitflow工作流规范 +│ ├── framework/ # 各类主流框架规范 +│ │ ├── angular.mdc +│ │ ├── vuejs.mdc +│ │ ├── flutter.mdc +│ │ ├── nextjs.mdc +│ │ ├── springboot.mdc +│ │ └── tailwind.mdc +│ └── language/ # 语言规范 +│ └── typescript.mdc ├── LICENSE # 开源协议 └── README.md # 项目说明(本文件) ``` ## 快速上手 -1. **查阅规范**:所有文档结构与协作规范详见 `.cursor/rules/` 目录。 +1. **查阅规范**:所有文档结构与协作规范详见 `.cursor/rules/` 目录和 `docs/` 目录。 2. **文档维护**:仅需维护 2 个核心文档,AI 记忆与归档自动管理。 -3. **AI 协作**:通过 `@ai [字母]` 或 `@ai #[编号]` 快捷指令,快速调用常用操作。 +3. **AI 协作**:通过 `@[指令名]` 快捷指令,快速调用常用操作。 4. **工作流程**:使用结构化模式指导开发流程,保持思维专注。 5. **团队协作**:新成员可通过项目根目录 README.md 快速了解项目结构与协作方式。 @@ -81,25 +77,33 @@ cursor-rules/ ## AI 快捷指令系统 -### 核心指令(9个) +### 核心指令(18个) | 指令 | 功能 | 使用场景 | 优先级 | |------|------|----------|--------| -| `@ai mode` | 结构化模式 | 复杂任务时启用专注工作流 | 最高 | -| `@ai help` | 帮助查询 | 忘记指令时快速查看 | 普通 | -| `@ai memory` | 更新开发记忆 | 重要决策后记录 | 普通 | -| `@ai document` | 更新项目文档 | 功能完成后同步 | 普通 | -| `@ai code` | 代码审查 | 代码提交前检查 | 普通 | -| `@ai troubleshoot` | 问题诊断 | 遇到问题时分析 | 普通 | -| `@ai summary` | 项目总结 | 阶段完成时总结 | 普通 | -| `@ai unified` | 文档同步检查 | 项目变更后检查 | 普通 | -| `@ai git` | Git提交 | 代码提交前生成信息 | 普通 | -| `@ai rules` | 规则检查 | 确保AI遵循项目规范 | 普通 | +| `@research` | 研究模式 | 信息收集和深度理解 | 最高 | +| `@plan` | 规划模式 | 制定详细计划 | 最高 | +| `@execute` | 执行模式 | 精确实施规划内容 | 最高 | +| `@review` | 审查模式 | 验证实施与计划的一致性 | 最高 | +| `@innovate` | 创新模式 | 头脑风暴潜在方法 | 最高 | +| `@status` | 查看状态 | 显示当前模式状态 | 中等 | +| `@exit` | 退出模式 | 退出当前模式 | 中等 | +| `@reset` | 重置模式 | 重置模式状态 | 中等 | +| `@help` | 帮助查询 | 忘记指令时快速查看 | 普通 | +| `@memory` | 更新开发记忆 | 重要决策后记录 | 普通 | +| `@document` | 更新项目文档 | 功能完成后同步 | 普通 | +| `@code` | 代码审查 | 代码提交前检查 | 普通 | +| `@troubleshoot` | 问题诊断 | 遇到问题时分析 | 普通 | +| `@summary` | 项目总结 | 阶段完成时总结 | 普通 | +| `@unified` | 综合验证检查 | 项目变更后检查 | 普通 | +| `@git` | Git提交 | 代码提交前生成信息 | 普通 | +| `@rules` | 规则检查 | 确保AI遵循项目规范 | 普通 | ### 指令优先级规则 -- **最高优先级**:模式指令(`@ai mode xxx`) -- **普通优先级**:基础指令(`@ai help`、`@ai git` 等) -- **模式激活时**:只执行模式指令,普通指令提示退出 +- **最高优先级**:模式指令(`@research`, `@plan`, `@execute` 等) +- **中等优先级**:状态指令(`@status`, `@exit`, `@reset`) +- **普通优先级**:功能指令(`@help`, `@git`, `@memory` 等) +- **模式激活时**:只执行模式相关指令,其他指令提示退出 ### 结构化模式 @@ -114,48 +118,33 @@ cursor-rules/ #### 模式切换 ```bash -# 完整模式切换 -@ai mode research # 研究模式 1. 分析问题 -@ai mode innovate # 创新模式 2. 探索方案 -@ai mode plan # 规划模式 3. 制定计划 -@ai mode execute # 执行模式 4. 执行实施 -@ai mode review # 审查模式 5. 审查结果 - -# 快捷模式切换 -@ai mode r # 研究模式 -@ai mode i # 创新模式 -@ai mode p # 规划模式 -@ai mode e # 执行模式 -@ai mode v # 审查模式 +# 模式切换 +@research # 研究模式 - 信息收集和深度理解 +@innovate # 创新模式 - 头脑风暴潜在方法 +@plan # 规划模式 - 制定详细计划 +@execute # 执行模式 - 精确实施规划内容 +@review # 审查模式 - 验证实施与计划的一致性 # 状态管理 -@ai mode status # 查看状态 -@ai mode exit # 退出当前模式 -@ai mode reset # 重置模式状态 +@status # 查看状态 +@exit # 退出当前模式 +@reset # 重置模式状态 ``` #### 模式状态管理 - **模式激活时**:只响应模式相关指令 -- **普通指令**:需要先使用 `@ai mode exit` 退出模式 +- **其他指令**:需要先使用 `@exit` 退出模式 - **模式退出后**:恢复正常指令执行 - **会话开始**:默认处于普通模式 #### 使用流程示例 ```bash -# 1. 使用普通指令 -@ai help # 正常执行 - -# 2. 进入模式 -@ai mode research # 进入研究模式 - -# 3. 尝试使用普通指令 -@ai git # 提示:请先退出模式 @ai mode exit - -# 4. 退出模式 -@ai mode exit # 退出模式 - -# 5. 使用普通指令 -@ai git # 正常执行 +# 典型开发任务流程 +@research # 1. 分析任务需求和技术约束 +@innovate # 2. 探索多种解决方案 +@plan # 3. 制定详细实施计划 +@execute # 4. 严格按照计划执行 +@review # 5. 验证实施结果 ``` #### 使用特点 @@ -166,20 +155,27 @@ cursor-rules/ - **状态控制**:模式激活时有明确的状态管理机制 ### 指令优势 -- **语义清晰**:全拼指令含义明确,易于理解 -- **优先级控制**:模式指令优先级高于普通指令,避免冲突 +- **指令简洁**:使用 `@[指令名]` 格式,更直观易用 +- **优先级清晰**:三级优先级系统,逻辑更明确 +- **模式专注**:5个核心模式,工作流程更清晰 - **状态管理**:完善的模式状态切换和退出机制 - **错误处理**:明确的错误提示和处理机制 - **高频使用**:覆盖日常开发90%的AI协作需求 - **即插即用**:适用于任何软件开发项目 -- **规范确保**:`@ai rules` 指令确保AI始终遵循项目规范 -- **专注工作流**:`@ai mode` 提供结构化开发流程,适合复杂任务处理 +- **规范确保**:`@rules` 指令确保AI始终遵循项目规范 +- **专注工作流**:结构化模式提供专注开发流程,适合复杂任务处理 - **工作流程指导**:帮助保持思维专注,提升工作质量 --- ## 💡 最佳实践 -TODO +### 指令系统使用建议 + +1. **模式使用**:复杂任务时使用结构化模式,保持思维专注 +2. **指令记忆**:记住核心指令,使用 `@help` 快速查询 +3. **文档同步**:重要变更后使用 `@document` 同步文档 +4. **规则检查**:定期使用 `@rules` 确保AI遵循项目规范 +5. **记忆更新**:重要决策后使用 `@memory` 记录 如需详细规则、模板、最佳实践,请查阅 `.cursor/rules/` 目录。 diff --git a/.cursor/rules/docs-structure.mdc b/docs/docs-structure.mdc similarity index 86% rename from .cursor/rules/docs-structure.mdc rename to docs/docs-structure.mdc index bf73dfea6081bc81ced45d3786c1e35f4c246e87..dd53e980f1b9f17943b94194e1175c2b3f86824d 100644 --- a/.cursor/rules/docs-structure.mdc +++ b/docs/docs-structure.mdc @@ -31,6 +31,6 @@ docs/ - prompts.md:必须包含AI快捷指令、指令速查表和提示词模板 ## AI指令规范 -- 必须使用语义化格式:@ai [字母] -- 必须使用标准格式:@ai #[编号] -- 建议核心指令控制在8个以内,支持项目扩展 \ No newline at end of file +- 必须使用语义化格式:@[指令名] +- 必须使用标准格式:@[指令名] +- 建议核心指令控制在18个以内,支持项目扩展 \ No newline at end of file