SuperAPI AI 工具集

design-system-documenter

设计与创作

查看项目

更新于 10-15 20:30

技能介绍

用途:把生成好的设计令牌整理成开发者可直接使用的文档,解释“何时使用”而非仅“是什么”。

主要能力:生成令牌参考表(令牌、值、用途、无障碍);按类别(颜色、字体、间距、阴影等)给出用法指南与代码示例;提供视觉示例、交互状态说明;生成无障碍章节,如颜色对比度与 WCAG 等级、减少动画偏好处理;列出常见错误与 Do/Don't 示例;支持 Markdown、MDX、Storybook 等输出格式。

使用方式:在已生成令牌之后使用,输入 tokens.json 或 CSS 变量文件,输出文档文件(如 tokens-docs.md),可发布到文档站点。流程通常为:先由 design-system-generator 生成令牌,再用本技能生成文档,随后审阅并发布。

适用场景:刚生成令牌需要文档、团队对令牌选择存在困惑、新开发者上手设计系统、建设公开设计系统站点。

限制:不用于生成令牌(应先使用 design-system-generator),不用于生成组件代码(应使用 component-template-generator),也不适用于非设计系统代码的文档。具体输出细节与模板参考以实际资料为准。