跳转到使用指南
Component Spec作者 Owl-Listener

Component Spec Skill.

对组件行为和外观给予同等细致的说明,使其可供实现。

  • 设计系统
  • 规范
来源审查 · Component SpecSKILL.md
任务 设计系统 产出 • 结构与变体规范 • 包含类型、默认值和是否必填的属性表 • 状态、行为、无障碍和使用规则 开始之前 请提供组件用途、视觉变体和目标平台。产出是用于实现和测试的规范,而不是已经实现的组件。
编辑摘要 · 已审查来源 2026-10-07 · 非生成示例

01 功能说明

Component Spec:为单个组件库组件编写规范

一份单组件契约,涵盖结构、API、变体、交互状态、无障碍和使用方式。

基于来源的工作流并非执行基准测试

工作方法

Component Spec 定义单个设计系统组件。它围绕结构、变体、API 属性、交互状态、响应式行为、无障碍和使用方式来组织交接内容,并明确区分必需部分和可选部分。

其目的是帮助设计师和开发者达成共识。按钮的加载行为或对话框的焦点返回机制无法通过静态截图体现。因此,来源要求提供示例和边界情况,同时将更广泛的文档模板和多组件模式排除在此任务之外。

预期交付物

  • 结构与变体规范
  • 包含类型、默认值和是否必填的属性表
  • 状态、行为、无障碍和使用规则
查看示例简报

从简报到审查

  1. 01
    确定组件边界

    定义其用途、适用场景,以及必需部分与可选部分。

  2. 02
    指定 API 和状态

    命名属性和变体,然后说明默认、聚焦、禁用、加载及相关错误行为。

  3. 03
    明确交互细节

    通过可供实现检查的示例,记录键盘、焦点、响应式和边界情况行为。

02 适用场景

何时使用

请提供组件用途、视觉变体和目标平台。产出是用于实现和测试的规范,而不是已经实现的组件。

适用情形

  • 新的组件库组件在多个团队分别实现同一控件的不同版本之前使用。
  • 存在歧义的交接明确变体之间有哪些变化,以及状态转换如何运作。

需要确认的限制

  • 并非整个组件库范围仅限一个组件,而不是完整的设计系统架构。
  • 规范不等于实现书面的无障碍规则仍需实现和测试。

请准备这些输入

  • 组件用途说明用户任务和相关控件。
  • 现有示例提供视觉变体和当前行为。
  • 平台契约明确框架、输入方式和无障碍要求。

03 关键决策

关键决策

  1. 行为是核心内容

    状态和转换会成为交接内容的一部分,而不再依赖开发者猜测。

  2. 共享词汇

    属性名称和结构标签将设计决策与实现联系起来。

04 示例任务

尝试使用聚焦的简报

以下示例简报尚未经过测试。使用前请检查该技能的设置说明。

查看设置说明

从 designer-skills 仓库将此任务的 SKILL.md 加载到代理支持的技能位置。入口文件并未规定通用的安装命令。

上游源文件
https://github.com/Owl-Listener/designer-skills/blob/9a6930cf84a822eb458624bd11c61aac5bbdf224/design-systems/skills/component-spec/SKILL.md

请提供组件用途、视觉变体和目标平台。产出是用于实现和测试的规范,而不是已经实现的组件。

从一项交付物开始

运行该技能之前,请调整此简报的范围、来源材料和约束条件。

示例简报
使用 component-spec 为我们的异步提交按钮编写文档。指定其结构、尺寸、属性、焦点、加载、禁用和错误行为。说明重复点击和键盘激活的处理方式,并说明应改用链接的情形。不得声称该组件已实现。

检查结果

根据以下可观察的标准检查实际产出。

  • 属性具有明确的默认值和必填要求。
  • 每种相关状态都有行为示例。
  • 键盘和焦点要求可供测试。

OpenDesign 为编码代理提供本地设计工作区。此条目并不表示该技能已内置,也不表示其中包含其外部工具、凭据和软件依赖项。

05 来源与许可证

来源与许可证

本页描述的是下方所链接的固定来源版本。上游行为和要求可能发生变化。

来源所有者
Owl-Listener
许可证
MIT
已审查的快照
2026-10-07 · 9a6930cf84a8
编辑来源摘要
一份单组件契约,涵盖结构、API、变体、交互状态、无障碍和使用方式。

由 OpenDesign 根据所链接来源撰写的原创摘要。仓库星标数是带有时间属性的受欢迎程度信号,并不代表技能使用量或质量评分。

06 开始前的问题

开始前的问题

它会生成生产代码吗?

它旨在产出可供开发者实现的规范。构建和测试组件是另外的步骤。

其中包含无障碍内容吗?

是。角色、键盘导航、屏幕阅读器行为和焦点管理均为明确的章节。

它与模式库有何不同?

它用于指定一个组件;模式描述的是范围更广的问题与解决方案组合。

OpenDesign

为下一轮设计迭代留出空间。

将简报、来源材料和设计工作统一保存在本地工作区中。将该技能加入工作流之前,请先查看其自身的设置说明。

上游源文件
https://github.com/Owl-Listener/designer-skills/blob/9a6930cf84a822eb458624bd11c61aac5bbdf224/design-systems/skills/component-spec/SKILL.md