把业务事实整理为相互对齐、可追溯、可机械校验的需求与设计交付物。
业务事实 → 流程与需求 → 数据库与接口 → 跨文档评审 → 修复复验 → 开发交接
适用与能力
面向需求分析、产品设计、技术设计与设计评审。可从零开始,也可接收既有文档;独立使用,无需先安装其他 WL 包。当前项目范围护栏排除移动端。
| 设计任务 | 主要产物 | 检查重点 |
|---|---|---|
| 梳理流程与页面 | draw.io 泳道图、原型标注 | 活动编码、角色、分支、布局和页面动作 |
| 编写需求说明书 | 分册说明书、按钮级 IPO 处理逻辑 | 输入输出、前置校验、状态变化与异常文案 |
| 设计数据库与接口 | ER、数据字典、DDL、接口定义 | 字段一致性、类型、索引、响应与错误码 |
| 接收半成品文档 | 差距报告、补全任务、待确认清单 | 结构缺口、术语与字典值漂移 |
| 评审与变更分析 | 问题清单、追溯矩阵、影响与复验顺序 | 需求、流程、数据、接口是否对应 |
规则包含 [M] 机械检查与 [J] 语义判断:CLI 执行已实现的机械项,Agent 辅助评审业务语义,负责人确认事实和交付结论。
三步接入
在实际目标项目根目录执行,需要 Node.js 20+。接入负责人配置一次,后续直接向已加载规则的 Agent 描述设计任务。
1. 安装执行器与设计规则
npm install -D @agile-team/wl-skills-design
npx --no-install wl-skills-design init
默认使用 AGENTS.md 通用入口,Codex 原生入口位于 .agents/skills/wl-skills-design/SKILL.md。使用 Cursor 时,在 init 后加 --editor cursor;其他编辑器选项见 --help。
纯文档仓库也可用 npx @agile-team/wl-skills-design init 分发规则;持续校验与 CI 建议固定项目依赖和锁文件。
2. 核对接入结果
npx --no-install wl-skills-design doctor
npx --no-install wl-skills-design doctor-host --host codex --json
doctor 检查安装与 Skill 清单;doctor-host 检查入口和版本是否对齐。编辑器刷新规则后,还需在一次真实任务中看到工具判定和检查结果。
3. 给出一条具体任务
为 DEMO 设备点检模块生成需求说明书骨架。范围是点检单录入到归档,不含维修派工;目标是记录数字化、异常可追溯。先列缺失事实,再展开流程和按钮级 IPO。
最少给出项目代号、模块范围、业务目标就能起步。岗位、对象、状态、操作规则和技术画像逐步补齐;缺失业务事实标记“待补充”,不会靠猜测填完整。
首次反馈应包含适用 Skill / 规则、目标、runId 和待检查项。安装完成只说明资产已分发,真实任务反馈才能用于确认本次是否调用了工具。
一个场景:点检流程变更如何传到接口
“确认点检单”增加前置条件后,需要同时更新流程、按钮处理、状态字段和接口约束。
| 环节 | 如何处理 | 验收点 |
|---|---|---|
| 先看影响 | 对 Agent 说“分析确认条件变化影响哪些设计文件” | 列出受影响文档、待确认事实和复验顺序 |
| 确认后修改 | 授权后补齐流程 / IPO / 数据 / 接口 | 使用相同业务编码、状态值与错误文案 |
| 脚本复验 | 分域运行 verify | 返回规则编号、实际检查文件和问题位置 |
| 跨文档评审 | 检查业务含义与追溯关系,回查 status | 机械问题、语义问题、未覆盖项分别列明 |
例如,复核已存在的接口文档,由 Agent 或 CI 使用同一任务编号执行:
npx --no-install wl-skills-design task --input "检查接口设计结构" --file docs/api/01-inspection.md --run-id inspection-review --json
npx --no-install wl-skills-design verify api --file docs/api/01-inspection.md --run-id inspection-review --json
npx --no-install wl-skills-design status --run-id inspection-review --json
授权修复后,用同一 runId 更新任务计划并再验,避免沿用修改前的检查结论。status 显示执行状态、检查范围、失效证据和待检查项;机械项通过仍可能是 partial,业务语义与最终图形渲染需要继续复核。
校验入口
| 产物 | 命令 |
|---|---|
| 需求说明书 | npx --no-install wl-skills-design verify spec --target . |
| 泳道流程图 | npx --no-install wl-skills-design verify flowchart --file docs/flowchart/input.drawio |
| 数据库设计 | npx --no-install wl-skills-design verify db --target . |
| 接口设计 | npx --no-install wl-skills-design verify api --target . |
| 可选设计模型 | npx --no-install wl-skills-design validate-model --model docs/design-model.json |
指定 --file 只检查该文件或目录,不借其他文件判通过。CI 调用同一 CLI,并归档输出与本次回执;跨文档评审不能被单文件检查替代。完整机械覆盖、未实现项和公开集成协议见公开 API 与执行边界。
流程图文字过长时,layout-flowchart --file <原图> --output <新图> --dry-run 可预览自适应布局;正式执行输出新文件,随后运行流程图验证并检查实际渲染。
常用维护
| 需要做什么 | 命令 |
|---|---|
| 查看受管文件与本地改动 | npx --no-install wl-skills-design status |
| 预检规则升级 | npx --no-install wl-skills-design update --dry-run |
| 对齐执行器与规则 | 更新依赖和锁文件,审阅后执行 update |
| 查看可恢复快照 | npx --no-install wl-skills-design restore --list |
| 预览卸载 | npx --no-install wl-skills-design uninstall --dry-run |
安装、升级和恢复按本包归属管理文件,保留用户及其他包内容;本地改动默认受保护。评审和影响分析默认只读,修改既有业务设计须在授权范围内执行。
深入使用
WL · World Leading
六个包按职责独立使用,按需要组合;Design 产物可作为开发和测试输入,不强制安装兄弟包。
| 包 | 职责 |
|---|---|
| skills-gate | 项目钩子、构建门禁与质量闭环编排 |
| skills-kit | PC Vue 管理端开发规范与工程约束 |
| skills-ui | 界面规范、布局与交互质量 |
| skills-bd | Java 后端规范、契约与校验 |
| skills-test | 测试设计、执行、质量证据与交付 |
| skills-design | 需求、流程、数据库与接口设计 |