mcpField
D
design-system-generator

design-system-generator

github.com/thienanblog设计与 UI6957 次安装4 周前更新
代码仓库

关于 design-system-generator

Design System Generator 是面向产品团队的技能,用于创建或更新项目专属的设计系统文档。它依据现有代码与视觉语言制定内容,并核对文档细节是否符合项目实际。

主要功能

  1. 01检查现有设计资料
  2. 02记录项目专属设计规则
  3. 03沿用既有设计系统
  4. 04按需导出 CSS 或 JSON 令牌
  5. 05对照源文件验证文档

适用场景

  1. 01整理现有产品的设计系统
  2. 02为新产品制定设计规则
  3. 03核验组件与令牌文档
  4. 04准备所需的令牌导出

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/thienanblog/awesome-ai-agent-skills --skill design-system-generator

安装后在 Claude Code 中输入/design-system-generator确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

README.md
TEMPLATE_DESIGN_SYSTEM.md
agents/
openai.yaml
examples/
AGENTS.patch.md
design-tokens.json
manifest.example.json
tokens.css

详细介绍

设计系统生成器

制定一套简洁的设计系统,以产品实际使用的技术栈和视觉语言为依据。记录有助于今后保持 UI 一致性的决策。

委派

默认在主对话中执行。委派可能增加用量:使用子 Agent 前,先就拟定的 Agent 数量和工作范围征得明确许可。在已批准的范围内可重复使用该许可;如需扩大批准的数量或范围,则须再次征求许可。

提议前先检查

阅读现有设计文档、品牌参考资料、有代表性的界面、共享组件、主题配置、设计令牌和构建工具。根据这些资料推断框架、CSS 方案、主题、浏览器支持情况和导出格式。只询问会对文档产生实质影响且尚未确定的产品选择。

保留已有且连贯的系统。对于新产品,在用户约束范围内推荐一个合适的方向;仅在有帮助或用户提出要求时比较备选方案。不要仅为符合此技能的示例而添加组件库或迁移构建工具。

编写项目契约

将 TEMPLATE_DESIGN_SYSTEM.md 作为主题清单。省略不适用的章节,并以经过核实的项目决策替换示例。涵盖相关内容:

  • 界面、主题、设备,以及语言或 RTL 约束;
  • 设计令牌的归属、字体排印、颜色、间距、布局和动效;
  • 共享组件及其实际支持的交互状态;
  • 设计令牌、组件、工具类和局部例外的扩展规则;
  • 键盘交互、可见焦点、对比度目标、语义化标记和减少动效;
  • 在可比状态和视口下进行视觉验证;
  • 设计系统负责资产加载和缓存失效时的相关职责。

涉及流水线细节时,链接到现有的构建或部署指南。带哈希的文件名和清单只是一种缓存策略,并非必须新增的构建系统。避免记录产品并未使用的框架或主题支持情况。

保持说明可执行且针对具体项目。文档面向产品团队;省略提示词编写建议和通用框架教程。

输出

更新现有设计系统的归属文档,或在仓库惯用的位置创建 DESIGN_SYSTEM.md。仅在用户要求或已商定的实现需要时,才导出 CSS 或 JSON 设计令牌。只有在需要这些格式时,才阅读 examples/tokens.css 和 examples/design-tokens.json;examples/manifest.example.json 仅适用于基于清单的流水线。

如果需要通过指令文件链接提高可发现性,请使用 examples/AGENTS.patch.md 中的最简模式,并保留任何现有 AGENTS.md/CLAUDE.md 的归属关系或符号链接。不要添加重复的指令文件或重复的设计规则。

验证

根据各自的归属来源,核对文档中记录的路径、设计令牌名称、组件 API 和构建说明。制定视觉决策或更改设计令牌时,检查有代表性的已渲染组件;如果无法进行视觉验证,请予以说明。移除占位内容、矛盾之处和重复的事实来源。

报告文档和任何导出内容、重要决策、已执行的验证,以及尚未解决的选择。

评论

支持 Markdown