通过规则与架构文档让 AI 编码助手理解模板项目结构与约定

方案简介

该方案是 CoreUI Free Vue Admin Template 内置的 AI 友好开发配方：模板专门设计了与 Cursor、GitHub Copilot、Claude Code 等 AI 编码助手无缝协作的文档与配置体系。它解决的问题是：AI 助手在陌生项目中缺乏上下文，容易生成不符合项目约定的代码。该模板通过提供 .cursorrules 助手配置、ARCHITECTURE.md 技术架构文档、DEVELOPMENT.md 开发指南以及组件内的 JSDoc 注释，帮助 AI 理解项目结构、技术栈与编码模式，使 AI 辅助开发更高效、更符合项目规范。

亮点与能力

• .cursorrules：完整的 AI 助手配置，包含项目约定、技术栈与编码模式
• ARCHITECTURE.md：详细的技术架构文档，覆盖组件、路由、状态管理与构建系统
• DEVELOPMENT.md：全面的开发指南，包含安装说明、工作流与最佳实践
• JSDoc 注释：主要 Vue 组件附带文档说明，便于 AI 理解

组成与分工

• Cursor / GitHub Copilot / Claude Code：AI 编码助手，读取项目内配置与文档后生成符合约定的代码
• .cursorrules：向 AI 助手声明项目约定、技术栈与编码模式
• ARCHITECTURE.md / DEVELOPMENT.md：为 AI 与开发者提供架构与开发流程说明
• Vue：模板本体框架，AI 助手工作的目标代码库

使用与配置要点

在支持规则文件的 AI 助手（如 Cursor）中打开本项目，助手会自动读取 .cursorrules 获取项目约定；结合 ARCHITECTURE.md 了解组件、路由、状态管理与构建系统；DEVELOPMENT.md 提供安装、工作流与最佳实践参考。主要 Vue 组件的 JSDoc 注释可帮助 AI 准确理解组件用途与用法。

优缺点

• ✓ AI 助手开箱即用
• ✓ 文档与约定完备

出处

本方案挖掘自开源项目 coreui/coreui-free-vue-admin-template，方案内容与实施命令均来自其 README 原文。