今天发现一个特别有意思且有用的项目:https://github.com/bmadcode/cursor-auto-rules-agile-workflow
这个项目(https://github.com/bmadcode/cursor-auto-rules-agile-workflow)是一个用于优化与 Cursor AI 代码编辑器协作的工具集,旨在通过自动生成规则和提供敏捷工作流模板来提升开发效率。它的核心作用是为开发者提供一个快速、高效的方式来设置和管理 AI 辅助编码环境,尤其是在使用 Cursor 时。以下是它的主要功能和作用:
- 1. 自动化规则生成:项目允许用户通过简单的指令告诉 AI 想要的行为,AI 会自动生成或更新相应的规则文件(.cursorrules),无需手动编写繁琐的规则。这降低了配置 AI 的门槛,让开发者能快速定制 AI 的行为。
- 2. 快速项目初始化:它提供了一个预配置的规则和敏捷工作流模板集合(例如 901-prd.mdc、902-arch.mdc、903-story.mdc),可以直接应用到新项目中。通过运行提供的脚本(apply-rules.sh),你可以在目标项目文件夹中快速生成这些规则和文档,帮助你立即按照敏捷开发的最佳实践开始工作。
- 3. 行为控制与一致性:项目通过规则文件帮助开发者控制 AI 的生成行为,确保输出的代码或文档符合特定标准。比如,你可以定义命名规范、注释风格或错误处理要求,AI 会在后续工作中保持一致性。
- 4. 敏捷工作流支持:项目内置了敏捷开发的相关文档和流程模板(见 agile-readme.md),适用于产品需求(PRD)、架构设计(Architecture)和用户故事(Story)等文件的自动应用。这对团队协作或个人开发者来说,能显著减少手动组织工作的时间。
- 5. 现有项目的改进:对于已有项目,你可以通过克隆仓库并运行脚本,将规则生成器集成到现有工作目录中,从而优化与 Cursor 的交互体验。
使用方式
- 新建项目:克隆仓库,运行 ./apply-rules.sh /path/to/your/project,即可生成一个包含规则和敏捷文档的新项目文件夹。
- 改进现有项目:将规则文件复制到现有项目根目录,定制化调整后即可使用。
适用场景
这个项目特别适合那些希望快速上手 Cursor AI、遵循敏捷开发流程、或需要自动化管理 AI 行为的开发者。它通过简化规则配置和提供结构化的工作流支持,让 AI 成为更高效的助手。
总的来说,cursor-auto-rules-agile-workflow 的作用是**加速项目启动、标准化 AI 行为、并支持敏捷开发实践**,为开发者提供一个省时省力的工具集。如果你对敏捷开发或 AI 辅助编码感兴趣,这个项目值得一试!
这个项目是干嘛的?
简单来说,它有三个主要作用:
- 1. 让 AI 听你的话:你告诉它“代码要这样写”或者“文档要那样整理”,它就自动生成规则,让 AI 按你的要求干活。
- 2. 快速开始新项目:它给你准备好一些“模板”,比如怎么写需求、怎么设计程序,让你不用从零开始。
- 3. 少干重复活:它帮你把一些常见的设置和文件弄好,省得你手动写一大堆东西。
举个生活化的例子
想象你要开一家小店卖蛋糕:
- 没有这个项目:你得自己写下“蛋糕要甜一点”“包装要用粉色盒子”“每天要做10个”之类的一堆规矩,还要自己整理店铺的计划书,很费时间。
- 用这个项目:你只要说一句“我要开蛋糕店”,它就自动给你写好规矩(比如“蛋糕甜度标准”),还准备好开店的计划书模板,你填几句就行。
在编程里,这个项目就相当于帮你设定“代码要这样写”的规矩,还给你准备好项目的“计划书”。
实际使用例子
假设你是一个新手,想用 Cursor 写一个简单的计算器程序,但你不知道怎么让 AI 帮你。
没有这个项目
你得自己告诉 AI:
- “代码要简单点,别太复杂。”
- “每个功能要写点注释说明。”
- “我要一个加法和减法的计算器。”
然后你还得手动建文件夹、写说明文件,忙半天。
用这个项目
- 1. 下载项目:你把这个项目从 GitHub 下载到电脑上(就像下载一个 App)。
- 2. 跑个命令:在电脑上打开命令行(一个黑框框),输入 ./apply-rules.sh /cursor-rules,回车。
- 3. 结果:
- 一个规则文件(.cursorrules),告诉 AI“代码要简单,还要加注释”。
- 几个模板文件,都在xnotes目录下,你可以复制任何一个文件到.cursor/rules目录下使用,如下图:
- 它自动给你建了个文件夹,里面有:
- 4. 比如901-prd-template这个文件,我翻译一下:
🎹
PRD 模板标准
<版本>1.0.0
要求
- 遵循标准化的 PRD 结构
- 包含所有必填部分
- 保持适当的文档层级
- 使用一致的格式
PRD 结构
必填部分
1. 标题
- 标题:“{项目名称}的产品需求文档(PRD)”
2. 状态
- 草稿
- 已批准
3. 引言
- 对{项目名称}的清晰描述
- 项目范围概览
- 业务背景和驱动因素
- 目标用户/利益相关者
4. 目标
- 清晰的项目目标
- 可衡量的成果
- 成功标准
- 关键绩效指标(KPIs)
5. 功能和需求
- 功能需求
- 非功能需求
- 用户体验需求
- 集成需求
- 合规性需求
6. Epic 结构
- 必须定义至少一个 Epic
- 格式:Epic-{编号}:{标题}({状态})
- 状态可以是:当前、未来、已完成
- 同一时间只能有一个 Epic 为“当前”
- 每个 Epic 代表一个主要功能或特性
- Epic 必须按顺序实施
7. 故事列表
- 故事按 Epic 组织
- 格式:Story-{编号}:{故事/任务描述}
<注>故事的细节将在后续的故事文件中起草
8. 技术栈
- 语言
- 框架
- 注:这将在架构文档中进一步详细定义
9. 未来增强
- 未来考虑的潜在 Epic
- 在 Epic 进展中收集的想法
- 优先级指南
- 影响评估
示例
<示例 类型=”有效”>
帝国防御平台 v2 的产品需求文档(PRD)
状态:草稿
引言
帝国防御平台 v2(IDP2)是一座旨在维护整个银河系和平与秩序的尖端战斗站。该项目包括开发一座具有前所未有防御能力的完全运行的空间站。该平台将同时作为军事设施和帝国力量的象征。
目标
- 与 v1 相比,实现行星防御覆盖率提高 200%
- 将应对叛乱入侵的响应时间缩短 75%
- 实现 99.99% 精度的自动化防御系统
- 建立容纳 120 万帝国人员的容量
- 通过先进反应堆技术实现能源自给自足
功能和需求
功能需求
- 具有预测性瞄准的自动化防御网格
- 量子加密通信系统
- 支持 120 万人员的高级生命支持系统
- 用于快速修复的模块化建筑系统
- 人工智能驱动的威胁检测和响应
非功能需求
- 99.999% 的系统运行时间
- 亚毫秒级武器响应时间
- 零延迟的内部通信
- 所有居住区域的辐射屏蔽
- 95% 的能源效率等级
Epic 结构
Epic-1:核心基础设施开发(已完成)
Epic-2:防御系统集成(当前)
Epic-3:生命支持和人员系统(未来)
Epic-4:指挥与控制实施(未来)
故事列表
Epic-2:防御系统集成
Story-1:实施主要武器的瞄准系统
Story-2:开发护盾发生器网络
Story-3:创建自动化防御网格控制界面
Story-4:集成威胁检测人工智能
Story-5:部署武器的备用电源分配
技术栈
- 语言:银河基本 C++23,量子脚本
- 框架:ImperialCore,DefenseGrid Pro
- 基础设施:HyperScale 云,量子网络
- 安全:帝国级加密(IGE)v4
未来增强
- 行星级牵引光束能力
- 高级隐形技术集成
- 扩展 TIE 防御者中队的机库设施
- 冗余护盾发生器系统
- 深空超空间跟踪系统
<示例 类型=”无效”>
象棋游戏
- 添加基本游戏
- 也许以后添加人工智能
- 我们可能需要的其他功能
这是一个“帝国防御平台 v2 的产品需求文档”,接下来新建一个目录就叫“帝国防御平台”,用cursor打开,然后在cursor的rules设置中新增一个rule,把刚刚文档里的内容复制进去:
然后告诉cursor:“按照文档进行开发”,cursor就能严格按照该rule文档进行开发:
好处
- 你不用自己写那些麻烦的规则,项目帮你弄好了。
- 你不用想“项目该怎么开始”,模板都准备好了。
- AI 写出来的代码简单又有注释,你一看就懂。
什么是自动生成规则?
简单说,就是你用自然语言跟 AI 说“我想要这样”,AI 就会把你的要求变成规则,写进 .cursorrules 文件。比如,你说“猜错时提示高了低了”,AI 就自动把这条规则加进去,之后它会按这个规则帮你写代码。
如何生成自己的规则?
前提准备
- 1. 项目已经就位:
- 你需要先把 cursor-auto-rules-agile-workflow 下载到电脑(从 GitHub 下载 ZIP 并解压)。
- 假设你的项目文件夹是 my_game,把解压后的工具文件夹放进去(参考上次的步骤 1 和 2)。
- 2. Cursor 安装好:
- 确保你已经安装了 Cursor AI 代码编辑器(官网下载)。
操作步骤
- 1. 打开项目文件夹:
- 在 Cursor 中打开你的项目文件夹(比如 C:\Users\你名字\my_game)。
- 确保文件夹里已经有 .cursorrules 文件(如果没有,可以手动建一个空的,内容随意,比如写一句“代码要简单”)。
- 2. 告诉 AI 你的需求:
- 在 Cursor 的聊天窗口(通常在界面右侧或底部)输入你的要求,用自然语言就好。比如:
我想要一个规则:在猜数字游戏中,如果用户猜错了,要提示“太高了”或“太低了”。
- 或者更简单:
加个规则,猜错时提示高了低了。
- 在 Cursor 的聊天窗口(通常在界面右侧或底部)输入你的要求,用自然语言就好。比如:
- 3. 让 AI 生成规则:
- 4. cursor会根据规则自动优化代码:
- 5. 检查结果:
- 运行代码试试(比如用浏览器控制台输入 Guess(7),看是不是返回“错了,太高了!”)。
- 如果没问题,说明规则生效啦!
小贴士
- 用自然语言:你不用写代码那样的规矩,直接说“我想要啥”就行,AI 会帮你翻译成规则。
- 检查文件:每次生成后,打开 .cursorrules 看看,确保 AI 写对了。
- 多试几次:如果 AI 没完全懂,可以再调整说法,比如“猜错时必须说高了或低了”。
- 项目支持:这个功能依赖 Cursor 的智能,所以要在 Cursor 里操作,而不是手动跑脚本。
总结
对现有项目,这个项目就像一个“整理大师”:
- 帮你定好规矩,让 AI 按你的习惯做事。
- 把乱糟糟的项目理顺,代码和计划都更清楚。
- 以后改代码或加功能时,AI 能保持一致,省你不少力气。
如果你有自己的小项目,想让它更好用,可以试试把这个工具加进去。只要跑个命令,就能让你的项目“升级”啦!