Agent skill

Check Doc Component Consistency

by wot-ui in wot-ui/wot-ui

只做组件文档与源码实现的一致性核对或最小修正。用户要求核对 props、events、slots、methods、默认值、命名是否准确,但未要求迁移文档结构、重排 Demo 或升级到新规范时调用。

MITAuto-check passedFrontend & Design

Install Check Doc Component Consistency

skills CLI
$ npx skills add wot-ui/wot-ui --skill check-doc-component-consistency -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install wot-ui/wot-ui check-doc-component-consistency --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/wot-ui/wot-ui.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/check-doc-component-consistency .claude/skills/check-doc-component-consistency && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
check-doc-component-consistency
GitHub stars
386
Token cost
~293 tokens
SKILL.md length
85 words
Files
1
Skills in repo
10
Repo updated
First seen
Licence
MIT

At a glance

只做组件文档与源码实现的一致性核对或最小修正。用户要求核对 props、events、slots、methods、默认值、命名是否准确,但未要求迁移文档结构、重排 Demo 或升级到新规范时调用。

  • Works in 4 steps: 以组件源码为事实来源,文档向源码对齐。 → 仅报告可证实差异,不做主观推断。 → 无源码依据的文档能力标记为“待确认/建议删除”。 → …
  • Frontend & Design work in your project
  • SKILL.md covers 何时使用, 何时不要使用, 校对范围 and 核心规则, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Check Doc Component Consistency is an agent skill from wot-ui/wot-ui. 只做组件文档与源码实现的一致性核对或最小修正。用户要求核对 props、events、slots、methods、默认值、命名是否准确,但未要求迁移文档结构、重排 Demo 或升级到新规范时调用。

Its SKILL.md is about 290 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Frontend & Design. The repository describes itself as: 一个轻量、美观、AI友好的 uni-app 组件库。 The licence is MIT.

When your agent uses it

  • Frontend & Design work in your project

Example prompts

  • “/check-doc-component-consistency”

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. 以组件源码为事实来源,文档向源码对齐。
  2. 仅报告可证实差异,不做主观推断。
  3. 无源码依据的文档能力标记为“待确认/建议删除”。
  4. 保持最小修改原则,优先修正文案与 API 表,不无关重排结构。

What it can do on your machine

Read from SKILL.md and the folder at commit 486d06d. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Check Doc Component Consistency loads about 293 tokens when it runs. Until then it costs about 33 tokens; SKILL.md has 85 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~33
When it runs · the whole SKILL.md, loaded when a task matches
~293

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from wot-ui/wot-ui at commit 486d06d, republished under its MIT licence (© wot-ui). 85 words, ~293 tokens.

Download SKILL.mdSave it as .claude/skills/check-doc-component-consistency/SKILL.md (or your agent's skills folder).
name
check-doc-component-consistency
description
只做组件文档与源码实现的一致性核对或最小修正。用户要求核对 props、events、slots、methods、默认值、命名是否准确,但未要求迁移文档结构、重排 Demo 或升级到新规范时调用。

文档与实现一致性校对技能

用于系统校对组件文档与组件源码实现是否一致,输出差异清单并给出最小改动修正方案。

默认遵循 wot-ui-component-baseline 中的共享约束。

何时使用

  • 用户要求“检查文档和组件实现是否一致”。
  • 用户反馈“文档参数/事件与实际行为不符”。
  • 用户要求“只做核对,不做大规模迁移重构”。
  • 在发版前做组件 API 文档一致性巡检。

何时不要使用

  • 用户明确要求“迁移到新文档规范”。
  • 用户要求重排 Demo 章节结构或调整 Attributes/Options 表结构。
  • 用户要新建或重构 Demo 页。

以上场景应优先使用 migrate-component-doc 或 create-demo-page。

校对范围

  • Attributes(props 名称、类型、默认值、可选值、平台限制)
  • Events(事件名、参数签名、触发时机)
  • Slots(插槽名、作用域参数)
  • Methods(对外暴露方法与入参)
  • 示例代码(是否可映射到真实能力与当前 API)

核心规则

  1. 以组件源码为事实来源,文档向源码对齐。
  2. 仅报告可证实差异,不做主观推断。
  3. 无源码依据的文档能力标记为“待确认/建议删除”。
  4. 保持最小修改原则,优先修正文案与 API 表,不无关重排结构。

执行步骤

  1. 定位目标组件源码与对应文档文件。
  2. 提取源码 API:props / emits / slots / expose methods。
  3. 提取文档 API:Attributes / Events / Slots / Methods。
  4. 逐项对比并输出差异:缺失、冗余、命名不一致、类型不一致、默认值不一致。
  5. 给出修复建议并直接生成可应用的文档改动。
  6. 进行一次诊断或构建检查,确保文档可通过校验。

输出格式

  • 一致性结论(通过 / 不通过)
  • 差异清单(按模块分组)
  • 已修复项与未修复项
  • 风险说明(若存在待确认能力)

示例触发语句

  • “帮我校对一下 picker 文档和组件实现是否一致”
  • “检查 upload 的 events 和 methods 文档是不是准确”
  • “这个组件文档有点旧,先做一致性核查并修正”

© wot-ui, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/check-doc-component-consistency of wot-ui/wot-ui.

Open the folder on GitHubat commit 486d06d

Compare with similar skills

Check Doc Component Consistency next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Check Doc Component Consistency compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Check Doc Component Consistency this skillwot-ui/wot-ui386—~293Automated safety check: PassMIT
Web Artifacts Builderanthropics/skills180k41 repos~769Automated safety check: PassApache-2.0
React Doctormakeplane/plane61k12 repos~657Automated safety check: PassAGPL-3.0
Impeccablebestofjs/bestofjs3.1k27 repos~2.6kAutomated safety check: PassMIT
Figma Design System Builderwarpdotdev/warp65k2 repos~4.4kAutomated safety check: PassAGPL-3.0
Web Interface Guidelines Reviewervercel-labs/openreview1.7k97 repos~308Automated safety check: PassNone

Similar skills

  • Web Artifacts Builder

    anthropics/skills

    Official

    Builds multi-component claude.ai HTML artifacts as a small React, TypeScript and Tailwind project, then bundles it into one shareable HTML file.

    180k GitHub starsUsed in 41 repos~769 tokens
    Frontend & DesignAuto-check passed
  • React Doctor

    makeplane/plane

    Scans React code for lint, accessibility, bundle size and architecture issues, reports a health score and checks that changes do not lower it.

    61k GitHub starsUsed in 12 repos~657 tokens
    Frontend & DesignAuto-check passed
  • Impeccable

    bestofjs/bestofjs

    A skill your agent uses when the user wants to design, redesign, shape, critique, audit, polish, clarify, distill, harden, optimize, adapt, animate, colorize, extract, or otherwise improve a…

    3.1k GitHub starsUsed in 27 repos~2.6k tokens
    Frontend & DesignAuto-check passed
  • Builds or updates a design system in Figma from a codebase in ordered phases: discovery, variables and tokens, components, theming and documentation, with checkpoints.

    65k GitHub starsUsed in 2 repos~4.4k tokens
    Frontend & DesignAuto-check passed
  • Web Interface Guidelines Reviewer

    vercel-labs/openreview

    Official

    Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my…

    1.7k GitHub starsUsed in 97 repos~308 tokens
    Frontend & DesignAuto-check passed
  • Tailwindcss Development

    anonaddy/anonaddy

    Always invoke when the user's message includes 'tailwind' in any form.

    4.9k GitHub starsUsed in 10 repos~865 tokens
    Frontend & DesignAuto-check passed

More from wot-ui/wot-ui

All 10 skills in this repo
  • Create Component

    wot-ui/wot-ui

    在 wot-ui 项目中创建新组件骨架与必要注册点。用户要求从零创建组件源码、补齐 types.vue.scss 结构或注册全局组件类型时调用;不负责 Demo 页、测试和文档迁移。

    386 GitHub stars~2.1k tokensUpdated today
    Auto-check passed
  • Create Demo Page

    wot-ui/wot-ui

    为组件创建演示页面并统一组织结构。用户要求新建/重构组件 Demo、统一展示顺序或用 demo-group 与 demo-group-item 编排时调用。

    386 GitHub stars~547 tokensUpdated today
    Auto-check passed
  • 为新组件或新特性快速生成符合设计系统规范的 SCSS 变量定义代码,或检查现有变量是否合规. An agent skill from wot-ui/wot-ui.

    386 GitHub stars~906 tokensUpdated today
    Auto-check passed
  • Generate Theme

    wot-ui/wot-ui

    为 wot-ui 生成单文件主题 SCSS,并在 App.vue 中挂载语义变量. An agent skill from wot-ui/wot-ui.

    386 GitHub stars~2.4k tokensUpdated today
    Auto-check passed
  • 优化 subPages 演示页面中的样式,将硬编码的颜色、字号、间距、圆角等替换为 wot-ui 设计系统语义变量。允许直接使用已全局注入的 variable.scss Sass 变量,也允许使用 CSS 自定义属性;不需要额外引入 variable.scss。消除手写的暗色模式覆盖块,统一使用语义变量实现自适应主题。同时将 class 命名统一为 BEM 规范。

    386 GitHub stars~4.9k tokensUpdated today
    Auto-check passed
  • Vue Comment

    wot-ui/wot-ui

    统一 Vue 与 wot-ui 组件源码中的注释和命名规范。用户要求规范组件 Props 注释、函数命名、类型说明、变量命名或在创建组件后补齐代码注释时调用;不负责 Demo、测试和文档迁移。

    386 GitHub stars~965 tokensUpdated today
    Auto-check passed

Questions about Check Doc Component Consistency

What does Check Doc Component Consistency do?

只做组件文档与源码实现的一致性核对或最小修正。用户要求核对 props、events、slots、methods、默认值、命名是否准确,但未要求迁移文档结构、重排 Demo 或升级到新规范时调用。. Check Doc Component Consistency is an agent skill from wot-ui/wot-ui.

When should I use Check Doc Component Consistency?

Check Doc Component Consistency fits situations like: frontend & Design work in your project.

How do I install Check Doc Component Consistency in Claude Code?

Run `npx skills add wot-ui/wot-ui --skill check-doc-component-consistency -a claude-code`. Or copy the skill folder (.agents/skills/check-doc-component-consistency in wot-ui/wot-ui) into .claude/skills/check-doc-component-consistency in your project. Claude Code loads it when a task matches its description.

How do I install Check Doc Component Consistency in Codex?

Run `npx skills add wot-ui/wot-ui --skill check-doc-component-consistency -a codex`. Or copy the skill folder (.agents/skills/check-doc-component-consistency in wot-ui/wot-ui) into .agents/skills/check-doc-component-consistency in your project. Codex loads it when a task matches its description.

Can I use Check Doc Component Consistency in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add wot-ui/wot-ui --skill check-doc-component-consistency -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/check-doc-component-consistency, .gemini/skills/check-doc-component-consistency, .github/skills/check-doc-component-consistency and .opencode/skills/check-doc-component-consistency in your project.

What does Check Doc Component Consistency need to run?

SKILL.md names no scripts, command-line tools or credentials: Check Doc Component Consistency is instructions for the agent only.

Does Check Doc Component Consistency access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Check Doc Component Consistency safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Check Doc Component Consistency use?

Check Doc Component Consistency is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Check Doc Component Consistency use?

About 293 tokens (SKILL.md is roughly 1.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Check Doc Component Consistency?

Skills that share tags, products or a category with Check Doc Component Consistency: Web Artifacts Builder (anthropics/skills, 180k stars), React Doctor (makeplane/plane, 61k stars), Impeccable (bestofjs/bestofjs, 3.1k stars) and Figma Design System Builder (warpdotdev/warp, 65k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Check Doc Component Consistency?

wot-ui (a GitHub organization) maintains it in wot-ui/wot-ui, which has 386 GitHub stars. The repository holds 10 skills in this directory. The repository was last updated on October 9, 2026.

Source: wot-ui/wot-ui on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.