SuperAPI AI 工具集

design-md-convention

设计与创作

查看项目

更新于 10-16 00:21

技能介绍

用途:DESIGN.md 约定用于在项目根目录维护一个 Markdown 格式的设计系统文件,作为 AI 代理生成或修改 UI 时的唯一事实来源。它受 VoltAgent/awesome-design-md(55+ 流行设计系统,Google Stitch 概念)启发,用人类与 LLM 都可读的文本替代 Figma 和复杂 JSON。

主要能力:解决 AI 随机生成颜色、组件间距不一致、字体多变、设计/开发上手慢、每个决策都依赖 Figma 等问题。文件随代码版本化,可在 PR 中评审。

推荐结构:包含 7 个必填部分——视觉原则(语气、个性、do/don't)、设计令牌(颜色、字体、间距、圆角、阴影)、栅格与布局(断点、列、间距、容器宽度)、组件(列表+变体+使用规则)、交互模式(hover、focus、active、disabled、loading)、无障碍(目标等级 AA/AAA、对比度、焦点环)、参考(可选 Figma 链接、参考的设计系统)。完整结构见 .claude/templates/DESIGN.md.template。

撰写规则:简洁结构化,表格优于散文,令牌优于硬编码值;使用命名令牌而非原始值;明确写出 DO/DON'T;与代码一起版本化。

与 Claude Craft 代理集成:@ui-designer 按令牌生成 UI,@ux-ergonome 校验交互模式,@accessibility-expert 检查对比度是否达标,@{react,vue,angular}-reviewer 标记硬编码值。

推荐流程:新项目复制 .claude/templates/DESIGN.md.template 到根目录;填写 7 个部分(30-60 分钟);提交 DESIGN.md;在项目 @.claude/CLAUDE.md 中引用 "@DESIGN.md";AI 代理自动加载;设计系统演进时更新。

辅助生成:专用命令(Phase 4)/uiux:generate-design-md 可分析 tailwind.config.js 或现有令牌、预填部分内容,并对模糊区域请求确认。

限制与反模式:DESIGN.md 超过 500 行应拆分为 docs/design/*.md;避免无表格的散文、缺少 do/don't、仅有截图(LLM 不一定能看到图片)、与代码不同步(可加 CI 令牌 lint 检查)。资料未提供具体收费、价格或平台支持信息。