快速为自己项目创建skill技能,让AI快速了解你的项目
陀螺匠 Skills 制作说明与使用指南
📅 最后更新: 2026-03-25
👤 适用版本: 陀螺匠 Skills v1.0.0
📑 目录导航
第一部分:创建 Skill
1.1 什么是 Skill?
Skill(技能包) 是一种可复用的 AI 助手扩展包,用于为 AI 提供特定项目或领域的专业知识、工作流程和工具支持。
🎯 Skill 的作用
- 📚 提供项目知识:让 AI 了解项目的技术栈、架构、规范
- 💻 代码模板:提供可复用的代码模板
- 🚀 开发工具:集成代码生成、规范化检查等工具
- 📖 文档导航:快速查阅相关文档
- 🔧 最佳实践:提供开发建议和最佳实践
💡 什么时候需要创建 Skill?
- 创建新的项目模块时
- 积累了一定的开发规范和模板时
- 希望团队成员快速上手项目时
- 希望 AI 能够更好地理解项目时
1.2 Skill 目录结构
一个标准的 Skill 目录结构如下:
skill_name/ # Skill 名称(小写,用下划线分隔) ├── SKILL.md # ✅ 必需:技能说明文档 ├── README.md # ✅ 必需:使用说明 ├── assets/ # 📁 代码模板目录 │ ├── ControllerTemplate.php │ ├── ModelTemplate.php │ └── ... ├── references/ # 📁 参考文档目录 │ ├── 01-项目概述.md │ ├── 02-开发规范.md │ └── ... └── scripts/ # 📁 脚本工具目录 ├── create_api.php └── check_api.php 📁 目录说明
| 目录 | 说明 | 必需 |
|---|---|---|
SKILL.md | 技能主文档,包含触发条件、功能说明 | ✅ 必需 |
README.md | 使用说明、安装方式、快速开始 | ✅ 必需 |
assets/ | 代码模板文件 | 可选 |
references/ | 参考文档(Markdown 格式) | 可选 |
scripts/ | 可执行脚本工具 | 可选 |
1.3 必需文件说明
📝 SKILL.md - 技能主文档
这是最重要的文件,用于告诉 AI 什么时候该使用这个 Skill。
位置: 必须放在 Skill 根目录
作用:
- 定义触发条件(何时使用此 Skill)
- 提供文档导航
- 说明核心功能和工具
📖 README.md - 使用说明
提供人类可读的使用说明。
位置: 必须放在 Skill 根目录
作用:
- 介绍 Skill 功能
- 安装说明
- 快速开始指南
- 技术栈说明
1.4 SKILL.md 格式规范
# 技能标题 ## 1. 技能概述 **技能名称**: skill_name **技能版本**: 1.0.0 **技能描述**: 简短的技能描述 **适用场景**: 适用的场景说明 **触发条件**: - 触发条件1 - 触发条件2 - 当用户打开或编辑某些文件时 **触发关键词**: - 关键词1 - 关键词2 - 关键词3 ## 2. 文档导航 | 文档名称 | 描述 | 路径 | |---------|------|------| | 文档1 | 描述 | [链接](path/doc.md) | ## 3. 核心功能 详细的功能说明... ## 4. 使用示例 代码示例或使用示例... 📌 关键要素
- 触发条件:明确说明什么情况下使用此 Skill
- 触发关键词:列出相关的关键词
- 文档导航:提供清晰的文档链接
- 使用示例:提供实际的使用示例
1.5 制作流程
📋 步骤 1:规划 Skill
在开始制作之前,先回答以下问题:
- ❓ 这个 Skill 的目的是什么?
- ❓ 目标用户是谁?(AI 助手 / 开发者)
- ❓ 需要包含哪些内容?(文档 / 模板 / 工具)
- ❓ 如何组织内容结构?
📋 步骤 2:创建目录结构
# 进入项目的 .trae/skills 目录cd /你的项目路径/.trae/skills # 创建 Skill 目录mkdir-p your_skill_name # 创建子目录mkdir-p your_skill_name/{assets,references,scripts}📋 步骤 3:编写 SKILL.md
参考上文格式,编写技能主文档。
示例:
# 我的项目技能 ## 1. 技能概述 **技能名称**: my_project **技能版本**: 1.0.0 **技能描述**: 我的项目开发技能包 **触发条件**: - 当用户询问项目相关问题时 - 当用户打开或编辑项目文件时 - 当用户询问开发规范时 **触发关键词**: - 我的项目 - 项目规范 - 项目结构 ## 2. 文档导航 | 文档名称 | 描述 | |---------|------| | 项目概述 | 项目简介 | | 开发规范 | 代码规范 | ## 3. 核心功能 详细的功能说明... ## 4. 使用示例 代码示例或使用示例... 📋 步骤 4:编写 README.md
编写人类可读的使用说明。
示例:
# 我的项目技能 🎯 **让 AI 助手更懂我的项目!** ## 📖 简介 这是我的项目开发技能包... ## ✨ 功能特点 - 📚 详细的项目文档 - 💻 代码模板 - 🚀 开发工具 ## 🛠️ 快速开始 ### 生成代码 ```bash php .trae/skills/my_project/scripts/create.php 📖 文档导航
### 📋 步骤 5:添加内容(可选) 根据需要添加: - **代码模板** (`assets/`):保存可复用的代码模板 - **参考文档** (`references/`):添加详细的参考文档 - **脚本工具** (`scripts/`):添加可执行的工具脚本 ### 📋 步骤 6:测试 Skill 在 Trae IDE 中测试: 1. 确保 Skill 文件已放置在 `.trae/skills/` 目录 2. 询问相关问题,检查 AI 是否正确触发 3. 检查文档链接是否正确 4. 测试代码模板和工具脚本 --- ## 1.6 制作示例 ### 示例:创建一个 "商品管理" 技能 #### 1. 创建目录 ```bash cd /你的项目路径/.trae/skills mkdir -p product_api/{assets,references,scripts} 2. 创建 SKILL.md
# 商品管理 API 技能 ## 1. 技能概述 **技能名称**: product_api **技能描述**: 商品管理模块开发技能 **触发条件**: - 当用户询问商品相关问题时 - 当用户需要创建商品 API 时 - 当用户打开商品相关文件时 **触发关键词**: - 商品 - Product - 商品管理 ## 2. 文档导航 | 文档 | 说明 | |------|------| | [商品概述](references/01-商品概述.md) | 商品模块简介 | | [商品接口](references/02-商品接口.md) | API 接口说明 | ## 3. 核心功能 - 商品 CRUD 操作 - 商品分类管理 - 商品库存管理 ## 4. 使用示例 ```bash # 生成商品 API php .trae/skills/product_api/scripts/create.php Product #### 3. 创建 README.md ```markdown # 商品管理 API 技能 🎯 **快速开发商品管理模块!** ## 📖 功能 - 商品增删改查 - 商品分类管理 - 库存管理 ## 🛠️ 使用 ```bash # 生成商品 API php .trae/skills/product_api/scripts/create.php Product #### 4. 添加参考文档 在 `references/` 目录下创建 `01-商品概述.md` 等文档。 #### 5. 添加代码模板 在 `assets/` 目录下创建 `ProductController.php` 等模板。 #### 6. 添加工具脚本 在 `scripts/` 目录下创建 `create.php` 脚本。 --- # 第二部分:Trae IDE 使用指南 ## 2.1 Trae IDE 简介 **Trae IDE** 是一个基于 AI 的智能开发环境,支持 Skills 扩展,帮助开发者更高效地工作。 ### ✨ 主要特点 - 🤖 **AI 集成**:内置 AI 助手,理解项目上下文 - 📦 **Skills 支持**:可安装项目专属的技能包 - 💡 **智能提示**:根据 Skills 提供相关的知识和建议 - 🔧 **开发工具**:集成多种开发辅助工具 --- ## 2.2 安装 Skills ### 📥 安装方式 1. **确保 Skills 目录存在** ```bash # 在项目根目录下 mkdir -p .trae/skills - 验证安装
- 打开 Trae IDE
- 检查
.trae/skills/目录下是否有 Skill 文件
复制 Skill 文件
# 将 Skill 目录复制到 .trae/skills/cp-r /你的Skill路径/my_skill .trae/skills/ 2.3 使用 Skills
🎯 触发 Skill
Skills 会根据以下条件自动触发:
1. 关键词触发
当你的问题包含相关关键词时,AI 会自动使用相应的 Skill。
示例问题:
- “陀螺匠项目的技术栈是什么?”
- “如何创建一个新的 API 接口?”
- “这个 Vue 组件如何使用?”
2. 文件操作触发
当打开或编辑特定类型的文件时,AI 会使用相关的 Skill。
示例:
- 打开
.php文件 → 触发tuoluojiang_api - 打开
.vue文件 → 触发tuoluojiang_admin - 打开
.sql文件 → 触发tuoluojiang_api
3. 手动询问
你可以直接询问 AI 相关的项目问题:
请问陀螺匠项目的代码规范是什么? 📚 查阅文档
在 .trae/skills/skill_name/references/ 目录下有详细的参考文档。
查看方式:
- 在文件管理器中打开对应目录
- 阅读相应的 Markdown 文档
- 或询问 AI 助手:“请告诉我关于 XXX 的内容”
🛠️ 使用工具脚本
Skills 包含可执行的工具脚本:
tuoluojiang_api 工具
# 生成 API 代码 php .trae/skills/tuoluojiang_api/scripts/create_api.php User user ent/user # 检查代码规范 php .trae/skills/tuoluojiang_api/scripts/check_api.php User tuoluojiang_admin 工具
# 创建 Vue 页面node .trae/skills/tuoluojiang_admin/scripts/create-page.js UserList # 创建组件node .trae/skills/tuoluojiang_admin/scripts/create-component.js UserCard # 代码检查node .trae/skills/tuoluojiang_admin/scripts/lint-check.js 2.4 常用技巧
💡 技巧 1:充分利用触发关键词
在提问时使用 Skill 中定义的关键词,可以提高 AI 的响应质量。
示例:
- ❌ “怎么建表?”
- ✅ “如何在陀螺匠项目中创建数据库表?”
💡 技巧 2:结合文件操作
打开相关的文件,然后询问问题,AI 会更好地理解上下文。
示例:
- 打开
UserController.php - 询问:“这个控制器遵循什么规范?”
💡 技巧 3:使用代码模板
在 assets/ 目录下有代码模板,可以直接参考使用。
示例:
- 查看
ControllerTemplate.php了解控制器规范 - 复制模板内容作为起点
💡 技巧 4:善用工具脚本
不要手动创建代码,使用提供的工具脚本:
# 创建 API 模块 php .trae/skills/tuoluojiang_api/scripts/create_api.php Product product ent/product 💡 技巧 5:查阅详细文档
对于复杂问题,先查阅详细的参考文档:
.trae/skills/tuoluojiang_api/references/- 后端 API 文档.trae/skills/tuoluojiang_admin/references/- 前端管理后台文档
第三部分:项目现有 Skills
3.1 tuoluojiang_api
后端 API 开发技能包
📁 目录结构
tuoluojiang_api/ ├── SKILL.md # 技能主文档 ├── README.md # 使用说明 ├── assets/ # 6个代码模板 │ ├── ControllerTemplate.php │ ├── DaoTemplate.php │ ├── ModelTemplate.php │ ├── RequestTemplate.php │ ├── ResourceControllerTemplate.php │ └── ServiceTemplate.php ├── references/ # 10个参考文档 │ ├── 01-项目概述.md │ ├── 02-开发规范.md │ ├── 03-数据库说明.md │ ├── 04-API接口说明.md │ ├── 05-目录结构.md │ ├── 06-常用命令.md │ ├── 07-路由说明.md │ ├── 08-事件系统.md │ ├── 09-定时任务.md │ └── 10-中间件说明.md └── scripts/ # 2个工具脚本 ├── create_api.php # 代码生成器 └── check_api.php # 规范检查工具 🎯 主要功能
- 📚 10 个详细的后端开发参考文档
- 💻 6 个可直接使用的代码模板
- 🚀 代码生成器(快速创建 API 模块)
- ✅ 代码规范检查工具
🛠️ 工具脚本
# 生成 API 代码 php .trae/skills/tuoluojiang_api/scripts/create_api.php ModuleName FunctionName ent/route # 检查代码规范 php .trae/skills/tuoluojiang_api/scripts/check_api.php ModuleName 3.2 tuoluojiang_admin
前端管理后台开发技能包
📁 目录结构
tuoluojiang_admin/ ├── SKILL.md # 技能主文档 ├── README.md # 使用说明 ├── assets/ # 4个代码模板 │ ├── ApiTemplate.js │ ├── ComponentTemplate.vue │ ├── PageTemplate.vue │ └── StoreTemplate.js ├── references/ # 8个参考文档 │ ├── 01-项目概述.md │ ├── 02-开发规范.md │ ├── 03-目录结构.md │ ├── 04-组件说明.md │ ├── 05-API接口说明.md │ ├── 06-常用功能.md │ ├── 07-构建部署.md │ └── 08-常见问题.md └── scripts/ # 3个工具脚本 ├── create-page.js # 页面生成器 ├── create-component.js # 组件生成器 └── lint-check.js # 代码检查工具 🎯 主要功能
- 📚 8 个详细的前端开发参考文档
- 💻 4 个可直接使用的代码模板
- 🚀 页面生成器(快速创建 Vue 页面)
- 🚀 组件生成器(快速创建 Vue 组件)
- ✅ 代码规范检查工具
🛠️ 工具脚本
# 创建 Vue 页面node .trae/skills/tuoluojiang_admin/scripts/create-page.js UserList # 创建 Vue 组件node .trae/skills/tuoluojiang_admin/scripts/create-component.js UserCard # 代码规范检查node .trae/skills/tuoluojiang_admin/scripts/lint-check.js 📞 技术支持
- 📧 邮箱:[email protected]
- 🌐 官网:https://www.tuoluojiang.com
- 📖 文档:https://doc.crmeb.com/tuoluojiang
用心做开源,我们也很需要你的鼓励!右上角 Star🌟,等你点亮!
可以进项目查看参考skill文件:https://gitee.com/ZhongBangKeJi/tuoluojiang