CodeGuide 使用指南
如何使用 CodeGuide 一键生成 Cursor Project Rules 文件

什么是 Cursor Project Rules

Cursor Project Rules 是 Cursor AI 编码助手的一项强大功能,它能让 AI 深入理解您的项目结构、代码规范和开发上下文。通过提供详细的项目规则文件,Cursor 可以生成更符合您期望的代码,减少误解和错误,提高 AI 编码的准确性和效率。

使用 Project Rules 的核心优势:

  • 让 AI 更准确理解您的项目需求和技术架构
  • 减少反复修改和指导 AI 的时间
  • 提高生成代码的质量和符合项目标准的一致性
  • 允许 AI 基于项目整体上下文进行建议,而不仅限于单个文件

CodeGuide 使用步骤

1

创建项目

在 CodeGuide 首页或项目页面中,点击"创建项目"按钮。输入项目标题和详细的项目想法描述,尽可能提供丰富的信息,包括项目目标、核心功能、技术需求等。

提示: 项目想法描述越详细,生成的 Project Rules 就越精准。请至少包含项目类型、主要功能、目标用户和技术偏好等信息。

2

生成文档

创建项目后,进入项目工作区,您会看到可生成的文档类型列表。至少生成以下几种文档类型以获得完整的 Project Rules:

  • 需求文档 - 详细描述项目的功能和非功能需求
  • 前端设计方案 - 提供 UI/UX 设计和前端架构建议
  • 后端架构方案 - 设计数据模型、API 和服务架构
  • 技术栈方案 - 推荐适合项目的技术和工具
  • 业务流程方案 - 梳理业务流程和界面交互逻辑
  • 开发实施计划方案 - 为AI生成代码提供详细的开发实施计划

注意: 每生成一个文档需消耗 1 点灵石,请确保账户中有足够的灵石。

3

导出和组合文档

生成的文档可以单独查看和下载。系统默认

  1. 点击每个文档右上角的"下载"按钮,获取单个Markdown文档
  2. 点击打包下载的格式为zip文件,解压后获取mdc文件
4

在 Cursor 中使用 Project Rules

完成 Project Rules 文件后,您可以在 Cursor 编辑器中导入和使用:

  1. 打开 Cursor 编辑器并创建或打开您的项目
  2. 点击左侧面板中的 "Project Rules" 图标(或在命令面板中搜索 "Project Rules")
  3. 选择 "Import from file" 或 "将解压后的mdc文件复制到.cursor/rules目录啊下
  4. 确认导入后,Cursor 将根据这些规则优化其 AI 生成和建议

提示: 在项目开发过程中,您可以持续更新和完善 Project Rules 文件,以适应项目的变化和新需求。

常见问题

Project Rules 文件应该多大?

文件大小没有严格限制,但建议控制在 5,000 到 20,000 字之间。太短可能信息不足,太长可能包含过多细节导致 AI 难以提取关键信息。

我可以使用多个 Project Rules 文件吗?

可以,您可以为不同的项目方面创建多个规则文件(如架构规则、编码风格规则等),并根据需要分别导入。但首选是一个综合的规则文件以确保一致性。

是否可以修改生成的 Project Rules?

当然可以!生成的文件只是一个起点,您应该根据实际需求和项目发展进行修改和补充。特别是随着项目的进展,不断更新规则文件将使 AI 更好地适应项目的变化。

Project Rules 能替代详细的项目文档吗?

不能完全替代。Project Rules 主要是为了指导 AI 编码助手,而传统项目文档还包括更多面向人类团队成员的内容。最佳实践是将 Project Rules 视为项目文档的一个重要补充。

最佳实践

从用户需求开始

在 Project Rules 中清晰描述产品的最终用户和他们的需求,这有助于 AI 理解代码的目标和上下文。

明确代码风格

详细指定您希望的代码风格、命名规则、文件结构和架构模式,确保生成的代码与项目统一。

提供具体例子

包含代码示例可以让 AI 更好地理解您期望的实现方式,特别是对于特定的模式或约定。

开始使用 CodeGuide 生成您的 Project Rules,让 AI 编码体验更上一层楼!