Agent skill

Zui Doc

by easysoft in easysoft/zui

维护 ZUI 主仓库 lib/ 的官网文档源、API 说明、示例与静态组件预览。需求明确时直接实施;只要求审阅时保持只读。

MITAuto-check passedFrontend & Design

Install Zui Doc

skills CLI
$ npx skills add easysoft/zui --skill zui-doc -a claude-code

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

GitHub CLI
$ gh skill install easysoft/zui zui-doc --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/easysoft/zui.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/zui-doc .claude/skills/zui-doc && 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
zui-doc
GitHub stars
2.8k
Token cost
~380 tokens
SKILL.md length
53 words
Files
2
Skills in repo
24
Repo updated
First seen
Licence
MIT

At a glance

维护 ZUI 主仓库 lib/ 的官网文档源、API 说明、示例与静态组件预览。需求明确时直接实施;只要求审阅时保持只读。

  • Works in 8 steps: 按 共享工作流… → 按需阅读 documentation 规范… → 阅读目标文档和核实本次说明所需的公开类型、入口或实现;新建或重构页面时再检查相关页… → …
  • Frontend & Design work in your project
  • SKILL.md covers 工作流 and 组合边界
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Zui Doc is an agent skill from easysoft/zui. 维护 ZUI 主仓库 lib/ 的官网文档源、API 说明、示例与静态组件预览。需求明确时直接实施;只要求审阅时保持只读。

Its SKILL.md is about 380 tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files (for example `agents/openai.yaml`).

It sits in Frontend & Design. The repository describes itself as: ZUI is an HTML5 front UI framework. The licence is MIT.

When your agent uses it

  • Frontend & Design work in your project

Example prompts

  • “/zui-doc”

Workflow steps

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

  1. 按 共享工作流 定位目标、检查已有改动并复用上下文;按其澄清规则消除影响本次交付的歧义,需求明确时直接实施。
  2. 按需阅读 documentation 规范 中与本次变更有关的部分;自定义元素文档同时读取 Web Component 规范,区分元素 API 与原组件 API。
  3. 阅读目标文档和核实本次说明所需的公开类型、入口或实现;新建或重构页面时再检查相关页面结构和必要参考,不发明 API。新增或修改布局类、示例容器类或可复制代码时,读取并执行 CSS utilities 核实流程。
  4. 优先沿用已有分类;否则按内容选择 lib//docs/lib//index.md。index.md 是默认主页面,仅在已有结构或用户明确要求时维护额外页面。
  5. 新建或重构文档时,第一屏提供可运行基础示例,再按实际 API 和请求范围补充场景、选项、事件、方法和类型;引入说明遵循接入与构建说明,只补充影响使用步骤的特殊条件。官网使用 、::: tabs、 与 ,不得混用调试页的…
  6. 只修改正式文档及其明确需要的文档资源和回归测试;不得手工编辑 docs/_ 代替修改文档源,不得为了让文档成立而悄悄修改运行时代码。发现源码问题时单独报告。
  7. 按共享工作流选择必要的文案、链接或同步/构建检查;运行示例变更按示例验收核实预览与复制代码,静态组件预览变更执行组件预览规范。修复本次引入且位于范围内的问题并复验,生成物遵循验证隔离要求。
  8. 汇报目标页面、覆盖内容、验证结果与源码/文档差异,不自动提交。

What it can do on your machine

Read from SKILL.md and the folder at commit 3b1d7da. 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

Zui Doc loads about 380 tokens when it runs. Until then it costs about 18 tokens; SKILL.md has 53 words of instructions outside code blocks.

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

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 easysoft/zui at commit 3b1d7da, republished under its MIT licence (© easysoft). 53 words, ~380 tokens.

Download SKILL.mdSave it as .claude/skills/zui-doc/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
zui-doc
description
维护 ZUI 主仓库 lib/* 的官网文档源、API 说明、示例与静态组件预览。需求明确时直接实施;只要求审阅时保持只读。

ZUI 正式文档

工作流

  1. 按 共享工作流 定位目标、检查已有改动并复用上下文;按其澄清规则消除影响本次交付的歧义,需求明确时直接实施。
  2. 按需阅读 documentation 规范 中与本次变更有关的部分;自定义元素文档同时读取 Web Component 规范,区分元素 API 与原组件 API。
    • 新建组件库文档、维护组件外观说明或制作封面/展示墙时,读取组件预览规范,检查并按范围交付 assets/preview.html 及组件封面页入口。纯文案修订遵循该规范的范围边界。
  3. 阅读目标文档和核实本次说明所需的公开类型、入口或实现;新建或重构页面时再检查相关页面结构和必要参考,不发明 API。新增或修改布局类、示例容器类或可复制代码时,读取并执行 CSS utilities 核实流程。
  4. 优先沿用已有分类;否则按内容选择 lib/<name>/docs/lib/<basic|components|forms|helpers>/index.md。index.md 是默认主页面,仅在已有结构或用户明确要求时维护额外页面。
  5. 新建或重构文档时,第一屏提供可运行基础示例,再按实际 API 和请求范围补充场景、选项、事件、方法和类型;引入说明遵循接入与构建说明,只补充影响使用步骤的特殊条件。官网使用 <Example>、::: tabs、<Props> 与 <ZUI use="...">,不得混用调试页的 html:example;可运行示例按示例完整性与反馈补齐独立代码,并对齐预览的布局、配置和交互。
  6. 只修改正式文档及其明确需要的文档资源和回归测试;不得手工编辑 docs/_ 代替修改文档源,不得为了让文档成立而悄悄修改运行时代码。发现源码问题时单独报告。
  7. 按共享工作流选择必要的文案、链接或同步/构建检查;运行示例变更按示例验收核实预览与复制代码,静态组件预览变更执行组件预览规范。修复本次引入且位于范围内的问题并复验,生成物遵循验证隔离要求。
  8. 汇报目标页面、覆盖内容、验证结果与源码/文档差异,不自动提交。

组合边界

  • 独立调用且需求明确时不增加计划确认门禁。
  • 作为子流程时只处理共享范围内的本领域工作;上下文、任务范围及必要澄清统一遵循共享工作流。
  • 若用户只要求审阅或建议,保持只读。

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

Files

SKILL.md and 1 other file in .agents/skills/zui-doc of easysoft/zui.

  • SKILL.md
  • agents/openai.yaml

Open the folder on GitHubat commit 3b1d7da

Compare with similar skills

Zui Doc 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.

Zui Doc compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Zui Doc this skilleasysoft/zui2.8k—~380Automated 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.7k98 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 98 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 easysoft/zui

All 24 skills in this repo
  • Zui Build

    easysoft/zui

    使用内置 ZUI 资源从零创建可运行的独立网页或小型静态站点。向已有应用集成 ZUI 时使用 zui 技能. An agent skill from easysoft/zui.

    2.8k GitHub stars~1.4k tokensUpdated today
    Auto-check passed
  • Zui

    easysoft/zui

    在已有应用中集成、使用或排查 ZUI 3,直接创建和注册应用自定义组件,或使用已提供的 Web Components;适用于消费方项目,不用于开发 ZUI 源码仓库。

    2.8k GitHub stars~2.2k tokensUpdated today
    Auto-check passed
  • Zui Standards

    easysoft/zui

    查询 ZUI 主仓库的开发规范,为库开发及本地 exts 接入任务提供相关约束和仓库证据;规范查询保持只读. An agent skill from easysoft/zui.

    2.8k GitHub stars~452 tokensUpdated today
    Auto-check passed
  • Zuix Standards

    easysoft/zui

    查询独立 ZUI 扩展项目的开发规范,解析目标库、扩展工作区、Git 所有权及所需宿主上下文;始终只读. An agent skill from easysoft/zui.

    2.8k GitHub stars~403 tokensUpdated today
    Auto-check passed
  • Zui Wrap Lib

    easysoft/zui

    将已经可用的 UMD/IIFE 资源封装为 ZUI 主仓库的 lib/ 库,通过 LibLoader 按需加载。不转换资源格式,需求明确时形成集成计划后直接实施。

    2.8k GitHub stars~1k tokensUpdated today
    Auto-check passed
  • Zui Commit

    easysoft/zui

    审查并提交 ZUI 主仓库的改动;用户直接调用本技能即进入提交模式,必要检查通过后直接提交。只要求分析、评审或生成提交信息时保持只读。

    2.8k GitHub stars~1.5k tokensUpdated today
    Auto-check: notes

Questions about Zui Doc

What does Zui Doc do?

维护 ZUI 主仓库 lib/ 的官网文档源、API 说明、示例与静态组件预览。需求明确时直接实施;只要求审阅时保持只读。. Zui Doc is an agent skill from easysoft/zui.

When should I use Zui Doc?

Zui Doc fits situations like: frontend & Design work in your project.

How do I install Zui Doc in Claude Code?

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

How do I install Zui Doc in Codex?

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

Can I use Zui Doc 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 easysoft/zui --skill zui-doc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/zui-doc, .gemini/skills/zui-doc, .github/skills/zui-doc and .opencode/skills/zui-doc in your project.

What does Zui Doc need to run?

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

Does Zui Doc 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 Zui Doc 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 Zui Doc use?

Zui Doc 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 Zui Doc use?

About 380 tokens (SKILL.md is roughly 1.5k 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 Zui Doc?

Skills that share tags, products or a category with Zui Doc: 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 Zui Doc?

easysoft (a GitHub organization) maintains it in easysoft/zui, which has 2,765 GitHub stars. The repository holds 24 skills in this directory. The repository was last updated on October 8, 2026.

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