mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-26 00:58:13 +00:00
feat: Update documentation and claude-skills module
This commit is contained in:
+227
-26
@@ -1,40 +1,241 @@
|
||||
# 🤖 AI 技能库 (Skills Library)
|
||||
# 🎯 AI Skills 技能库
|
||||
|
||||
`skills/` 目录是本项目中 AI 技能的模块化集合。每个子目录代表一个独立的技能模块,旨在为 AI 提供特定的工具、领域知识和操作能力。这些技能使得 AI 能够执行更复杂、更专业的任务。
|
||||
`skills/` 目录存放 AI 技能(Skills),这些是比提示词更高级的能力封装,可以让 AI 在特定领域表现出专家级水平。当前包含 **14 个**专业技能。
|
||||
|
||||
## 目录结构
|
||||
|
||||
```
|
||||
skills/
|
||||
├───ccxt/ # CCXT 加密货币交易库技能
|
||||
├───claude-code-guide/ # Claude Code 使用指南技能
|
||||
├───claude-cookbooks/ # Claude Cookbooks 技能
|
||||
├───claude-skills/ # Claude 核心技能
|
||||
├───coingecko/ # CoinGecko 数据查询技能
|
||||
├───cryptofeed/ # CryptoFeed 实时数据处理技能
|
||||
├───hummingbot/ # Hummingbot 量化交易机器人技能
|
||||
├───polymarket/ # Polymarket 预测市场技能
|
||||
├───postgresql/ # PostgreSQL 数据库操作技能
|
||||
├───proxychains/ # ProxyChains 代理工具技能
|
||||
├───snapdom/ # SnapDOM 网页自动化技能
|
||||
├───telegram-dev/ # Telegram Bot 开发技能
|
||||
├───timescaledb/ # TimescaleDB 时序数据库技能
|
||||
└───twscrape/ # Twscrape 数据抓取技能
|
||||
├── README.md # 本文件
|
||||
│
|
||||
├── # === 元技能(核心) ===
|
||||
├── claude-skills/ # ⭐ 元技能:生成 Skills 的 Skills(11KB)
|
||||
│
|
||||
├── # === Claude 工具 ===
|
||||
├── claude-code-guide/ # Claude Code 使用指南(9KB)
|
||||
├── claude-cookbooks/ # Claude API 最佳实践(9KB)
|
||||
│
|
||||
├── # === 数据库 ===
|
||||
├── postgresql/ # ⭐ PostgreSQL 专家技能(76KB,最详细)
|
||||
├── timescaledb/ # 时序数据库扩展(3KB)
|
||||
│
|
||||
├── # === 加密货币/量化 ===
|
||||
├── ccxt/ # 加密货币交易所统一 API(18KB)
|
||||
├── coingecko/ # CoinGecko 行情 API(3KB)
|
||||
├── cryptofeed/ # 加密货币实时数据流(6KB)
|
||||
├── hummingbot/ # 量化交易机器人框架(4KB)
|
||||
├── polymarket/ # 预测市场 API(6KB)
|
||||
│
|
||||
├── # === 开发工具 ===
|
||||
├── telegram-dev/ # Telegram Bot 开发(18KB)
|
||||
├── twscrape/ # Twitter/X 数据抓取(11KB)
|
||||
├── snapdom/ # DOM 快照工具(8KB)
|
||||
└── proxychains/ # 代理链配置(6KB)
|
||||
```
|
||||
|
||||
## 各技能模块说明
|
||||
## Skills 一览表
|
||||
|
||||
每个技能模块通常包含以下内容:
|
||||
### 按文件大小排序(详细程度)
|
||||
|
||||
* **`SKILL.md`**: 该技能的详细描述、功能、使用场景和限制。
|
||||
* **`assets/`**: 与该技能相关的图像、图表或其他非代码资产。
|
||||
* **`references/`**: 相关文档、API 文档链接、教程或其他参考资料。
|
||||
* **`scripts/`**: 实现该技能的具体脚本或代码示例。
|
||||
| 技能 | 大小 | 领域 | 说明 |
|
||||
|------|------|------|------|
|
||||
| **postgresql** | 76KB | 数据库 | ⭐ 最详细,PostgreSQL 完整专家技能 |
|
||||
| **telegram-dev** | 18KB | Bot 开发 | Telegram Bot 开发完整指南 |
|
||||
| **ccxt** | 18KB | 交易 | 加密货币交易所统一 API |
|
||||
| **twscrape** | 11KB | 数据采集 | Twitter/X 数据抓取 |
|
||||
| **claude-skills** | 11KB | 元技能 | ⭐ 生成 Skills 的 Skills |
|
||||
| **claude-code-guide** | 9KB | 工具 | Claude Code 使用最佳实践 |
|
||||
| **claude-cookbooks** | 9KB | 工具 | Claude API 使用示例 |
|
||||
| **snapdom** | 8KB | 前端 | DOM 快照与测试 |
|
||||
| **cryptofeed** | 6KB | 数据流 | 加密货币实时数据流 |
|
||||
| **polymarket** | 6KB | 预测市场 | Polymarket API 集成 |
|
||||
| **proxychains** | 6KB | 网络 | 代理链配置与使用 |
|
||||
| **hummingbot** | 4KB | 量化 | 量化交易机器人框架 |
|
||||
| **timescaledb** | 3KB | 数据库 | PostgreSQL 时序扩展 |
|
||||
| **coingecko** | 3KB | 行情 | CoinGecko 行情 API |
|
||||
|
||||
## 如何使用技能
|
||||
### 按领域分类
|
||||
|
||||
AI Agent 在执行任务时,会根据任务需求调用相应的技能模块。开发者可以通过阅读每个技能模块内的 `SKILL.md` 文件,了解其具体功能和如何集成到 AI 的工作流程中。
|
||||
#### 🔧 元技能与工具
|
||||
|
||||
## 扩展与贡献
|
||||
| 技能 | 说明 | 推荐场景 |
|
||||
|------|------|----------|
|
||||
| `claude-skills` | 生成 Skills 的 Skills | 创建新技能时必用 |
|
||||
| `claude-code-guide` | Claude Code CLI 使用指南 | 日常开发 |
|
||||
| `claude-cookbooks` | Claude API 最佳实践 | API 集成 |
|
||||
|
||||
本项目鼓励为 AI 技能库贡献新的技能模块。如果你有新的工具或领域知识希望集成到 AI 的能力中,可以创建一个新的子目录,并按照上述结构填充 `SKILL.md`、`assets/`、`references/` 和 `scripts/`。这有助于持续增强 AI 的能力和应用范围。
|
||||
#### 🗄️ 数据库
|
||||
|
||||
| 技能 | 说明 | 推荐场景 |
|
||||
|------|------|----------|
|
||||
| `postgresql` | PostgreSQL 完整指南(76KB) | 关系型数据库开发 |
|
||||
| `timescaledb` | 时序数据库扩展 | 时间序列数据 |
|
||||
|
||||
#### 💰 加密货币/量化
|
||||
|
||||
| 技能 | 说明 | 推荐场景 |
|
||||
|------|------|----------|
|
||||
| `ccxt` | 交易所统一 API | 多交易所对接 |
|
||||
| `coingecko` | 行情数据 API | 价格查询 |
|
||||
| `cryptofeed` | 实时数据流 | WebSocket 行情 |
|
||||
| `hummingbot` | 量化交易框架 | 自动化交易 |
|
||||
| `polymarket` | 预测市场 API | 预测市场交易 |
|
||||
|
||||
#### 🛠️ 开发工具
|
||||
|
||||
| 技能 | 说明 | 推荐场景 |
|
||||
|------|------|----------|
|
||||
| `telegram-dev` | Telegram Bot 开发 | Bot 开发 |
|
||||
| `twscrape` | Twitter 数据抓取 | 社交媒体数据 |
|
||||
| `snapdom` | DOM 快照 | 前端测试 |
|
||||
| `proxychains` | 代理链配置 | 网络代理 |
|
||||
|
||||
## Skills vs Prompts 的区别
|
||||
|
||||
| 维度 | Prompts(提示词) | Skills(技能) |
|
||||
|------|------------------|----------------|
|
||||
| 粒度 | 单次任务指令 | 完整能力封装 |
|
||||
| 复用性 | 复制粘贴 | 配置后自动生效 |
|
||||
| 上下文 | 需手动提供 | 内置领域知识 |
|
||||
| 适用场景 | 临时任务 | 长期项目 |
|
||||
| 结构 | 单文件 | 目录(含 assets/scripts/references) |
|
||||
|
||||
## 技能目录结构
|
||||
|
||||
每个技能遵循统一结构:
|
||||
|
||||
```
|
||||
skill-name/
|
||||
├── SKILL.md # 技能主文件,包含领域知识和规则
|
||||
├── assets/ # 静态资源(图片、配置模板等)
|
||||
├── scripts/ # 辅助脚本
|
||||
└── references/ # 参考文档
|
||||
```
|
||||
|
||||
## 快速使用
|
||||
|
||||
### 1. 查看技能
|
||||
|
||||
```bash
|
||||
# 查看元技能
|
||||
cat skills/claude-skills/SKILL.md
|
||||
|
||||
# 查看 PostgreSQL 技能(最详细)
|
||||
cat skills/postgresql/SKILL.md
|
||||
|
||||
# 查看 Telegram Bot 开发技能
|
||||
cat skills/telegram-dev/SKILL.md
|
||||
```
|
||||
|
||||
### 2. 复制到项目中使用
|
||||
|
||||
```bash
|
||||
# 复制整个技能目录
|
||||
cp -r skills/postgresql/ ./my-project/
|
||||
|
||||
# 或只复制主文件到 CLAUDE.md
|
||||
cp skills/postgresql/SKILL.md ./CLAUDE.md
|
||||
```
|
||||
|
||||
### 3. 结合 Claude Code 使用
|
||||
|
||||
在项目根目录创建 `CLAUDE.md`,引用技能:
|
||||
|
||||
```markdown
|
||||
# 项目规则
|
||||
|
||||
请参考以下技能文件:
|
||||
@skills/postgresql/SKILL.md
|
||||
@skills/telegram-dev/SKILL.md
|
||||
```
|
||||
|
||||
## 创建自定义 Skill
|
||||
|
||||
### 方法一:使用元技能生成(推荐)
|
||||
|
||||
1. 准备领域资料(文档、代码、规范)
|
||||
2. 将资料和 `skills/claude-skills/SKILL.md` 一起提供给 AI
|
||||
3. AI 会生成针对该领域的专用 Skill
|
||||
|
||||
```bash
|
||||
# 示例:让 AI 读取元技能后生成新技能
|
||||
cat skills/claude-skills/SKILL.md
|
||||
# 然后告诉 AI:请根据这个元技能,为 [你的领域] 生成一个新的 SKILL.md
|
||||
```
|
||||
|
||||
### 方法二:手动创建
|
||||
|
||||
```bash
|
||||
# 创建技能目录
|
||||
mkdir -p skills/my-skill/{assets,scripts,references}
|
||||
|
||||
# 创建主文件
|
||||
cat > skills/my-skill/SKILL.md << 'EOF'
|
||||
# My Skill
|
||||
|
||||
## 概述
|
||||
简要说明技能用途和适用场景
|
||||
|
||||
## 领域知识
|
||||
- 核心概念
|
||||
- 最佳实践
|
||||
- 常见模式
|
||||
|
||||
## 规则与约束
|
||||
- 必须遵守的规则
|
||||
- 禁止的操作
|
||||
- 边界条件
|
||||
|
||||
## 示例
|
||||
具体的使用示例和代码片段
|
||||
|
||||
## 常见问题
|
||||
FAQ 和解决方案
|
||||
EOF
|
||||
```
|
||||
|
||||
## 核心技能详解
|
||||
|
||||
### `claude-skills/SKILL.md` - 元技能 ⭐
|
||||
|
||||
**生成 Skills 的 Skills**,是创建新技能的核心工具。
|
||||
|
||||
使用方法:
|
||||
1. 准备你的领域资料(文档、代码、规范等)
|
||||
2. 将资料和 SKILL.md 一起提供给 AI
|
||||
3. AI 会生成针对该领域的专用 Skill
|
||||
|
||||
### `postgresql/SKILL.md` - PostgreSQL 专家 ⭐
|
||||
|
||||
最详细的技能(76KB),包含:
|
||||
- 数据库设计最佳实践
|
||||
- 查询优化技巧
|
||||
- 索引策略
|
||||
- 性能调优
|
||||
- 常见问题解决方案
|
||||
- SQL 代码示例
|
||||
|
||||
### `telegram-dev/SKILL.md` - Telegram Bot 开发
|
||||
|
||||
完整的 Telegram Bot 开发指南(18KB):
|
||||
- Bot API 使用
|
||||
- 消息处理
|
||||
- 键盘与回调
|
||||
- Webhook 配置
|
||||
- 错误处理
|
||||
|
||||
### `ccxt/SKILL.md` - 加密货币交易所 API
|
||||
|
||||
统一的交易所 API 封装(18KB):
|
||||
- 支持 100+ 交易所
|
||||
- 统一的数据格式
|
||||
- 订单管理
|
||||
- 行情获取
|
||||
|
||||
## 相关资源
|
||||
|
||||
- [Skills 生成器](https://github.com/yusufkaraaslan/Skill_Seekers) - 把任何资料转为 AI Skills
|
||||
- [元技能文件](./claude-skills/SKILL.md) - 生成 Skills 的 Skills
|
||||
- [提示词库](../prompts/) - 更细粒度的提示词集合
|
||||
- [Claude Code 指南](./claude-code-guide/SKILL.md) - Claude Code 使用最佳实践
|
||||
- [文档库](../documents/) - 方法论与开发经验
|
||||
|
||||
Binary file not shown.
@@ -0,0 +1,78 @@
|
||||
---
|
||||
name: my-skill
|
||||
description: Full description of what this skill does, when to use it, and its core capabilities
|
||||
---
|
||||
|
||||
# Skill Name
|
||||
|
||||
## Overview
|
||||
|
||||
Brief explanation of the skill's purpose and value.
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
- Scenario 1: [description]
|
||||
- Scenario 2: [description]
|
||||
- Scenario 3: [description]
|
||||
|
||||
## Instructions
|
||||
|
||||
### Step 1: [Step Name]
|
||||
|
||||
[Detailed explanation]
|
||||
|
||||
### Step 2: [Step Name]
|
||||
|
||||
[Detailed explanation]
|
||||
|
||||
### Step 3: [Step Name]
|
||||
|
||||
[Detailed explanation]
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: [Scenario Name]
|
||||
|
||||
**Input:**
|
||||
|
||||
```
|
||||
[input content]
|
||||
```
|
||||
|
||||
**Output:**
|
||||
|
||||
```
|
||||
[output content]
|
||||
```
|
||||
|
||||
### Example 2: [Scenario Name]
|
||||
|
||||
**Input:**
|
||||
|
||||
```
|
||||
[input content]
|
||||
```
|
||||
|
||||
**Output:**
|
||||
|
||||
```
|
||||
[output content]
|
||||
```
|
||||
|
||||
## Constraints
|
||||
|
||||
- Limitation 1: [description]
|
||||
- Limitation 2: [description]
|
||||
- Limitation 3: [description]
|
||||
|
||||
## Error Handling
|
||||
|
||||
| Error | Cause | Solution |
|
||||
|-------|-------|----------|
|
||||
| Error 1 | [cause] | [solution] |
|
||||
| Error 2 | [cause] | [solution] |
|
||||
|
||||
## Resources
|
||||
|
||||
- [Resource 1](link)
|
||||
- [Resource 2](link)
|
||||
@@ -0,0 +1,14 @@
|
||||
---
|
||||
name: my-skill
|
||||
description: Brief description of what this skill does and when to use it
|
||||
---
|
||||
|
||||
# Skill Name
|
||||
|
||||
## Instructions
|
||||
|
||||
[Core instructions here]
|
||||
|
||||
## Examples
|
||||
|
||||
[Usage examples here]
|
||||
@@ -0,0 +1,54 @@
|
||||
#!/bin/bash
|
||||
# Quick Skill directory structure generator
|
||||
# Usage: ./create-skill.sh <skill-name>
|
||||
|
||||
SKILL_NAME=$1
|
||||
|
||||
if [ -z "$SKILL_NAME" ]; then
|
||||
echo "Usage: ./create-skill.sh <skill-name>"
|
||||
echo "Example: ./create-skill.sh my-awesome-skill"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
mkdir -p "$SKILL_NAME"/{assets,scripts,references}
|
||||
|
||||
cat > "$SKILL_NAME/SKILL.md" << 'EOF'
|
||||
---
|
||||
name: SKILL_NAME_PLACEHOLDER
|
||||
description: Skill description
|
||||
---
|
||||
|
||||
# Skill Name
|
||||
|
||||
## Overview
|
||||
|
||||
Brief explanation of the skill's purpose.
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
- Scenario 1
|
||||
- Scenario 2
|
||||
|
||||
## Instructions
|
||||
|
||||
[Detailed instructions]
|
||||
|
||||
## Examples
|
||||
|
||||
[Usage examples]
|
||||
|
||||
## Constraints
|
||||
|
||||
- Limitation 1
|
||||
- Limitation 2
|
||||
EOF
|
||||
|
||||
sed -i "s/SKILL_NAME_PLACEHOLDER/$SKILL_NAME/g" "$SKILL_NAME/SKILL.md"
|
||||
|
||||
echo "✅ Created Skill: $SKILL_NAME/"
|
||||
echo " ├── SKILL.md"
|
||||
echo " ├── assets/"
|
||||
echo " ├── scripts/"
|
||||
echo " └── references/"
|
||||
echo ""
|
||||
echo "Next: Edit $SKILL_NAME/SKILL.md to add your instructions"
|
||||
Reference in New Issue
Block a user