xiongyuxing/ruoyi-vue-pro
1
0
Fork 0
forked from wangziqi/ruoyi-vue-pro
Code Pull Requests Activity
Files
79a57995023e2eda5d4b93e2acf7e70c08b696da
ruoyi-vue-pro/.claude/skills/usage/index.md

14 KiB
Raw Blame History

芋道源码 Skills 使用指南

快速查找适合你开发场景的提示词文档，让 AI 助手更精准地理解你的需求。

自动引用机制说明

从 2026-03-31 起，使用样例支持自动引用设计规范：

每个使用样例文档头部包含 YAML front matter 配置，声明该场景需要引用的规范文件：

---
references:
  design:                    # 设计规范（全局约束）
    - skills/design/db-designer.yaml
    - skills/design/entity-designer.yaml
  module_guide:              # 模块引用提示
    prompt: "请指定目标模块"
    mapping:
      mes: skills/modules/mes/skill-mes.yaml
  patterns:                  # 设计模式引用
    - skills/patterns/factory-pattern.yaml
---

使用方式：

  1. AI 读取使用样例时自动识别 references 配置
  2. AI 自动加载引用的设计规范文件内容
  3. 用户在提示词中指定模块名后，AI 加载对应模块 skill
  4. 生成的代码符合所有规范定义的标准

目录

  1. 使用指南概述
  2. 场景分类
  3. 使用流程
  4. FAQ

使用指南概述

本目录提供芋道源码项目的 AI 辅助开发使用场景指南。每个场景文档都包含：

  • 适用情况：什么场景下使用该提示词
  • 输入要求：需要提供哪些信息
  • 预期输出：AI 将生成什么样的代码或文档
  • 使用示例：实际案例演示

Skills 资源概览

资源类型 目录位置 说明
模块 Skills skills/modules/ 各功能模块的完整技术规范
设计模式 skills/patterns/ 常用设计模式的实现模板
文档模板 skills/templates/ Skill 文档编写模板

场景分类

一、快速上手

适用于初次接触项目或快速了解某个模块的开发者。

场景 适用情况 文档链接 一句话描述
了解项目结构 刚接触项目，需要快速了解整体架构 skills/index.yaml 查看 12 个核心模块的技术规范索引
系统模块入门 需要了解用户、角色、权限等基础功能 skill-system.yaml 系统管理模块完整开发指南
基础设施入门 需要了解文件、配置、任务等基础服务 skill-infra.yaml 基础设施模块完整开发指南
实体类实现 需要从 SQL 到实体类创建完整 CRUD 功能 entity-implementation.md 从建表到完整接口的端到端指南

推荐使用流程：

阅读 index.yaml --> 选择目标模块 --> 阅读对应 skill-*.yaml --> 开始开发

二、扩展模块

适用于在现有模块基础上添加新功能的场景。

场景 适用情况 文档链接 一句话描述
扩展系统模块 添加新的系统管理功能 skill-system.yaml 遵循系统模块规范扩展功能
扩展支付模块 添加新的支付渠道或支付方式 skill-pay.yaml 遵循支付模块规范扩展功能
扩展会员模块 添加会员等级、积分等功能 skill-member.yaml 遵循会员模块规范扩展功能
扩展商城模块 添加商品、订单相关功能 skill-mall.yaml 遵循商城模块规范扩展功能
扩展 CRM 模块 添加客户管理相关功能 skill-crm.yaml 遵循 CRM 模块规范扩展功能
扩展工作流模块 添加流程审批相关功能 skill-bpm.yaml 遵循工作流模块规范扩展功能

扩展开发要点：

  1. 阅读目标模块的 skill 文档
  2. 理解现有代码结构和命名规范
  3. 参考文档中的代码示例
  4. 遵循文档中的开发约束

三、改造模块

适用于修改现有功能或重构代码的场景。

场景 适用情况 文档链接 一句话描述
改造系统功能 修改用户、角色、菜单等核心功能 skill-system.yaml 系统模块改造技术规范
改造支付流程 修改支付、退款等核心流程 skill-pay.yaml 支付模块改造技术规范
改造订单流程 修改订单创建、支付、发货流程 skill-mall.yaml 商城模块改造技术规范
改造审批流程 修改工作流定义和审批逻辑 skill-bpm.yaml 工作流模块改造技术规范

改造开发要点：

  1. 重点关注文档中的"核心流程"部分
  2. 了解模块间的依赖关系
  3. 注意数据库字段和索引的影响
  4. 遵循向后兼容原则

四、新增模块

适用于创建全新业务模块的场景。

场景 适用情况 文档链接 一句话描述
新增业务模块 创建全新的业务功能模块 skill-template.yaml Skill 文档编写模板
应用设计模式 需要使用设计模式优化代码 patterns/ 设计模式实现模板

新增模块参考：

参考现有模块的 skill 文档结构：

  • 核心模块参考：skill-system.yaml、skill-infra.yaml
  • 业务模块参考：skill-mall.yaml、skill-crm.yaml
  • 技术模块参考：skill-bpm.yaml、skill-ai.yaml

新增模块步骤：

  1. 使用 skill-template.yaml 创建新模块文档
  2. 参考 extraction-prompt.md 提取技术规范
  3. 按照模块规范编写代码
  4. 更新 skills/index.yaml 索引

五、设计模式应用

适用于需要使用设计模式优化代码结构的场景。

模式 适用情况 文档链接 一句话描述
工厂模式 需要根据条件创建不同类型的对象 factory-pattern.yaml 对象创建的统一管理
策略模式 需要在多种算法或策略间切换 strategy-pattern.yaml 算法族的统一接口
模板方法模式 需要定义算法骨架，子类实现细节 template-method-pattern.yaml 算法骨架的固定结构

设计模式选择指南：

是否需要创建对象? --> 多种类型 --> 工厂模式
                     |
                     v
是否需要切换算法? --> 多种策略 --> 策略模式
                     |
                     v
是否需要固定流程? --> 流程相同，细节不同 --> 模板方法模式

使用流程

整体流程图

                    +-------------------+
                    |   明确开发需求    |
                    +--------+----------+
                             |
              +--------------+--------------+
              |                             |
              v                             v
      +-------+-------+            +--------+--------+
      |  新增功能?     |            |  改造现有功能?   |
      +-------+-------+            +--------+--------+
              |                             |
      +-------+-------+                     |
      |                             +-------+-------+
      v                             |               v
+-----+-----+                 +-----+-----+   +-----+-----+
| 新增模块   |                 | 扩展现有  |   | 改造模块  |
+-----+-----+                 | 模块      |   +-----+-----+
      |                       +-----+-----+         |
      v                             |               v
+-----+-----+                       v         +-----+-----+
| 使用模板  |                 +-----+-----+     | 查看对应  |
| 创建文档  |                 | 查看对应  |     | 模块文档  |
+-----+-----+                 | 模块文档  |     +-----+-----+
      |                       +-----+-----+         |
      v                             |               v
+-----+-----+                       v         +-----+-----+
| 参考现有  |                 +-----+-----+     | 关注核心  |
| 模块规范  |                 | 遵循规范  |     | 流程部分  |
+-----+-----+                 | 开发      |     +-----+-----+
      |                       +-----+-----+         |
      +-----------+-----------------+---------------+
                  |
                  v
          +-------+-------+
          |   开发完成     |
          +---------------+

快速查找流程

  1. 确定场景类型：根据上方的场景分类确定你的开发场景
  2. 查找对应文档：在场景表格中找到对应的文档链接
  3. 阅读技术规范：打开对应的 skill 文档，了解技术要求
  4. 开始开发：按照文档规范进行开发

模块优先级参考

根据 skills/index.yaml 中定义的优先级：

优先级 模块 说明
P1 (核心) system, infra, pay 系统核心功能，建议优先熟悉
P2 (业务) member, mall, crm, bpm 主要业务功能，使用频率高
P3 (扩展) erp, ai, iot, mp, report 扩展业务功能，按需使用

FAQ

Q1: 如何选择正确的 skill 文档?

A: 根据你的开发任务类型选择：

  • 快速上手：从 skill-system.yaml 或 skill-infra.yaml 开始
  • 扩展功能：选择对应业务模块的 skill 文档
  • 改造功能：重点阅读对应模块的"核心流程"部分
  • 新增模块：使用 skill-template.yaml 作为模板

Q2: skill 文档包含哪些内容?

A: 标准的 skill 文档包含以下部分：

  1. 模块概述：模块功能和技术栈说明
  2. 目录结构：模块的代码组织结构
  3. 核心概念：模块涉及的核心概念和术语
  4. 技术规范：命名规范、代码风格、注解使用等
  5. 核心流程：关键业务流程的实现方式
  6. 数据模型：数据库表结构和实体关系
  7. API 规范：接口设计和参数说明
  8. 代码示例：常见开发场景的代码参考
  9. 注意事项：开发中需要注意的问题

Q3: 如何使用设计模式文档?

A: 设计模式文档提供：

  1. 模式的概念和适用场景
  2. 项目中的实际应用案例
  3. 代码实现模板
  4. 使用注意事项

当你需要优化代码结构或解决特定设计问题时，参考对应的设计模式文档。

Q4: 如何创建新的 skill 文档?

A: 创建新模块的 skill 文档步骤：

  1. 复制 skills/templates/skill-template.yaml 作为起点
  2. 参考 skills/templates/extraction-prompt.md 了解提取方法
  3. 参考现有模块的 skill 文档作为示例
  4. 按照模板结构填写模块信息
  5. 更新 skills/index.yaml 添加新模块索引

Q5: 如何理解模块之间的依赖关系?

A: 模块依赖关系：

system (系统管理) <-- 几乎所有模块都依赖
     |
     +-- member (会员) <-- mall, crm
     |
     +-- infra (基础设施) <-- 所有模块
     |
     +-- pay (支付) <-- mall, member

开发时注意：

  • system 模块提供用户、权限等基础能力
  • infra 模块提供文件、配置、任务等基础服务
  • 业务模块之间可能存在依赖关系

Q6: 如何快速找到某个功能的实现位置?

A: 使用 skill 文档的"目录结构"和"核心流程"部分：

  1. 在 skill 文档中查找对应功能的目录位置
  2. 阅读"核心流程"了解实现逻辑
  3. 参考"代码示例"找到具体实现

Q7: 文档中的代码示例可以直接使用吗?

A: 可以，但需要注意：

  1. 代码示例遵循项目规范，可作为模板
  2. 使用前需要根据实际业务需求调整
  3. 注意替换示例中的占位符和示例数据
  4. 建议先在测试环境验证

附录

模块文档索引

模块 文档路径 行数 状态
系统管理 skill-system.yaml 839 已完成
基础设施 skill-infra.yaml 700+ 已完成
支付模块 skill-pay.yaml 654 已完成
会员模块 skill-member.yaml 608 已完成
商城模块 skill-mall.yaml 650+ 已完成
CRM 模块 skill-crm.yaml 850+ 已完成
ERP 模块 skill-erp.yaml 900+ 已完成
工作流模块 skill-bpm.yaml 650+ 已完成
AI 模块 skill-ai.yaml 670+ 已完成
物联网模块 skill-iot.yaml 721 已完成
公众号模块 skill-mp.yaml 660+ 已完成
报表模块 skill-report.yaml 320+ 已完成

使用指南文档索引

文档 适用场景 一句话描述
quick-start.md 快速上手 Skill 文档快速使用指南和常用提示词模板
entity-implementation.md 实体类开发 从 SQL 建表到完整 CRUD 接口的端到端指南
extend-module.md 扩展模块 在现有模块基础上添加新功能
new-module.md 新增模块 创建全新的业务模块
refactor-module.md 改造模块 修改现有功能或重构代码
pattern-usage.md 设计模式 常用设计模式的使用场景和实现方法

更新记录

日期 版本 说明
2026-03-25 v1.1 新增实体类实现完整流程指南
2026-03-18 v1.0 初始版本，创建使用指南索引

提示：本文档会随着项目发展持续更新。如有问题或建议，请提交 Issue 或 Pull Request。