Ready to supercharge your AI agents?

Install any skill in seconds. Free to start, no credit card required.

Get Started Free →

Component Documentation Workflow · Ohh-889 | DecimalAI

documentationby Ohh-889

Component Documentation Workflow

component-doc

Source Ohh-889/skyroc-admin ↗License Not recorded

为 @skyroc/web-ui 组件编写文档。当用户说出组件名（如 Button、Accordion、AlertDialog）时触发。自动定位组件源码、playground demo、已有文档，按照项目文档规范生成或更新 MDX 文档。

SkillScore37Maintained

Automatic

Writing & Editing pack

Last verified 7/23/2026

What it changes

Passed 9 of 24 test cases with the skill, and 3 of 24 without it.

Without skill11%

With skill37%

7 fixed3 passed either way17 still failing0 broke

Pass-rate lift: +26 pp
Tokens: +185%
Agent turns: 0%
Response time: -39%

Model gemini-3.6-flashMeasured 7/23/2026v110 of 27 cases passed with skill · 24 comparable

Tokens, turns and time describe resource use, not a dollar price.

Use this skill

Save it into your project's skills folder. Claude Code picks it up in its next session.

curl -fsSL --create-dirs -o .claude/skills/component-doc/SKILL.md https://app.decimal.ai/s/component-doc/SKILL.md

Want it pinned and updatable? pip install "decimalai>=0.15", then decimalai skills add component-doc, and start Claude Code with claude --plugin-dir "$(git rev-parse --show-toplevel)/.agents"

1 · One-time — install the CLI (docs ↗)

pip install "decimalai>=0.15"

2 · Get the skill — writes .agents/skills/component-doc/ and pins it in .decimal/skills.lock

decimalai skills add component-doc

No CLI? Get the same file — curl · raw file

curl -fsSL --create-dirs -o .claude/skills/component-doc/SKILL.md https://app.decimal.ai/s/component-doc/SKILL.md

Raw file: /s/component-doc/SKILL.md ↗ · machine-readable summary at /s/component-doc.json ↗

Safety checks: 3 of 3 passed

Code scan CleanIntent PassedContent Clean

What's inside

The instructions your model reads when the skill loads.

SKILL.md298 linessingle file

Component Documentation Workflow

为 @skyroc/web-ui 组件库编写文档的专用工作流。

文件定位规则

给定组件名 $COMPONENT（用户输入，如 Button），将其转为 kebab-case $slug（如 button），然后按以下路径查找：

用途	路径
组件源码	`packages/web/ui/shadcn/src/components/$slug/`
Playground Demo	`apps/web-ui-playground/src/app/[locale]/(demo)/$slug/modules/`
文档 MDX	`apps/web-ui-docs/content/docs/components/$slug.mdx`

文档基础设施文件（不需要每次都读，但需要了解）：

文件	作用
`apps/web-ui-docs/components/props-table.tsx`	`<PropsTable>` — API 属性表格
`apps/web-ui-docs/components/type-table.tsx`	`<TypeTable>` + `<UnionType>` — 类型定义区
`apps/web-ui-docs/components/type-anchor.tsx`	类型链接解析（PascalCase 自定义类型 → 蓝色可点击锚点）
`apps/web-ui-docs/components/type-registry.ts`	跨页面类型链接注册表
`apps/web-ui-docs/components/demo/index.tsx`	`<Demo>` — 从 playground 加载 live demo
`apps/web-ui-docs/components/mdx.tsx`	MDX 组件注册（Demo / PropsTable / TypeTable / UnionType）

执行流程

Phase 1: 源码阅读与行为校验

读取 packages/web/ui/shadcn/src/components/$slug/ 下所有文件
- 重点关注：index.ts（导出）、types.ts（Props 定义）、*-variants.ts（样式变体）、主组件文件
读取 apps/web-ui-playground/src/app/[locale]/(demo)/$slug/modules/ 下所有 demo
- 如果目录不存在或 demo 数量不足以覆盖文档需要的功能章节，标记为"需创建 demo"
如果 preset 包装器存在，读取 packages/web/ui/shadcn/src/preset/$slug/ 了解预设封装和 useComponentConfig 集成
如果已有文档 MDX，读取 apps/web-ui-docs/content/docs/components/$slug.mdx
读取一个已完成的文档作为参考模板（优先 alert.mdx，其次 button.mdx）

实现一致性校验（必须执行）

文档不是 API 想象稿，必须从 源码、类型、demo、实际行为 四者交叉验证。

Track record

Benchmark

9 / 24

test cases passed, vs 3 / 24 without

Adoption

Users: 0
Times used: 0

Safety and source details

SkillSafety

✓ 3 of 3 passed

Code scan15 of 15 checks clean

0 critical · 0 warning · 0 info — scanner v4 — 7/30/2026

View 15 scanner checks

live_secretremote_code_executionreverse_shelldata_exfiltrationssrf_metadataagent_snoopinganti_refusaldestructive_commandsobfuscated_unicodeunicode_homoglyphopaque_blobsuspicious_urltool_overreachtrigger_abuseprompt_injection_phrasing

IntentSafe

LLM judge · does the skill do what it claims

ContentClean

LLM judge · policy & harmful-content review

Source

Imported

Ohh-889 / skyroc-admin

.claude/skills/component-doc/SKILL.md

View on GitHub ↗

Imported 6/14/2026Version v1

Other skills for the same job

Published skills whose descriptions closely match this one, with their headline benchmark lift.

ohh-889/component-doc为 @skyroc/web-ui 组件编写文档。当用户说出组件名（如 Button、Accordion、AlertDialog）时触发。自动定位组件源码、playground demo、已有文档，按照项目文档规范生成或更新 MDX 文档。Near-identical description+30 pp pass-rate lift

More skills from the same source and nearby in the registry, with their headline benchmark lift.

Ready to supercharge your AI agents?

What's inside

Component Documentation Workflow

文件定位规则

执行流程

Phase 1: 源码阅读与行为校验

实现一致性校验（必须执行）

Track record

Benchmark

Adoption

SkillSafety

Source

Other skills for the same job

Related skills