@@ -4,45 +4,49 @@ order: 7
44group : 基础组件
55---
66
7- 本仓库提供 ** oceanbase-design-usage** Skill,用于在开发、Code Review、迁移时统一 OceanBase Design(OBUI)各包的使用方式 ,减少样式与代码差异。
7+ 本仓库提供 ** oceanbase-design-usage** Skill,用于在开发、Code Review、迁移时统一 ** OceanBase Design** 各包(design、ui、icons、charts、util)的使用方式 ,减少样式与代码差异。适用于本仓库及引用上述包的业务项目;迁移场景覆盖 ` @oceanbase/codemod ` 与人工核对 。
88
9- ## 在本仓库中使用
9+ ## 在外部项目中使用
1010
11- 本仓库根目录的 ` AGENTS.md ` 已注册 ` oceanbase-design-usage ` 。在 Cursor、Claude Code 等支持 OpenSkills 的环境中:
11+ 若业务项目使用 ` @oceanbase/design ` / ` @ oceanbase/ui ` ,希望 AI 按同一套规范辅助开发,可从 ** GitHub ** 直接安装本 Skill,无需先 clone 整个仓库。skills 不会作为 npm 包发布,也不会随 ` @oceanbase/design ` 一起发布。
1212
13- - Agent 会根据任务自动匹配并加载该 Skill。
14- - 涉及「OceanBase Design」「OBUI」「Table」「Filter」「ConfigProvider」「迁移」「obToken」等关键词时,会优先参考 Skill 中的规范与 reference。
13+ ### 安装
1514
16- 无需额外配置,克隆仓库后即可在对话中依赖该 Skill 生成或审查与 design/ui/icons 相关的代码。
17-
18- ## 在其它项目中使用
19-
20- 若业务项目使用 ` @oceanbase/design ` / ` @oceanbase/ui ` ,希望 AI 按同一套规范辅助开发,可安装本 Skill:
15+ 在业务项目根目录执行(OpenSkills 会拉取仓库并只安装 skill 子目录):
2116
2217``` bash
23- # 从本仓库本地安装(开发/调试)
24- npx openskills install ./path/to/oceanbase-design/skills/oceanbase-design-usage
25-
26- # 若已发布为 npm 包,可从包内安装
27- npx openskills install ./node_modules/@oceanbase/design-skills/oceanbase-design-usage
18+ npx openskills install oceanbase/oceanbase-design/skills/oceanbase-design-usage
2819```
2920
30- 安装后,在对应项目里使用 ` npx openskills read oceanbase-design-usage ` 可加载规范内容;支持 OpenSkills 的 AI 会在相关任务中自动引用。
31-
32- ## Skill 内容结构
21+ 安装后可执行 ` npx openskills update oceanbase-design-usage ` 更新为仓库最新版本。
3322
34- | 入口 | 说明 |
35- | ------| ------|
36- | ** SKILL.md** | 包关系、包选择速查、最高优先级规则、快速规范、各包说明与链接 |
37- | ** references/design/** | 00 概述、01 主题与 Token、02~09 组件约束与示例 |
38- | ** references/ASSEMBLY.md** | 各模块关键约束一句话汇总 |
39- | ** rules/** | 原子化规则(ConfigProvider、图标来源、Card+Table、Filter 受控等),可做 CI/门禁 |
23+ ### 安装后使用
4024
41- ## 命名说明:oceanbase-design-usage vs oceanbase-design-using
25+ - 在项目中执行 ` npx openskills read oceanbase-design-usage ` 可加载规范内容。
26+ - 在 Cursor、Claude Code 等支持 OpenSkills 的环境中,Agent 会在涉及「OceanBase Design」「OBUI」「Table」「Filter」「ConfigProvider」「迁移」「obToken」等任务时自动引用该 Skill。
4227
43- | 名称 | 含义 | 适用场景 |
44- | ------| ------| ----------|
45- | ** oceanbase-design-usage** (当前) | ** usage** = 使用方式、用法规范。名词,强调「如何使用」的指南与约定。 | 规范类、手册类 Skill,侧重「用法/规范」时更贴切。 |
46- | ** oceanbase-design-using** | ** using** = 正在使用。偏进行时/动名词,常见于 "Using XXX" 文档标题。 | 若希望强调「使用 OceanBase Design 的实践指南」,也可用;与 "Using Ant Design" 等标题风格一致。 |
28+ ## Skill 内容结构
4729
48- ** 选用建议** :当前 Skill 定位为** 使用规范与约束** (如何正确用 design/ui/icons、ConfigProvider、obToken 等),** usage** 更贴近「用法/规范」的语义,因此保留 ** oceanbase-design-usage** 。若后续增加偏「上手指南」「实战教程」的 Skill,可考虑 ** oceanbase-design-using** 或类似命名作为补充。
30+ ```
31+ oceanbase-design-usage/
32+ ├── SKILL.md # 入口与总览
33+ └── references/
34+ ├── ASSEMBLY.md # 00~09 约束汇总
35+ ├── design/ # 基础组件
36+ │ ├── README.md # 模块导航
37+ │ ├── 00-overview.md # 概述、ConfigProvider、约定(根节点必包)
38+ │ ├── 01-theme-and-token.md # 主题与 Token
39+ │ ├── 02-basic.md # 基础组件
40+ │ ├── 03-layout-card.md # 布局与卡片
41+ │ ├── 04-form.md # 表单
42+ │ ├── 05-data-display.md # 数据展示
43+ │ ├── 06-feedback.md # 反馈
44+ │ ├── 07-navigation.md # 导航
45+ │ ├── 08-filter.md # 筛选(含受控约定)
46+ │ └── 09-combo.md # 组合用法(含 Card+Table innerBordered)
47+ ├── ui.md # 业务组件
48+ ├── icons.md # 图标
49+ ├── util.md # 工具
50+ ├── charts.md # 图表
51+ └── codemod.md # codemod 迁移
52+ ```
0 commit comments