# @agile-team/wl-skills-design 中文文档

规范地址：https://npmcn.com/package/%40agile-team/wl-skills-design/

版本：1\.0\.2
npm 元数据更新时间：2026-10-15T14:02:44.341Z
中文译文更新时间：2026-11-08T10:29:54.454Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40agile-team/wl-skills-design
原文对照：https://npmcn.com/package/%40agile-team/wl-skills-design/?lang=original
项目主页：https://github.com/ChenyCHENYU/wl-skills-design#readme
源码仓库：https://github.com/ChenyCHENYU/wl-skills-design

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：909 kB，181 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- 首次发布：2026-05-25T02:48:15.072Z
- 最新版本发布：2026-10-15T14:02:44.061Z
- 近 30 天下载量：1800（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：32（近 12 个月 32 个）

## 中文简介

产品设计 AI 技能包 — 9 条设计规范、10 个 Skill、独立任务判定、Codex gateway、真实验证回执与可选设计模型

## 安装

```sh
npm install @agile-team/wl-skills-design
```

也可以使用：`pnpm add @agile-team/wl-skills-design`、`yarn add @agile-team/wl-skills-design`、`bun add @agile-team/wl-skills-design`

## README

![WL · World Leading · skills-design](https://raw.githubusercontent.com/ChenyCHENYU/wl-skills-design/main/assets/wl-design-logo.svg)

**把业务事实整理为相互对齐、可追溯、可机械校验的需求与设计交付物。**

[![npm](https://img.shields.io/npm/v/@agile-team/wl-skills-design?color=A45C2B)](https://www.npmjs.com/package/@agile-team/wl-skills-design) [![Node.js](https://img.shields.io/node/v/@agile-team/wl-skills-design)](https://nodejs.org/) [![License](https://img.shields.io/badge/license-Apache--2.0-64748b)](https://npmcn.com/package/%40agile-team/wl-skills-design/LICENSE)

[English](https://npmcn.com/package/%40agile-team/wl-skills-design/README.en.md)

**业务事实 → 流程与需求 → 数据库与接口 → 跨文档评审 → 修复复验 → 开发交接**

## 适用与能力

面向需求分析、产品设计、技术设计与设计评审。可从零开始，也可接收既有文档；独立使用，无需先安装其他 WL 包。当前项目范围护栏排除移动端。

| 设计任务 | 主要产物 | 检查重点 |
| --- | --- | --- |
| 梳理流程与页面 | draw.io 泳道图、原型标注 | 活动编码、角色、分支、布局和页面动作 |
| 编写需求说明书 | 分册说明书、按钮级 IPO 处理逻辑 | 输入输出、前置校验、状态变化与异常文案 |
| 设计数据库与接口 | ER、数据字典、DDL、接口定义 | 字段一致性、类型、索引、响应与错误码 |
| 接收半成品文档 | 差距报告、补全任务、待确认清单 | 结构缺口、术语与字典值漂移 |
| 评审与变更分析 | 问题清单、追溯矩阵、影响与复验顺序 | 需求、流程、数据、接口是否对应 |

规则包含 **\[M\] 机械检查**与 **\[J\] 语义判断**：CLI 执行已实现的机械项，Agent 辅助评审业务语义，负责人确认事实和交付结论。

## 三步接入

在**实际目标项目根目录**执行，需要 Node.js 20+。接入负责人配置一次，后续直接向已加载规则的 Agent 描述设计任务。

### 1\. 安装执行器与设计规则

```bash
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\. 核对接入结果

```bash
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 使用同一任务编号执行：

```bash
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 与执行边界](https://npmcn.com/package/%40agile-team/wl-skills-design/docs/public-api.md)。

流程图文字过长时，`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` |

安装、升级和恢复按本包归属管理文件，保留用户及其他包内容；本地改动默认受保护。评审和影响分析默认只读，修改既有业务设计须在授权范围内执行。

## 深入使用

-   [使用指南](https://npmcn.com/package/%40agile-team/wl-skills-design/files/.github/guides/usage.md)：创建、评审、修复与半成品接入。
-   [输入准备清单](https://npmcn.com/package/%40agile-team/wl-skills-design/files/.github/guides/inputs-checklist.md)：从最小输入逐步补齐业务和技术事实。
-   [设计模型](https://npmcn.com/package/%40agile-team/wl-skills-design/files/.github/guides/design-model.md)：需要跨文档稳定 ID 追溯时再启用。
-   [项目范围](https://npmcn.com/package/%40agile-team/wl-skills-design/docs/project-scope.md) · [公开 API](https://npmcn.com/package/%40agile-team/wl-skills-design/docs/public-api.md) · [维护契约](https://npmcn.com/package/%40agile-team/wl-skills-design/docs/maintenance-contract.md)。

## WL · World Leading

六个包按职责独立使用，按需要组合；Design 产物可作为开发和测试输入，不强制安装兄弟包。

| 包 | 职责 |
| --- | --- |
| [skills-gate](https://github.com/ChenyCHENYU/wl-skills-gate) | 项目钩子、构建门禁与质量闭环编排 |
| [skills-kit](https://github.com/ChenyCHENYU/wl-skills-kit) | PC Vue 管理端开发规范与工程约束 |
| [skills-ui](https://github.com/ChenyCHENYU/wl-skills-ui) | 界面规范、布局与交互质量 |
| [skills-bd](https://github.com/ChenyCHENYU/wl-skills-bd) | Java 后端规范、契约与校验 |
| [skills-test](https://github.com/ChenyCHENYU/wl-skills-test) | 测试设计、执行、质量证据与交付 |
| **skills-design** | 需求、流程、数据库与接口设计 |

[Apache-2.0](https://npmcn.com/package/%40agile-team/wl-skills-design/LICENSE)

## 常见问题

### @agile-team/wl-skills-design 是什么？

产品设计 AI 技能包 — 9 条设计规范、10 个 Skill、独立任务判定、Codex gateway、真实验证回执与可选设计模型

### 如何安装 @agile-team/wl-skills-design？

在项目目录运行 npm install @agile-team/wl-skills-design，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 wl-skills-design，可以用 npx wl-skills-design 直接运行。

### @agile-team/wl-skills-design 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/agile-team\_\_wl-skills-design 是否存在。

### @agile-team/wl-skills-design 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @agile-team/wl-skills-design 可以商用吗？

@agile-team/wl-skills-design 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @agile-team/wl-skills-design 的下载量有多少？

根据 npm 官方下载统计，@agile-team/wl-skills-design 在 2026/10/05 – 2026/11/03 这 30 天内被下载 1,800 次，日均约 60 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @agile-team/wl-skills-design 还在维护吗？

最新版本 1\.0\.2 发布于 2026/10/15（23 天前）；至今共发布 32 个版本，其中过去 12 个月发布了 32 个；首次发布于 2026/05/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

