Skip to content

Commit 13ff51a

Browse files
committed
feat: optimiz skill, add user manual
1 parent 0e29c54 commit 13ff51a

2 files changed

Lines changed: 93 additions & 27 deletions

File tree

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# VChart Development Assistant - 用户使用说明
2+
3+
## 这个助手适合什么场景
4+
5+
- 从 0 到 1 生成图表(柱状图、折线图、饼图等)
6+
- 修改已有图表样式(颜色、标签、图例、tooltip、坐标轴)
7+
- 排查图表问题(不显示、报错、交互不生效、数据映射错误)
8+
- 从截图/Figma 还原图表
9+
- 增加交互能力(点击事件、动态更新、联动高亮、导出图片、主题切换)
10+
11+
## 如何提问效果最好
12+
13+
建议一次性提供以下信息:
14+
15+
- 使用环境:原生 JS / React-VChart(`@visactor/react-vchart`)/ 其他框架
16+
- 目标:你想实现什么图表或效果
17+
- 数据:至少给 5~10 条样例数据(或字段结构)
18+
- 当前代码:如果是改造/排错,贴出当前 spec 或关键代码
19+
- 期望与现状:预期效果 + 实际问题(报错信息/截图)
20+
21+
推荐提问模板:
22+
23+
```text
24+
请用 VChart 帮我实现一个[图表类型]。
25+
技术栈:[JS / React-VChart]
26+
数据样例:[粘贴数据]
27+
需求:[例如:显示标签、点击柱子后打印数据、支持主题切换]
28+
当前代码(可选):[粘贴 spec/组件代码]
29+
问题(可选):[例如:图表空白、tooltip 不显示]
30+
请给我可直接运行的完整 HTML(或 React 组件)并解释关键配置。
31+
```
32+
33+
## 可直接使用的示例 Prompt
34+
35+
```text
36+
用 VChart 生成一个基础柱状图,包含 xField、yField,并给出最小可运行示例。
37+
```
38+
39+
```text
40+
在我现有柱状图基础上优化颜色、标签样式和图例可读性,保持数据结构不变。
41+
```
42+
43+
```text
44+
帮我检查当前 VChart spec 的配置错误,指出问题位置并给出可直接替换的修复版本。
45+
```
46+
47+
## 你会得到什么输出
48+
49+
- 可直接运行的完整代码(默认包含完整 HTML)
50+
- 关键配置说明(为什么这么配)
51+
- 如果是排错场景:问题定位 + 修复建议 + 修复后代码
52+
- 如果有交互需求:同时给出 API 事件/状态/数据更新代码
53+
54+
## 常见问题建议
55+
56+
- 图表空白时,先检查 `xField` / `yField` 是否与数据字段名完全一致
57+
- 检查数据结构是否符合 VChart 要求(尤其是 `data``values`
58+
- 如果是 React 场景,确认依赖版本和组件导入方式正确
59+
- 问题无法复现时,优先提供最小复现代码和报错截图
60+
61+
## 参考文档
62+
63+
- VChart Skill Usage:`https://www.visactor.io/vchart/guide/tutorial_docs/VChart_Skill_Usage`
64+
- VChart Quick Start:`https://www.visactor.io/vchart/guide/tutorial_docs/Getting_Started`
65+
- VChart 配置项文档:`https://www.visactor.io/vchart/option`
66+
- VChart API 文档:`https://www.visactor.io/vchart/api/API/vchart`

skills/vchart-development-assistant/SKILL.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -134,14 +134,14 @@ python3 scripts/generate_diagnosis_react_html.py \
134134

135135
**API 能力分类**
136136

137-
| 能力类型 | 典型需求 | API 文档 |
138-
|---------|---------|---------|
139-
| 事件监听 | 点击响应、hover 效果 | `references/api/event-api.md` |
140-
| 数据操作 | 动态更新、实时刷新 | `references/api/data-api.md` |
141-
| 状态管理 | 高亮、选中 | `references/api/state-api.md` |
142-
| 交互控制 | 手动触发 tooltip | `references/api/interaction-api.md` |
143-
| 导出功能 | 下载图片 | `references/api/export-api.md` |
144-
| 主题切换 | 深色模式 | `references/api/theme-api.md` |
137+
| 能力类型 | 典型需求 | API 文档 |
138+
| -------- | -------------------- | ----------------------------------- |
139+
| 事件监听 | 点击响应、hover 效果 | `references/api/event-api.md` |
140+
| 数据操作 | 动态更新、实时刷新 | `references/api/data-api.md` |
141+
| 状态管理 | 高亮、选中 | `references/api/state-api.md` |
142+
| 交互控制 | 手动触发 tooltip | `references/api/interaction-api.md` |
143+
| 导出功能 | 下载图片 | `references/api/export-api.md` |
144+
| 主题切换 | 深色模式 | `references/api/theme-api.md` |
145145

146146
---
147147

@@ -163,13 +163,13 @@ python3 scripts/generate_diagnosis_react_html.py \
163163

164164
**在当前场景中检测到 API 需求时,不切换场景,而是增强输出**
165165

166-
| 当前场景 | 检测到 API 需求 | 增强动作 |
167-
| -------- | ------------------- | ------------------------------ |
168-
| 场景2 | "点击后获取数据" | 输出 Spec + 事件监听代码 |
169-
| 场景2 | "动态更新数据" | 输出 Spec + 数据更新函数 |
170-
| 场景3 | "联动高亮" | 输出 Spec + 状态管理代码 |
171-
| 场景3 | "导出图片" | 输出 Spec + 导出按钮和函数 |
172-
| 场景1 | API 代码报错 | 同时诊断 Spec 和 API 代码 |
166+
| 当前场景 | 检测到 API 需求 | 增强动作 |
167+
| -------- | ---------------- | -------------------------- |
168+
| 场景2 | "点击后获取数据" | 输出 Spec + 事件监听代码 |
169+
| 场景2 | "动态更新数据" | 输出 Spec + 数据更新函数 |
170+
| 场景3 | "联动高亮" | 输出 Spec + 状态管理代码 |
171+
| 场景3 | "导出图片" | 输出 Spec + 导出按钮和函数 |
172+
| 场景1 | API 代码报错 | 同时诊断 Spec 和 API 代码 |
173173

174174
#### 切换要点
175175

@@ -262,18 +262,18 @@ python3 scripts/generate_diagnosis_react_html.py \
262262

263263
**快速索引**`references/api/API_INDEX.md`
264264

265-
| 用户需求 | 查询文档 |
266-
| ---------------- | -------------------------------------- |
267-
| 更新图表数据 | `references/api/data-api.md` |
268-
| 响应点击/hover | `references/api/event-api.md` |
269-
| 高亮/选中图元 | `references/api/state-api.md` |
270-
| 手动触发tooltip | `references/api/interaction-api.md` |
271-
| 切换主题 | `references/api/theme-api.md` |
272-
| 导出图片 | `references/api/export-api.md` |
273-
| 控制动画 | `references/api/animation-api.md` |
274-
| 坐标位置转换 | `references/api/coordinate-api.md` |
275-
| 控制图例 | `references/api/legend-api.md` |
276-
| 调整尺寸 | `references/api/layout-api.md` |
265+
| 用户需求 | 查询文档 |
266+
| --------------- | ----------------------------------- |
267+
| 更新图表数据 | `references/api/data-api.md` |
268+
| 响应点击/hover | `references/api/event-api.md` |
269+
| 高亮/选中图元 | `references/api/state-api.md` |
270+
| 手动触发tooltip | `references/api/interaction-api.md` |
271+
| 切换主题 | `references/api/theme-api.md` |
272+
| 导出图片 | `references/api/export-api.md` |
273+
| 控制动画 | `references/api/animation-api.md` |
274+
| 坐标位置转换 | `references/api/coordinate-api.md` |
275+
| 控制图例 | `references/api/legend-api.md` |
276+
| 调整尺寸 | `references/api/layout-api.md` |
277277

278278
**API 查询流程**
279279

0 commit comments

Comments
 (0)