/design-system
如果您看到不熟悉的占位符或需要检查已连接了哪些工具,请参阅 CONNECTORS.md。
管理您的设计系统——审计一致性、记录组件或设计新模式。
用法
/design-system audit # 完整系统审计
/design-system document [组件名] # 记录一个组件
/design-system extend [模式名] # 设计新组件或新模式
设计系统的组成部分
设计令牌
定义视觉语言的基础值:
- 颜色(品牌色、语义色、中性色)
- 字体排版(比例尺、字重、行高)
- 间距(比例尺、组件内边距)
- 边框(圆角、宽度)
- 阴影(层级高度)
- 动效(时长、缓动函数)
组件
可复用的 UI 元素,带有定义好的:
- 变体(主要、次要、幽灵)
- 状态(默认、悬停、激活、禁用、加载中、错误)
- 尺寸(小、中、大)
- 行为(交互、动画)
- 无障碍(ARIA、键盘)
模式
结合组件的常见 UI 解决方案:
- 表单(输入组、验证、提交)
- 导航(侧边栏、标签页、面包屑)
- 数据展示(表格、卡片、列表)
- 反馈(吐司提示、模态框、内联消息)
原则
- 一致性胜于创造性——系统的存在是为了让团队不必重复造轮子
- 约束下的灵活性——组件应可组合,而非僵化
- 记录一切——没有被记录的东西就不存在
- 版本化与迁移——破坏性变更需要有迁移路径
输出——审计
## 设计系统审计
### 总结
**检查的组件数:** [X] | **发现的问题数:** [X] | **评分:** [X/100]
### 命名一致性
| 问题 | 影响组件 | 建议 |
|------|----------|------|
| [命名不一致的描述] | [列表] | [采用的标准] |
### 令牌覆盖率
| 类别 | 已定义 | 发现的硬编码值 |
|------|--------|----------------|
| 颜色 | [X] | [X] 处硬编码十六进制 |
| 间距 | [X] | [X] 处使用任意值 |
| 字体排版 | [X] | [X] 处自定义字体/字号 |
### 组件完整性
| 组件 | 状态 | 变体 | 文档 | 得分 |
|------|------|------|------|------|
| Button | ✅ | ✅ | ⚠️ | 8/10 |
| Input | ✅ | ⚠️ | ❌ | 5/10 |
### 优先行动项
1. [最具影响力的改进]
2. [第二优先级]
3. [第三优先级]
输出——文档
## 组件:[名称]
### 描述
[该组件是什么以及何时使用]
### 变体
| 变体 | 使用场景 |
|------|----------|
| [主要] | [主要操作] |
| [次要] | [辅助操作] |
### 属性
| 属性 | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| [prop] | [type] | [default] | [description] |
### 状态
| 状态 | 视觉效果 | 行为 |
|------|----------|------|
| 默认 | [描述] | — |
| 悬停 | [描述] | [交互] |
| 激活 | [描述] | [交互] |
| 禁用 | [描述] | 不可交互 |
| 加载中 | [描述] | [动画] |
### 无障碍
- **角色**:[ARIA 角色]
- **键盘**:[Tab、Enter、Escape 行为]
- **屏幕阅读器**:[提示为...]
### 注意事项
| ✅ 应做 | ❌ 不应做 |
|--------|----------|
| [最佳实践] | [反模式] |
### 代码示例
[框架相关的代码片段]
输出——扩展
## 新组件:[名称]
### 问题
[该组件解决的用户需求或空白]
### 现有模式
| 相关组件 | 相似点 | 为何不够 |
|----------|--------|----------|
| [组件] | [共有的内容] | [缺失的内容] |
### 提议的设计
#### API / 属性
| 属性 | 类型 | 默认值 | 描述 |
|------|------|--------|------|
| [prop] | [type] | [default] | [description] |
#### 变体
| 变体 | 使用场景 | 视觉效果 |
|------|----------|----------|
| [变体] | [场景] | [描述] |
#### 状态
| 状态 | 行为 | 备注 |
|------|------|------|
| 默认 | [描述] | — |
| 悬停 | [描述] | [交互] |
| 禁用 | [描述] | 不可交互 |
| 加载中 | [描述] | [动画] |
#### 使用的令牌
- 颜色:[哪些令牌]
- 间距:[哪些令牌]
- 字体排版:[哪些令牌]
### 无障碍
- **角色**:[ARIA 角色]
- **键盘**:[预期的交互]
- **屏幕阅读器**:[提示为...]
### 未解决问题
- [需要设计评审的决定]
- [需要解决的边界情况]
如果连接器可用
如果已连接 ~~设计工具:
- 直接在 Figma 中审计组件——检查命名、变体和令牌使用情况
- 提取组件属性和图层结构用于文档编写
如果已连接 ~~知识库:
- 搜索现有的组件文档和使用指南
- 将更新后的文档发布到您的知识库
提示
- 从审计开始——在决定去向之前先了解当前状况。
- 边构建边记录——在设计组件的同时记录文档会更简单。
- 覆盖优先于完美——80% 的组件有文档胜过 10 个组件 100% 有文档。