# Zuix Doc > 维护独立 ZUI 扩展库的官网文档源、API 说明和示例，按需通过宿主验证。需求明确时直接实施；只要求审阅时保持只读。 - Skill: `easysoft/zuix-doc` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add easysoft/zuix-doc` - Raw SKILL.md: https://api.skillmd.com/api/skills/easysoft/zuix-doc/raw - Safety review: pending - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Integrations & APIs - Author: easysoft (https://skillmd.com/u/easysoft) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/easysoft/zuix-doc --- # ZUI 扩展库正式文档 ## 准备 按 [共享工作流](../zuix-standards/references/workflow.md) 解析本次所需上下文、读取适用规则并检查所有权；已有且未变化的发现直接复用。阅读 [文档规范](../zuix-standards/references/documentation.md) 中与本次修改有关的部分。 阅读目标文档和核实本次说明所需的公开类型、入口或实现。新建或重构页面时再检查相关结构和必要参考；同步、构建或浏览器验收需要已确认的宿主，不能猜测命令或文档组件语法。 ## 写作与实施 1. 按共享工作流先检查请求、已确认决定和目标现状，合理沿用既有约定；仅有无法可靠消除且会实质改变文档目标、公开契约或交付边界的歧义时询问，否则直接在本领域内实施，不增加确认门禁。 2. 以目标源码和实际导出为事实来源，不根据 `folderName`、`packageName` 或 `zuiName` 猜测 API。发现源码与预期冲突时单独报告，不为让文档成立越界修改运行时代码。 3. 优先沿用已有分类；否则根据当前宿主文档规范和目标角色选择 `targetLibRoot/docs/lib//index.md`。`index.md` 是默认主页面，仅在已有结构或用户明确要求时维护额外页面。 4. 新建或重构文档时，第一屏提供用途说明和可运行基础示例，随后按真实 API 和请求范围补充常用场景、options/props、事件、方法、类型、CSS 类/变量、引入方式、无障碍与限制；不保留空章节。 5. 官网示例严格使用当前 `zuiRoot` 提供的 ``、tabs、``、`` 等语法，不混用调试页 `html:example` fence。 6. 模块化示例使用真实 `packageName`。新增或改变全局成员、声明式创建和 `` 示例时，核实宿主构建实际提供的能力，不能仅凭源码导出或目录名推断；本次未改变的已验证用法可复用已有证据。 7. 文档资源保存在目标扩展库约定位置，引用路径根据当前宿主同步规则和实际 `publicPath` 验证。不要硬编码某个扩展品牌、组名或本机绝对路径。 8. 只修改 `targetLibRoot` 内正式文档及明确需要的文档资源。源码 lint、依赖与静态检查从 `extensionRoot` 执行；不得手工编辑宿主生成文档代替修改文档源，也不得修改宿主源码、package、lockfile 和注册配置；文档同步的生成物及缓存写入遵循共享工作流的验证隔离与批准规则。 ## 验证 按共享工作流选择本次所需的文案、链接、示例或同步/构建检查，完成范围内修复和复验。 新增或改变文档组件、交互示例、资源路径、导航或同步规则时，再通过已确认的宿主及注册组使用相应 prepare/build/dev 脚本；确认目标实际进入构建，不发明筛选参数。宿主写入、服务和隔离遵循共享工作流。交付区分源文件检查、宿主验证、基线失败和未验证项，不纳入生成目录。 ## 组合边界与交付 - 独立调用且需求明确时直接实施。 - 作为子流程时只处理共享范围内的本领域工作；上下文、批准和增量范围统一遵循共享工作流。 - 用户只要求审阅或建议时保持只读。 - 交付时汇报目标源页面、覆盖内容、四层上下文、扩展检查、宿主验证及源码/文档差异，不自动提交、推送或发布。