← Back to Skills Marketplace
bovinphang

Storybook Component Doc

by Bovin Phang · GitHub ↗ · v2.5.0 · MIT-0
cross-platform ✓ Security Clean
29
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install fec-storybook-component-doc
Description
Use when setting up or reviewing Storybook component documentation, design-system presentation, isolated component state previews, stories, addons, decorator...
README (SKILL.md)

Storybook 组件文档化

Purpose

为 UI 组件建立文档化、设计系统展示和隔离状态预览环境;交互与视觉测试只覆盖 Storybook 场景内的组件状态。

Procedure

  1. 初始化或识别现有 Storybook 配置,沿用项目框架适配器、stories glob、主题和构建命令。
  2. 每个组件的 Story 覆盖默认态、主要变体、尺寸、语义 tone、disabled、loading、error、empty、selected、invalid 和关键边缘状态。
  3. 依赖 Router、Store、i18n、ThemeProvider 的组件用 decorators 包裹,不在 Story 中复制应用入口。
  4. 复杂组件用 MDX 补充使用说明、Props、slots/children、variant 矩阵、状态示例、可访问性要求和源码展示。
  5. 需要自动化时接入 interaction tests、addon-a11y、Chromatic 或 Storybook Test Runner;这些能力服务于组件文档和设计系统展示,不承接跨页业务旅程。
  6. 设计系统组件应记录 token 来源、Tailwind/class 变体、暗色模式、响应式尺寸和不支持的组合,避免消费者靠猜测拼装。

详细参考

Constraints

  • Story 需随组件 prop 变更同步更新。
  • Provider 依赖必须通过 decorator 补齐。
  • Storybook 构建产物 storybook-static/ 不应提交到 Git。
  • Storybook 用于开发和组件文档,不替代生产页面 SEO。
  • Storybook 视觉基线用于组件状态;跨页面截图和真实路由流程分流到 E2E workflow。
  • 大型组件库需控制 stories glob 和 addon 开销。
  • 不用 Storybook 隐藏组件 API 问题;若变体组合爆炸,应先收敛组件职责或拆分组件。

Expected Output

可交互的组件文档和设计系统展示站点,每个组件状态都有隔离预览,Props 表格可生成,关键 Storybook 场景有可选 play 测试或视觉回归基线。

Usage Guidance
Before installing, confirm you want an agent to modify Storybook-related project files and possibly add Storybook, addon-a11y, test-runner, or Chromatic tooling. Keep any Chromatic project token in CI secrets or local secret storage rather than committing it.
Capability Assessment
Purpose & Capability
The stated purpose is to help set up or review Storybook component docs, isolated component states, MDX docs, interaction tests, accessibility addons, and visual baselines; the artifact content stays within that scope.
Instruction Scope
Instructions are scoped to project Storybook configuration, stories, decorators, MDX examples, and optional Storybook/Chromatic test commands, with explicit boundaries against using Storybook for cross-page E2E workflows.
Install Mechanism
The package contains only markdown and JSON files, declares no dependencies or lifecycle scripts, and has no executable files; examples use normal user-invoked npx commands.
Credentials
The expected project access is proportionate for documenting UI components and design-system states; no broad local indexing, credential harvesting, unrelated network calls, or destructive file operations are requested.
Persistence & Privilege
No hidden persistence, privilege escalation, background worker, or automatic startup behavior is present. The reference mentions Chromatic with a project token placeholder, which is expected for visual regression but should be handled as a secret.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install fec-storybook-component-doc
  3. After installation, invoke the skill by name or use /fec-storybook-component-doc
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v2.5.0
- Added comprehensive Chinese/English SKILL.md detailing Storybook component documentation workflow and best practices. - Clarified requirements for Story coverage, decorators, MDX usage, and visual/interaction testing. - Included explicit constraints for Provider dependencies, Git exclusions, and component API clarity. - Outlined expected outputs: interactive documentation site, exhaustive state previews, auto-generated Props tables, and baseline testing options.
Metadata
Slug fec-storybook-component-doc
Version 2.5.0
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 1
Frequently Asked Questions

What is Storybook Component Doc?

Use when setting up or reviewing Storybook component documentation, design-system presentation, isolated component state previews, stories, addons, decorator... It is an AI Agent Skill for Claude Code / OpenClaw, with 29 downloads so far.

How do I install Storybook Component Doc?

Run "/install fec-storybook-component-doc" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is Storybook Component Doc free?

Yes, Storybook Component Doc is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does Storybook Component Doc support?

Storybook Component Doc is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created Storybook Component Doc?

It is built and maintained by Bovin Phang (@bovinphang); the current version is v2.5.0.

💬 Comments