Zui Doc

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

easysoft 2135ef6 2 files · 2.3 KB Updated

File contents

ZUI 正式文档

工作流

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

组合边界

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

easysoft/zui/tree/main/.agents/skills/zui-doc commit 2135ef6481

Frequently asked questions

npx skillmds@latest add easysoft/zui-doc