用途
pencil-skill-creator 是一个工厂型技能,用于创建新的 pencil-ui-design-system-* 技能。每个由它生成的技能负责在 Pencil 中初始化一个设计系统,包括变量(variables)与组件概览框架(component overview frames),并通过 PENCIL_PLAN 输出。
核心原则
由该创建器生成的所有设计系统技能必须遵循以下原则:
- 触发条件:当用户明确提到 Pencil 以及目标设计系统时触发(例如“init layui design system with Pencil”)。
- 动作级计划:输出一个 PENCIL_PLAN(第 1 步:set_variables;第 2 步:batch_design 组件概览)。不执行,只输出计划供 Agent 调用 Pencil MCP 工具。
- 自包含:技能封装来自官方设计系统文档的设计令牌(颜色、排版、圆角)与组件类别。
工作流(渐进式披露)
保持主文件简洁,需要完整细节时使用随附的参考文件:
- 工作流:references/workflows.md
- 输出模式:references/output-patterns.md
快速开始(自动创建)
选项 A:自动创建(推荐)
使用随附脚本自动生成技能结构、SKILL.md(含 Golden Template)以及 references/ 占位文件。
# Usage: ./scripts/init_pencil_design_system_skill.py <name> --path <skills-directory>
./scripts/init_pencil_design_system_skill.py layui --path skills/
该脚本将:
- 创建 skills/pencil-ui-design-system-layui。
- 用所需结构填充 SKILL.md(When to use、Step 1 Variables、Step 2 Component overview)。
- 创建 references/contract.md、references/official.md、references/examples.md 占位文件。
- 从现有技能复制 LICENSE.txt。
选项 B:手动创建
遵循 references/workflows.md -> Manual creation。
第 1 步:定义设计系统
- 确定框架并命名技能:pencil-ui-design-system-<name>(kebab-case)。
- 示例:“layui” -> pencil-ui-design-system-layui
- 示例:“uview pro” -> pencil-ui-design-system-uviewpro
第 2 步:创建目录结构
mkdir -p skills/pencil-ui-design-system-<name>/references
第 3 步:编写 SKILL.md(Golden Template)
新技能必须使用以下模板结构:
- Frontmatter:name: pencil-ui-design-system-{{name}},description 包含“初始化 {{design_system}}: design system components”。
- 约束:仅在用户明确提到 Pencil 或设计系统初始化时使用。
- When to use:触发关键词(例如 layui、antd)。
- Step 1: Variables:用于 set_variables 的变量表(颜色、字体、圆角)。遵循 .pen schema。
- Step 2: Component overview:通过 batch_design 创建的框架/类别列表(每个类别的组件类别与组件名称)。
- 最佳实践:对照官方文档验证令牌;除非完全重置,否则使用 replace: false;框架使用 Auto Layout。
- Keywords:pencil, design system, init。
第 4 步:填充 references
- references/contract.md:设计令牌与组件契约(前缀、命名)。
- references/official.md:官方文档链接。
- references/examples.md:示例 PENCIL_PLAN 或用法。
与 Pencil 路径的集成
该技能是 Pencil 规范流程的一部分:
- PRD -> pencil-ui-design-spec-generator 输出 PENCIL_PLAN。
- pencil-ui-design-system-* 技能为给定设计系统输出具体的变量与组件结构。
- Agent 按顺序调用 Pencil MCP 工具(open_document、set_variables、batch_design、get_screenshot)。
命名校验
脚本强制要求:pencil-ui-design-system-[a-z0-9]+(-[a-z0-9]+)*。
适用场景
当需要为新的设计系统(如 layui、antd、bootstrap、element、uview 等)添加 Pencil 支持时使用。
限制
资料未提供关于收费、价格、平台支持范围、具体效果或性能的说明,这些内容暂未提供。