SuperAPI AI 工具集

pattern-documentation

设计与创作

查看项目

更新于 10-16 01:31

技能介绍

用途:为设计系统编写多组件模式的文档。模式区别于组件,是由多个组件组合、解决特定用户或产品问题的反复出现的方案,如表单校验、空状态、错误处理、渐进披露。

主要能力与流程:先做模式发现,判断是否值得记录(需出现在三个以上不同产品语境、解决用户问题、由两个以上组件构成、团队独立收敛出相似方案、做错有真实后果);不合格则说明原因并改建议写组件用法指南、局部约定或其他内容。随后确认模式范围(名称、用户问题、涉及组件、使用语境、边界情形),名称应描述交互或功能而非视觉。再按结构撰写文档:模式做什么、何时使用、何时不使用(须给出替代方案)、组成(必需与可选组件、结构关系、布局间距、响应式与变体)、工作方式(五到八步交互)、状态覆盖(默认、加载、空、填充、错误、成功、禁用、部分完成,并用表格列出状态转换)、无障碍(键盘流、焦点管理、屏幕阅读器播报、组合层 ARIA)、文案(如适用)、反模式(三到五条,须针对本模式)、相关模式(含易混淆项)、生产实例(按路径或 URL 或用户命名)、参考实现、证据(无则写“暂无证据”)。完成后检查缺口,并在聊天中给出标题、保存路径、标注为“提议”的内容与检索范围。

关键要求:所有产品语境、实例、状态与无障碍行为均须有来源并注明路径或 URL,未观察到的规则标为“提议”,不得编造产品或团队名称。若前置引用缺失,应停止并提示按 1-INSTALL.md 重新安装并运行 verify-install.sh,除非用户明确要求继续,此时须在输出中说明未使用参考材料。

限制:本资料未提供具体收费、价格、平台支持或效果数据;使用前需确认技能安装完整。