adspecs 0.1.19 → 0.1.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/.adspecs/feature.json +16 -16
  2. package/.adspecs/feature.yml +28 -28
  3. package/.adspecs/paths.json +17 -17
  4. package/.adspecs/templates/04-/345/211/215/347/253/257/345/212/237/350/203/275/350/256/276/350/256/241/346/250/241/346/235/277.md +1 -1
  5. package/.adspecs/templates/05-/345/220/216/347/253/257/344/273/273/345/212/241/346/270/205/345/215/225/346/250/241/346/235/277.md +613 -724
  6. package/.adspecs/templates/05b-/345/211/215/347/253/257/344/273/273/345/212/241/346/270/205/345/215/225/346/250/241/346/235/277.md +51 -51
  7. package/.claude-plugin/marketplace.json +23 -23
  8. package/.claude-plugin/plugin.json +18 -18
  9. package/.qoder-plugin/plugin.json +31 -31
  10. package/CLAUDE.md +1 -5
  11. package/INSTALL.md +3 -3
  12. package/README.md +395 -395
  13. package/bin/adspecs.js +129 -129
  14. package/hooks/commit-queue.js +245 -245
  15. package/hooks/hooks.json +63 -63
  16. package/hooks/session-start.js +44 -44
  17. package/hooks/wiki-queue.js +127 -127
  18. package/package.json +61 -61
  19. package/references/ant6-front-standard/index.md +99 -99
  20. package/references/antd-front-demo/public/mockServiceWorker.js +361 -361
  21. package/references/ecp-end-standard/index.md +63 -63
  22. package/references/python-end-standard/01-Python/345/220/216/347/253/257/347/274/226/347/240/201/350/247/204/350/214/203.md +372 -372
  23. package/references/python-end-standard/02-/346/225/260/346/215/256/345/272/223/350/256/276/350/256/241/344/270/216/344/275/277/347/224/250/350/247/204/350/214/203.md +226 -226
  24. package/references/python-end-standard/03-Celery/345/274/202/346/255/245/344/273/273/345/212/241/350/247/204/350/214/203.md +237 -237
  25. package/references/python-end-standard/04-Redis/344/275/277/347/224/250/350/247/204/350/214/203.md +231 -231
  26. package/scripts/postinstall.js +107 -107
  27. package/scripts/sync-version.js +105 -105
  28. package/skills/.claude/.wiki-update-queue +26 -26
  29. package/skills/adspecs-constitution/SKILL.md +157 -0
  30. package/skills/adspecs-export-word/SKILL.md +498 -498
  31. package/skills/adspecs-export-word/references/md-to-docx.js +862 -862
  32. package/skills/adspecs-export-word/references/package-lock.json +220 -220
  33. package/skills/adspecs-export-word/references/package.json +10 -10
  34. package/skills/adspecs-front-prototype/SKILL.md +405 -405
  35. package/skills/adspecs-front-spec/SKILL.md +4 -4
  36. package/skills/adspecs-front-tasks/SKILL.md +213 -173
  37. package/skills/adspecs-plan/SKILL.md +59 -69
  38. package/skills/adspecs-prd/SKILL.md +13 -5
  39. package/skills/adspecs-prd-to-demo/SKILL.md +532 -0
  40. package/skills/adspecs-tasks/SKILL.md +175 -204
  41. package/skills/adspecs-update-status/SKILL.md +382 -382
  42. package/skills/adspecs-utest/SKILL.md +107 -116
  43. package/skills/grill-me/SKILL.md +7 -0
  44. package/skills/grill-me/agents/openai.yaml +5 -0
  45. package/skills/playwright-cli/SKILL.md +420 -0
  46. package/skills/playwright-cli/references/element-attributes.md +23 -0
  47. package/skills/playwright-cli/references/playwright-tests.md +39 -0
  48. package/skills/playwright-cli/references/request-mocking.md +87 -0
  49. package/skills/playwright-cli/references/running-code.md +241 -0
  50. package/skills/playwright-cli/references/session-management.md +225 -0
  51. package/skills/playwright-cli/references/storage-state.md +275 -0
  52. package/skills/playwright-cli/references/test-generation.md +433 -0
  53. package/skills/playwright-cli/references/tracing.md +139 -0
  54. package/skills/playwright-cli/references/video-recording.md +143 -0
  55. package/skills/playwright-trace/SKILL.md +171 -0
  56. package/skills/project-init/SKILL.md +93 -22
  57. package/skills/project-init/references/front-demo/.claude/settings.local.json +9 -0
  58. package/skills/wiki-update/SKILL.md +232 -232
  59. package/src/commands/doctor.js +197 -197
  60. package/src/commands/init.js +83 -83
  61. package/src/commands/plugin.js +165 -165
  62. package/src/commands/update.js +87 -87
  63. package/src/lib/area-scanner.js +129 -129
  64. package/src/lib/copier.js +104 -104
  65. package/src/lib/dir-utils.js +161 -133
  66. package/src/lib/json-merge.js +114 -114
  67. package/src/lib/paths-defaults.js +37 -37
  68. package/src/lib/prompts.js +428 -347
  69. package/src/lib/readme-gen.js +143 -143
  70. package/src/lib/report.js +338 -327
  71. package/src/lib/scaffolder.js +551 -518
  72. package/src/lib/short-name.js +36 -36
  73. package/src/utils.js +80 -80
  74. package/references/antd-front-demo/.env +0 -15
package/README.md CHANGED
@@ -1,395 +1,395 @@
1
- # AdSpecs — AI 工程研发协同插件
2
-
3
- [![npm version](https://img.shields.io/npm/v/adspecs)](https://www.npmjs.com/package/adspecs)
4
- [![npm downloads](https://img.shields.io/npm/dt/adspecs)](https://www.npmjs.com/package/adspecs)
5
-
6
- ---
7
-
8
- ## 简介
9
-
10
- AdSpecs 是一个基于 Claude Code 的 AI 工程研发协同插件,提供:
11
-
12
- - **21 个 Skill**(Slash 命令) — 覆盖需求分析、架构规划、系统设计、任务拆解、单元测试、代码审查、文档导出、Wiki 同步
13
- - **CLI 工具** — `adspecs init` 一键脚手架、`adspecs plugin install` 插件注册、`adspecs doctor` 环境检查
14
- - **21 个标准文档模板** — 需求 / 设计 / 任务 / 测试 / 评审 / 架构全覆盖
15
- - **多技术栈参考** — ECP Java 后端、Vue 3 前端、Ant Design React 前端、Python 后端等 11 套参考工程
16
- - **npm 分发** — `npm install -g adspecs` 即装即用
17
-
18
- 本插件需配合 [`superpowers`](https://github.com/anthropics/claude-plugins-official) 插件(提供 TDD、子代理驱动开发等通用 Skill)一起使用。
19
-
20
- ---
21
-
22
- ## 项目结构
23
-
24
- ```
25
- adspecs/
26
- ├── bin/adspecs.js # CLI 入口
27
- ├── src/ # CLI 核心代码
28
- │ ├── commands/ # init / plugin / doctor / update
29
- │ └── lib/ # scaffolder / prompts / report 等
30
- ├── skills/ # 21 个 Skill 定义
31
- ├── .claude-plugin/ # Claude Code 插件清单
32
- ├── .qoder-plugin/ # Qoder 插件清单
33
- ├── .adspecs/
34
- │ ├── templates/ # 21 个标准文档模板
35
- │ ├── extensions/ # 扩展配置(git hooks 等)
36
- │ ├── scripts/ # 辅助脚本(bash/powershell/python)
37
- │ ├── feature.json # 功能追踪模板
38
- │ └── project.json # 项目元数据模板
39
- ├── hooks/ # Node.js 钩子脚本
40
- ├── references/ # 11 套参考工程与编码规范
41
- ├── scripts/ # 构建脚本(postinstall/sync-version)
42
- ├── package.json
43
- ├── CLAUDE.md
44
- ├── INSTALL.md
45
- └── README.md
46
- ```
47
-
48
- ---
49
-
50
- ## 快速开始
51
-
52
- ### 1. 安装
53
-
54
- ```bash
55
- # 全局安装 CLI
56
- npm install -g adspecs
57
-
58
- # 在 Claude Code 中注册插件(用户级,全局生效)
59
- adspecs plugin install
60
-
61
- # 或仅注册到当前项目(团队级)
62
- cd your-project
63
- adspecs plugin install --scope project
64
- ```
65
-
66
- ### 2. 初始化项目
67
-
68
- ```bash
69
- # 交互式初始化
70
- adspecs init
71
- ```
72
-
73
- ### 3. 开始使用 Skill
74
-
75
- ```
76
- /adspecs-new-requirement CRM 销售预测模块
77
- /adspecs-prd docs/00-customer-requirements/...
78
- /adspecs-plan docs/20-prd/crm/...
79
- ...
80
- ```
81
-
82
- ---
83
-
84
- ## CLI 工具
85
-
86
- 安装后提供 `adspecs` 命令行工具:
87
-
88
- | 命令 | 说明 | 示例 |
89
- | -------------------------- | ----------------------------------------------------- | ---------------------------------------- |
90
- | `adspecs init` | 交互式初始化项目结构(docs/、templates/、前端模板等) | `adspecs init --mode simple` |
91
- | `adspecs plugin install` | 注册为 Claude Code 插件 | `adspecs plugin install --scope project` |
92
- | `adspecs plugin uninstall` | 从 Claude Code 卸载插件 | `adspecs plugin uninstall --scope user` |
93
- | `adspecs doctor` | 检查环境依赖(Node.js、git、Python 等) | `adspecs doctor` |
94
- | `adspecs update` | 升级到最新版本 | `adspecs update --version 0.2.0` |
95
-
96
- ### `adspecs init` 参数
97
-
98
- | 参数 | 说明 | 默认值 |
99
- | --------------------------- | ----------------------------------------------------- | ---------- |
100
- | `--project-name <name>` | 项目名称 | 交互输入 |
101
- | `--project-dir <dir>` | 项目目录(留空=当前目录) | 当前目录 |
102
- | `--mode <mode>` | 初始化模式:`simple` \| `classic` \| `full` \| `demo` | 交互选择 |
103
- | `--front-demo <stack>` | 前端演示技术栈:`vue` \| `antd` | `vue` |
104
- | `--company <name>` | 公司名称 | — |
105
- | `--confidentiality <level>` | 文件密级:`公开` \| `内部资料` \| `机密` \| `绝密` | `内部资料` |
106
- | `--modules <list>` | 后端模块列表(逗号分隔) | — |
107
- | `--non-interactive` | 非交互模式,使用默认值 | — |
108
- | `--force` | 已存在区域直接重建 | — |
109
- | `-y, --yes` | 自动确认执行 | — |
110
-
111
- ---
112
-
113
- ## Skills 总览(21 个)
114
-
115
- 按职责分为六类:
116
-
117
- ### 一、项目初始化(CLI 命令)
118
-
119
- | 命令 | 说明 |
120
- | -------------- | ------------------------------------------------------------------------------ |
121
- | `adspecs init` | 交互式初始化项目结构:`docs/` 文档树、前端模板、后端模块、编码规范、标准模板等 |
122
-
123
- 初始化后生成:
124
-
125
- - `docs/10-architecture/` — 架构规划
126
- - `docs/20-prd/` — 产品需求说明书
127
- - `docs/30-system-design/` — 系统设计 + SQL + 前端设计 + 任务清单
128
- - `docs/40-project_conventions/` — 编码规范
129
- - `.adspecs/templates/` — 21 个标准模板
130
- - `.adspecs/paths.json` — 可自定义的输出路径配置
131
-
132
- ### 二、需求分析与架构规划(5 个)
133
-
134
- | Skill | 说明 | 输入 | 输出 |
135
- | ------------------------------- | ------------------------------------------------ | ------------------- | -------------------------------- |
136
- | `adspecs-new-requirement` | 深度业务需求分析(六步结构 + 模拟评审) | 业务需求描述 | `docs/00-customer-requirements/` |
137
- | `adspecs-biz-blueprint` | 将需求分析转化为 F1~F6 业务方案文件体系 | 业务需求分析文档 | `docs/00-customer-requirements/` |
138
- | `adspecs-prd` | 从自然语言 / 调研材料生成 PRD | 调研材料 / 原始需求 | `docs/20-prd/` |
139
- | `adspecs-clarify` | 识别 PRD 模糊点(≤5 个)并澄清 | 需求规格说明书 | 更新后的规格说明书 |
140
- | `adspecs-architecture-planning` | 平台级架构规划(功能架构 → 模块依赖 → 数据建模) | 项目 / 业务描述 | `docs/10-architecture/` |
141
-
142
- ### 三、SOW / 设计 / 任务(5 个)
143
-
144
- | Skill | 说明 | 输入 | 输出 |
145
- | --------------------- | ------------------------------------- | --------------- | ------------------------------------- |
146
- | `adspecs-write-sow` | 根据项目 / 合同信息生成工作说明书 | 项目 / 合同信息 | `docs/05-sow/` |
147
- | `adspecs-plan` | 后端统一系统设计(OOA+OOD)+ 建表 SQL | PRD | `docs/30-system-design/` design + SQL |
148
- | `adspecs-front-spec` | 前端功能设计(UI/交互规格) | PRD + 系统设计 | `docs/30-system-design/` 前端设计 |
149
- | `adspecs-tasks` | 后端 TDD 任务清单 | 系统设计文档 | `docs/30-system-design/` tasks.md |
150
- | `adspecs-front-tasks` | 前端 TDD 任务清单 | 前端设计文档 | `docs/30-system-design/` tasks.md |
151
-
152
- ### 四、质量保障与测试(3 个)
153
-
154
- | Skill | 说明 |
155
- | ---------------------------- | ------------------------------------------------------------------- |
156
- | `adspecs-analyze` | 跨文档(PRD / 系统设计 / tasks)全链路 13 维一致性分析 |
157
- | `adspecs-adversarial-review` | 对抗式审查:5 个红队角色挑战文档假设、缺失、矛盾与歧义 |
158
- | `adspecs-utest` | 基于系统设计生成 Service / Controller 层 JUnit 5 单元测试代码及报告 |
159
-
160
- ### 五、交付与运维(5 个)
161
-
162
- | Skill | 说明 |
163
- | ----------------------- | -------------------------------------------------- |
164
- | `adspecs-update-status` | 更新 feature.json 功能状态 + 输出追踪矩阵 |
165
- | `adspecs-export-word` | Markdown 导出为 Word(.docx),自动生成封面 + 目录 |
166
- | `adspecs-git-commit` | 各阶段完成后自动提交变更 |
167
- | `sie-front-code-review` | 前端专项评审(React + TypeScript + Ant Design) |
168
- | `wiki-update` | 将 docs/ 同步到 wiki/(全量 / 增量模式) |
169
-
170
- ### 六、产品规划(2 个)
171
-
172
- | Skill | 说明 |
173
- | ------------------------------- | ------------------------------------ |
174
- | `adspecs-write-planning-report` | 汇总调研期分析输出,生成产品规划报告 |
175
- | `adspecs-write-roadmap` | 版本路标维护,追写 roadmap.md |
176
-
177
- ### 编码阶段依赖(superpowers 插件)
178
-
179
- | 外部 Skill | 说明 |
180
- | -------------------------------- | -------------------------------- |
181
- | `subagent-driven-development` | 子代理驱动并行开发 |
182
- | `test-driven-development` | RED → GREEN → REFACTOR TDD 循环 |
183
- | `dispatching-parallel-agents` | 并行子代理调度 |
184
- | `finishing-a-development-branch` | 分支收尾(PR / merge / cleanup) |
185
- | `verification-before-completion` | 完成前最终验证 |
186
-
187
- ---
188
-
189
- ## 模板体系(21 个)
190
-
191
- 初始化后位于 `.adspecs/templates/`:
192
-
193
- | 模板 | 用途 | 阶段 |
194
- | ---------------------------- | --------------------------- | ---- |
195
- | `01-业务需求分析模板.md` | 业务需求分析(六步结构) | 需求 |
196
- | `02-产品需求说明书模板.md` | 产品需求说明书(PRD) | 需求 |
197
- | `03-系统设计模板.md` | 后端统一系统设计(OOA+OOD) | 设计 |
198
- | `04-前端功能设计模板.md` | 前端功能规格(UI/交互) | 设计 |
199
- | `05-后端任务清单模板.md` | 后端 TDD 任务清单 | 任务 |
200
- | `05b-前端任务清单模板.md` | 前端 TDD 任务清单 | 任务 |
201
- | `06-代码评审报告模板.md` | 代码评审报告 | 审查 |
202
- | `07-单元测试报告模板.md` | 单元测试报告 | 测试 |
203
- | `08-系统集成测试报告模板.md` | 集成测试报告 | 测试 |
204
- | `09-性能测试报告模板.md` | 性能测试报告 | 测试 |
205
- | `10-安全检查清单.md` | 安全检查清单 | 审查 |
206
- | `11-代码质量标准.md` | 代码质量标准 | 审查 |
207
- | `13-测试用例模板.md` | 测试用例 | 测试 |
208
- | `14-需求追溯矩阵模板.md` | 需求 → 实现追溯矩阵 | 审查 |
209
- | `15-业务功能架构文档模板.md` | 业务功能架构规划 | 架构 |
210
- | `16-系统架构设计模板.md` | 系统架构设计 | 架构 |
211
- | `17-子模块依赖关系模板.md` | 子模块依赖关系 | 架构 |
212
- | `18-统一数据模型模板.md` | 统一数据建模(含 ER 图) | 架构 |
213
- | `19-项目目录结构模板.md` | 项目目录结构规划 | 架构 |
214
- | `20-工作说明书SOW模板.md` | 工作说明书(SOW) | 需求 |
215
- | `21-业务方案模板.md` | 业务方案(F1~F6 文件体系) | 需求 |
216
-
217
- > **约定**:所有模板通过对应 Skill 调用生成,不建议直接手工填写。
218
-
219
- ---
220
-
221
- ## 参考工程(11 套)
222
-
223
- `references/` 目录包含 `adspecs init` 时按需复制到目标项目的参考代码和规范:
224
-
225
- | 目录 | 说明 |
226
- | ------------------------------ | ---------------------------------------------- |
227
- | `docs/40-project_conventions/` | ECP 编码标准(后端 Java + 前端集成) |
228
- | `front-demo/` | Vue 3 前端演示项目(Vite + TS + Element Plus) |
229
- | `antd-front-demo/` | Ant Design React 前端演示项目 |
230
- | `ant6-front-standard/` | Ant Design 6 前端编码规范(9 篇) |
231
- | `ecp-end-standard/` | ECP 后端编码规范 |
232
- | `ecp-front-standard/` | ECP 前端编码规范 |
233
- | `iidp-end-standard/` | IIDP 后端编码规范 |
234
- | `iidp-front-standard/` | IIDP 前端编码规范 |
235
- | `web-ui/` | ECP 管理控制台外壳工程 |
236
- | `python/` | Python 后端参考 |
237
- | `yudaocloud-end-standard/` | 芋道 Cloud 后端集成参考 |
238
-
239
- ---
240
-
241
- ## 推荐开发流程
242
-
243
- ```
244
- [adspecs init] → 项目脚手架
245
-
246
- [adspecs-architecture-planning] → 平台架构规划(功能架构→依赖→数据模型)
247
-
248
- [adspecs-new-requirement] → 深度业务需求分析
249
-
250
- [adspecs-biz-blueprint] → 业务方案(F1~F6 文件体系)
251
-
252
- [adspecs-prd + adspecs-clarify] → 产品需求说明书 + 澄清迭代
253
-
254
- [adspecs-plan / adspecs-front-spec] → 后端设计+SQL / 前端设计
255
-
256
- [adspecs-tasks / adspecs-front-tasks] → 后端 / 前端 TDD 任务清单
257
-
258
- [adspecs-analyze + adversarial-review]→ 一致性与质量审查
259
-
260
- [TDD + subagent-driven-development] → 编码实现(依赖 superpowers)
261
-
262
- [adspecs-utest] → 单元测试 + 报告
263
-
264
- [sie-front-code-review] → 前端代码审查
265
-
266
- [adspecs-update-status] → 功能状态追踪
267
-
268
- [adspecs-export-word / wiki-update] → 文档导出 + Wiki 同步
269
- ```
270
-
271
- ### 完整示例:销售预测从零到交付
272
-
273
- ```txt
274
- # 1. 初始化项目
275
- adspecs init --project-name my-crm --mode classic
276
-
277
- # 2. 平台架构规划
278
- /adspecs-architecture-planning 华峰铝业CRM,覆盖销售全生命周期
279
-
280
- # 3. 深度需求分析
281
- /adspecs-new-requirement CRM 销售预测模块
282
-
283
- # 4. 业务方案
284
- /adspecs-biz-blueprint docs/00-customer-requirements/...
285
-
286
- # 5. 生成 PRD
287
- /adspecs-prd 预测单需求调研.md
288
-
289
- # 6. 澄清 + 评审(2~3 轮)
290
- /adspecs-clarify docs/20-prd/crm/sales-forecast/M06-01_销售预测需求规格说明书.md
291
-
292
- # 7. 后端系统设计 + SQL
293
- /adspecs-plan docs/20-prd/crm/sales-forecast/M06-01_销售预测需求规格说明书.md
294
-
295
- # 8. 前端设计
296
- /adspecs-front-spec docs/20-prd/crm/sales-forecast/M06-01_销售预测需求规格说明书.md
297
-
298
- # 9. 生成任务清单
299
- /adspecs-tasks docs/30-system-design/crm/M06-01-销售预测_system-design.md
300
- /adspecs-front-tasks docs/30-system-design/crm/M06-01_销售预测_前端设计.md
301
-
302
- # 10. 一致性与对抗审查
303
- /adspecs-analyze docs/20-prd/... docs/30-system-design/...
304
- /adspecs-adversarial-review M06-01_*.md
305
-
306
- # 11. 编码实现(TDD)
307
- /subagent-driven-development
308
-
309
- # 12. 单元测试 + 审查
310
- /adspecs-utest docs/30-system-design/crm/M06-01-销售预测_system-design.md
311
- /sie-front-code-review
312
-
313
- # 13. 状态追踪 + 导出
314
- /adspecs-update-status
315
- /adspecs-export-word docs/30-system-design/
316
- /wiki-update
317
- ```
318
-
319
- ---
320
-
321
- ## 路径配置
322
-
323
- Skill 支持通过 `.adspecs/paths.json` 自定义输出目录:
324
-
325
- ```json
326
- {
327
- "paths": {
328
- "biz_analysis_dir": "docs/00-customer-requirements",
329
- "architecture_dir": "docs/10-architecture",
330
- "prd_dir": "docs/20-prd",
331
- "design_dir": "docs/30-system-design",
332
- "test_report_dir": "docs/80-development",
333
- "export_dir": "docs/90-export",
334
- "wiki_dir": "wiki"
335
- }
336
- }
337
- ```
338
-
339
- `adspecs init` 自动生成此文件,可直接编辑修改。
340
-
341
- ---
342
-
343
- ## 安装与升级
344
-
345
- 详细安装说明见 [INSTALL.md](./INSTALL.md)。
346
-
347
- ```bash
348
- # 安装
349
- npm install -g adspecs
350
- adspecs plugin install # 用户级(默认)
351
- adspecs plugin install --scope project # 项目级
352
-
353
- # 升级
354
- npm install -g adspecs@latest
355
-
356
- # 卸载
357
- adspecs plugin uninstall --scope user
358
- adspecs plugin uninstall --scope project
359
- ```
360
-
361
- ---
362
-
363
- ## 常见问题
364
-
365
- **Q1:adspecs 与 superpowers 的关系?**
366
- adspecs 提供领域专属 Skill(需求、设计、模板、规范),superpowers 提供通用 AI 工程 Skill(TDD、子代理、调试)。两者分工协作,**编码阶段必须同时安装**。
367
-
368
- **Q2:用户级和项目级安装可以共存吗?**
369
- 可以,项目级优先于用户级(就近原则)。个人开发选用户级,团队协作选项目级。
370
-
371
- **Q3:安装后 Skill 未生效?**
372
- 1. 执行 `/plugins` 查看 adspecs 是否在已加载列表
373
- 2. 重启 Claude Code
374
- 3. 检查安装 scope 对应的目录是否存在
375
-
376
- **Q4:如何升级?**
377
- ```bash
378
- npm install -g adspecs@latest
379
- # 插件注册无需重新执行,Skill 定义随 npm 包更新
380
- ```
381
-
382
- **Q5:前端测试框架?**
383
- Vue 项目使用 Vitest + @vue/test-utils;React 项目使用 Jest + React Testing Library。
384
-
385
- **Q6:init 模式区别?**
386
- - `simple`:仅 docs + wiki
387
- - `classic`:+ front-demo(默认)
388
- - `full`:所有目录 + 参考工程
389
- - `demo`:Python+SQLite+React+AntD6 全栈 demo
390
-
391
- ---
392
-
393
- ## License
394
-
395
- [Apache-2.0](./LICENSE)
1
+ # AdSpecs — AI 工程研发协同插件
2
+
3
+ [![npm version](https://img.shields.io/npm/v/adspecs)](https://www.npmjs.com/package/adspecs)
4
+ [![npm downloads](https://img.shields.io/npm/dt/adspecs)](https://www.npmjs.com/package/adspecs)
5
+
6
+ ---
7
+
8
+ ## 简介
9
+
10
+ AdSpecs 是一个基于 Claude Code 的 AI 工程研发协同插件,提供:
11
+
12
+ - **21 个 Skill**(Slash 命令) — 覆盖需求分析、架构规划、系统设计、任务拆解、单元测试、代码审查、文档导出、Wiki 同步
13
+ - **CLI 工具** — `adspecs init` 一键脚手架、`adspecs plugin install` 插件注册、`adspecs doctor` 环境检查
14
+ - **21 个标准文档模板** — 需求 / 设计 / 任务 / 测试 / 评审 / 架构全覆盖
15
+ - **多技术栈参考** — ECP Java 后端、Vue 3 前端、Ant Design React 前端、Python 后端等 11 套参考工程
16
+ - **npm 分发** — `npm install -g adspecs` 即装即用
17
+
18
+ 本插件需配合 [`superpowers`](https://github.com/anthropics/claude-plugins-official) 插件(提供 TDD、子代理驱动开发等通用 Skill)一起使用。
19
+
20
+ ---
21
+
22
+ ## 项目结构
23
+
24
+ ```
25
+ adspecs/
26
+ ├── bin/adspecs.js # CLI 入口
27
+ ├── src/ # CLI 核心代码
28
+ │ ├── commands/ # init / plugin / doctor / update
29
+ │ └── lib/ # scaffolder / prompts / report 等
30
+ ├── skills/ # 21 个 Skill 定义
31
+ ├── .claude-plugin/ # Claude Code 插件清单
32
+ ├── .qoder-plugin/ # Qoder 插件清单
33
+ ├── .adspecs/
34
+ │ ├── templates/ # 21 个标准文档模板
35
+ │ ├── extensions/ # 扩展配置(git hooks 等)
36
+ │ ├── scripts/ # 辅助脚本(bash/powershell/python)
37
+ │ ├── feature.json # 功能追踪模板
38
+ │ └── project.json # 项目元数据模板
39
+ ├── hooks/ # Node.js 钩子脚本
40
+ ├── references/ # 11 套参考工程与编码规范
41
+ ├── scripts/ # 构建脚本(postinstall/sync-version)
42
+ ├── package.json
43
+ ├── CLAUDE.md
44
+ ├── INSTALL.md
45
+ └── README.md
46
+ ```
47
+
48
+ ---
49
+
50
+ ## 快速开始
51
+
52
+ ### 1. 安装
53
+
54
+ ```bash
55
+ # 全局安装 CLI
56
+ npm install -g adspecs
57
+
58
+ # 在 Claude Code 中注册插件(用户级,全局生效)
59
+ adspecs plugin install
60
+
61
+ # 或仅注册到当前项目(团队级)
62
+ cd your-project
63
+ adspecs plugin install --scope project
64
+ ```
65
+
66
+ ### 2. 初始化项目
67
+
68
+ ```bash
69
+ # 交互式初始化
70
+ adspecs init
71
+ ```
72
+
73
+ ### 3. 开始使用 Skill
74
+
75
+ ```
76
+ /adspecs-new-requirement CRM 销售预测模块
77
+ /adspecs-prd docs/00-customer-requirements/...
78
+ /adspecs-plan docs/20-prd/crm/...
79
+ ...
80
+ ```
81
+
82
+ ---
83
+
84
+ ## CLI 工具
85
+
86
+ 安装后提供 `adspecs` 命令行工具:
87
+
88
+ | 命令 | 说明 | 示例 |
89
+ | -------------------------- | ----------------------------------------------------- | ---------------------------------------- |
90
+ | `adspecs init` | 交互式初始化项目结构(docs/、templates/、前端模板等) | `adspecs init --mode simple` |
91
+ | `adspecs plugin install` | 注册为 Claude Code 插件 | `adspecs plugin install --scope project` |
92
+ | `adspecs plugin uninstall` | 从 Claude Code 卸载插件 | `adspecs plugin uninstall --scope user` |
93
+ | `adspecs doctor` | 检查环境依赖(Node.js、git、Python 等) | `adspecs doctor` |
94
+ | `adspecs update` | 升级到最新版本 | `adspecs update --version 0.2.0` |
95
+
96
+ ### `adspecs init` 参数
97
+
98
+ | 参数 | 说明 | 默认值 |
99
+ | --------------------------- | ----------------------------------------------------- | ---------- |
100
+ | `--project-name <name>` | 项目名称 | 交互输入 |
101
+ | `--project-dir <dir>` | 项目目录(留空=当前目录) | 当前目录 |
102
+ | `--mode <mode>` | 初始化模式:`simple` \| `classic` \| `full` \| `demo` | 交互选择 |
103
+ | `--front-demo <stack>` | 前端演示技术栈:`vue` \| `antd` | `vue` |
104
+ | `--company <name>` | 公司名称 | — |
105
+ | `--confidentiality <level>` | 文件密级:`公开` \| `内部资料` \| `机密` \| `绝密` | `内部资料` |
106
+ | `--modules <list>` | 后端模块列表(逗号分隔) | — |
107
+ | `--non-interactive` | 非交互模式,使用默认值 | — |
108
+ | `--force` | 已存在区域直接重建 | — |
109
+ | `-y, --yes` | 自动确认执行 | — |
110
+
111
+ ---
112
+
113
+ ## Skills 总览(21 个)
114
+
115
+ 按职责分为六类:
116
+
117
+ ### 一、项目初始化(CLI 命令)
118
+
119
+ | 命令 | 说明 |
120
+ | -------------- | ------------------------------------------------------------------------------ |
121
+ | `adspecs init` | 交互式初始化项目结构:`docs/` 文档树、前端模板、后端模块、编码规范、标准模板等 |
122
+
123
+ 初始化后生成:
124
+
125
+ - `docs/10-architecture/` — 架构规划
126
+ - `docs/20-prd/` — 产品需求说明书
127
+ - `docs/30-system-design/` — 系统设计 + SQL + 前端设计 + 任务清单
128
+ - `docs/40-project_conventions/` — 编码规范
129
+ - `.adspecs/templates/` — 21 个标准模板
130
+ - `.adspecs/paths.json` — 可自定义的输出路径配置
131
+
132
+ ### 二、需求分析与架构规划(5 个)
133
+
134
+ | Skill | 说明 | 输入 | 输出 |
135
+ | ------------------------------- | ------------------------------------------------ | ------------------- | -------------------------------- |
136
+ | `adspecs-new-requirement` | 深度业务需求分析(六步结构 + 模拟评审) | 业务需求描述 | `docs/00-customer-requirements/` |
137
+ | `adspecs-biz-blueprint` | 将需求分析转化为 F1~F6 业务方案文件体系 | 业务需求分析文档 | `docs/00-customer-requirements/` |
138
+ | `adspecs-prd` | 从自然语言 / 调研材料生成 PRD | 调研材料 / 原始需求 | `docs/20-prd/` |
139
+ | `adspecs-clarify` | 识别 PRD 模糊点(≤5 个)并澄清 | 需求规格说明书 | 更新后的规格说明书 |
140
+ | `adspecs-architecture-planning` | 平台级架构规划(功能架构 → 模块依赖 → 数据建模) | 项目 / 业务描述 | `docs/10-architecture/` |
141
+
142
+ ### 三、SOW / 设计 / 任务(5 个)
143
+
144
+ | Skill | 说明 | 输入 | 输出 |
145
+ | --------------------- | ------------------------------------- | --------------- | ------------------------------------- |
146
+ | `adspecs-write-sow` | 根据项目 / 合同信息生成工作说明书 | 项目 / 合同信息 | `docs/05-sow/` |
147
+ | `adspecs-plan` | 后端统一系统设计(OOA+OOD)+ 建表 SQL | PRD | `docs/30-system-design/` design + SQL |
148
+ | `adspecs-front-spec` | 前端功能设计(UI/交互规格) | PRD + 系统设计 | `docs/30-system-design/` 前端设计 |
149
+ | `adspecs-tasks` | 后端 TDD 任务清单 | 系统设计文档 | `docs/30-system-design/` tasks.md |
150
+ | `adspecs-front-tasks` | 前端 TDD 任务清单 | 前端设计文档 | `docs/30-system-design/` tasks.md |
151
+
152
+ ### 四、质量保障与测试(3 个)
153
+
154
+ | Skill | 说明 |
155
+ | ---------------------------- | ------------------------------------------------------------------- |
156
+ | `adspecs-analyze` | 跨文档(PRD / 系统设计 / tasks)全链路 13 维一致性分析 |
157
+ | `adspecs-adversarial-review` | 对抗式审查:5 个红队角色挑战文档假设、缺失、矛盾与歧义 |
158
+ | `adspecs-utest` | 基于系统设计生成 Service / Controller 层 JUnit 5 单元测试代码及报告 |
159
+
160
+ ### 五、交付与运维(5 个)
161
+
162
+ | Skill | 说明 |
163
+ | ----------------------- | -------------------------------------------------- |
164
+ | `adspecs-update-status` | 更新 feature.json 功能状态 + 输出追踪矩阵 |
165
+ | `adspecs-export-word` | Markdown 导出为 Word(.docx),自动生成封面 + 目录 |
166
+ | `adspecs-git-commit` | 各阶段完成后自动提交变更 |
167
+ | `sie-front-code-review` | 前端专项评审(React + TypeScript + Ant Design) |
168
+ | `wiki-update` | 将 docs/ 同步到 wiki/(全量 / 增量模式) |
169
+
170
+ ### 六、产品规划(2 个)
171
+
172
+ | Skill | 说明 |
173
+ | ------------------------------- | ------------------------------------ |
174
+ | `adspecs-write-planning-report` | 汇总调研期分析输出,生成产品规划报告 |
175
+ | `adspecs-write-roadmap` | 版本路标维护,追写 roadmap.md |
176
+
177
+ ### 编码阶段依赖(superpowers 插件)
178
+
179
+ | 外部 Skill | 说明 |
180
+ | -------------------------------- | -------------------------------- |
181
+ | `subagent-driven-development` | 子代理驱动并行开发 |
182
+ | `test-driven-development` | RED → GREEN → REFACTOR TDD 循环 |
183
+ | `dispatching-parallel-agents` | 并行子代理调度 |
184
+ | `finishing-a-development-branch` | 分支收尾(PR / merge / cleanup) |
185
+ | `verification-before-completion` | 完成前最终验证 |
186
+
187
+ ---
188
+
189
+ ## 模板体系(21 个)
190
+
191
+ 初始化后位于 `.adspecs/templates/`:
192
+
193
+ | 模板 | 用途 | 阶段 |
194
+ | ---------------------------- | --------------------------- | ---- |
195
+ | `01-业务需求分析模板.md` | 业务需求分析(六步结构) | 需求 |
196
+ | `02-产品需求说明书模板.md` | 产品需求说明书(PRD) | 需求 |
197
+ | `03-系统设计模板.md` | 后端统一系统设计(OOA+OOD) | 设计 |
198
+ | `04-前端功能设计模板.md` | 前端功能规格(UI/交互) | 设计 |
199
+ | `05-后端任务清单模板.md` | 后端 TDD 任务清单 | 任务 |
200
+ | `05b-前端任务清单模板.md` | 前端 TDD 任务清单 | 任务 |
201
+ | `06-代码评审报告模板.md` | 代码评审报告 | 审查 |
202
+ | `07-单元测试报告模板.md` | 单元测试报告 | 测试 |
203
+ | `08-系统集成测试报告模板.md` | 集成测试报告 | 测试 |
204
+ | `09-性能测试报告模板.md` | 性能测试报告 | 测试 |
205
+ | `10-安全检查清单.md` | 安全检查清单 | 审查 |
206
+ | `11-代码质量标准.md` | 代码质量标准 | 审查 |
207
+ | `13-测试用例模板.md` | 测试用例 | 测试 |
208
+ | `14-需求追溯矩阵模板.md` | 需求 → 实现追溯矩阵 | 审查 |
209
+ | `15-业务功能架构文档模板.md` | 业务功能架构规划 | 架构 |
210
+ | `16-系统架构设计模板.md` | 系统架构设计 | 架构 |
211
+ | `17-子模块依赖关系模板.md` | 子模块依赖关系 | 架构 |
212
+ | `18-统一数据模型模板.md` | 统一数据建模(含 ER 图) | 架构 |
213
+ | `19-项目目录结构模板.md` | 项目目录结构规划 | 架构 |
214
+ | `20-工作说明书SOW模板.md` | 工作说明书(SOW) | 需求 |
215
+ | `21-业务方案模板.md` | 业务方案(F1~F6 文件体系) | 需求 |
216
+
217
+ > **约定**:所有模板通过对应 Skill 调用生成,不建议直接手工填写。
218
+
219
+ ---
220
+
221
+ ## 参考工程(11 套)
222
+
223
+ `references/` 目录包含 `adspecs init` 时按需复制到目标项目的参考代码和规范:
224
+
225
+ | 目录 | 说明 |
226
+ | ------------------------------ | ---------------------------------------------- |
227
+ | `docs/40-project_conventions/` | ECP 编码标准(后端 Java + 前端集成) |
228
+ | `front-demo/` | Vue 3 前端演示项目(Vite + TS + Element Plus) |
229
+ | `antd-front-demo/` | Ant Design React 前端演示项目 |
230
+ | `ant6-front-standard/` | Ant Design 6 前端编码规范(9 篇) |
231
+ | `ecp-end-standard/` | ECP 后端编码规范 |
232
+ | `ecp-front-standard/` | ECP 前端编码规范 |
233
+ | `iidp-end-standard/` | IIDP 后端编码规范 |
234
+ | `iidp-front-standard/` | IIDP 前端编码规范 |
235
+ | `web-ui/` | ECP 管理控制台外壳工程 |
236
+ | `python/` | Python 后端参考 |
237
+ | `yudaocloud-end-standard/` | 芋道 Cloud 后端集成参考 |
238
+
239
+ ---
240
+
241
+ ## 推荐开发流程
242
+
243
+ ```
244
+ [adspecs init] → 项目脚手架
245
+
246
+ [adspecs-architecture-planning] → 平台架构规划(功能架构→依赖→数据模型)
247
+
248
+ [adspecs-new-requirement] → 深度业务需求分析
249
+
250
+ [adspecs-biz-blueprint] → 业务方案(F1~F6 文件体系)
251
+
252
+ [adspecs-prd + adspecs-clarify] → 产品需求说明书 + 澄清迭代
253
+
254
+ [adspecs-plan / adspecs-front-spec] → 后端设计+SQL / 前端设计
255
+
256
+ [adspecs-tasks / adspecs-front-tasks] → 后端 / 前端 TDD 任务清单
257
+
258
+ [adspecs-analyze + adversarial-review]→ 一致性与质量审查
259
+
260
+ [TDD + subagent-driven-development] → 编码实现(依赖 superpowers)
261
+
262
+ [adspecs-utest] → 单元测试 + 报告
263
+
264
+ [sie-front-code-review] → 前端代码审查
265
+
266
+ [adspecs-update-status] → 功能状态追踪
267
+
268
+ [adspecs-export-word / wiki-update] → 文档导出 + Wiki 同步
269
+ ```
270
+
271
+ ### 完整示例:销售预测从零到交付
272
+
273
+ ```txt
274
+ # 1. 初始化项目
275
+ adspecs init --project-name my-crm --mode classic
276
+
277
+ # 2. 平台架构规划
278
+ /adspecs-architecture-planning 华峰铝业CRM,覆盖销售全生命周期
279
+
280
+ # 3. 深度需求分析
281
+ /adspecs-new-requirement CRM 销售预测模块
282
+
283
+ # 4. 业务方案
284
+ /adspecs-biz-blueprint docs/00-customer-requirements/...
285
+
286
+ # 5. 生成 PRD
287
+ /adspecs-prd 预测单需求调研.md
288
+
289
+ # 6. 澄清 + 评审(2~3 轮)
290
+ /adspecs-clarify docs/20-prd/crm/sales-forecast/M06-01_销售预测需求规格说明书.md
291
+
292
+ # 7. 后端系统设计 + SQL
293
+ /adspecs-plan docs/20-prd/crm/sales-forecast/M06-01_销售预测需求规格说明书.md
294
+
295
+ # 8. 前端设计
296
+ /adspecs-front-spec docs/20-prd/crm/sales-forecast/M06-01_销售预测需求规格说明书.md
297
+
298
+ # 9. 生成任务清单
299
+ /adspecs-tasks docs/30-system-design/crm/M06-01-销售预测_system-design.md
300
+ /adspecs-front-tasks docs/30-system-design/crm/M06-01_销售预测_前端设计.md
301
+
302
+ # 10. 一致性与对抗审查
303
+ /adspecs-analyze docs/20-prd/... docs/30-system-design/...
304
+ /adspecs-adversarial-review M06-01_*.md
305
+
306
+ # 11. 编码实现(TDD)
307
+ /subagent-driven-development
308
+
309
+ # 12. 单元测试 + 审查
310
+ /adspecs-utest docs/30-system-design/crm/M06-01-销售预测_system-design.md
311
+ /sie-front-code-review
312
+
313
+ # 13. 状态追踪 + 导出
314
+ /adspecs-update-status
315
+ /adspecs-export-word docs/30-system-design/
316
+ /wiki-update
317
+ ```
318
+
319
+ ---
320
+
321
+ ## 路径配置
322
+
323
+ Skill 支持通过 `.adspecs/paths.json` 自定义输出目录:
324
+
325
+ ```json
326
+ {
327
+ "paths": {
328
+ "biz_analysis_dir": "docs/00-customer-requirements",
329
+ "architecture_dir": "docs/10-architecture",
330
+ "prd_dir": "docs/20-prd",
331
+ "design_dir": "docs/30-system-design",
332
+ "test_report_dir": "docs/80-development",
333
+ "export_dir": "docs/90-export",
334
+ "wiki_dir": "wiki"
335
+ }
336
+ }
337
+ ```
338
+
339
+ `adspecs init` 自动生成此文件,可直接编辑修改。
340
+
341
+ ---
342
+
343
+ ## 安装与升级
344
+
345
+ 详细安装说明见 [INSTALL.md](./INSTALL.md)。
346
+
347
+ ```bash
348
+ # 安装
349
+ npm install -g adspecs
350
+ adspecs plugin install # 用户级(默认)
351
+ adspecs plugin install --scope project # 项目级
352
+
353
+ # 升级
354
+ npm install -g adspecs@latest
355
+
356
+ # 卸载
357
+ adspecs plugin uninstall --scope user
358
+ adspecs plugin uninstall --scope project
359
+ ```
360
+
361
+ ---
362
+
363
+ ## 常见问题
364
+
365
+ **Q1:adspecs 与 superpowers 的关系?**
366
+ adspecs 提供领域专属 Skill(需求、设计、模板、规范),superpowers 提供通用 AI 工程 Skill(TDD、子代理、调试)。两者分工协作,**编码阶段必须同时安装**。
367
+
368
+ **Q2:用户级和项目级安装可以共存吗?**
369
+ 可以,项目级优先于用户级(就近原则)。个人开发选用户级,团队协作选项目级。
370
+
371
+ **Q3:安装后 Skill 未生效?**
372
+ 1. 执行 `/plugins` 查看 adspecs 是否在已加载列表
373
+ 2. 重启 Claude Code
374
+ 3. 检查安装 scope 对应的目录是否存在
375
+
376
+ **Q4:如何升级?**
377
+ ```bash
378
+ npm install -g adspecs@latest
379
+ # 插件注册无需重新执行,Skill 定义随 npm 包更新
380
+ ```
381
+
382
+ **Q5:前端测试框架?**
383
+ Vue 项目使用 Vitest + @vue/test-utils;React 项目使用 Jest + React Testing Library。
384
+
385
+ **Q6:init 模式区别?**
386
+ - `simple`:仅 docs + wiki
387
+ - `classic`:+ front-demo(默认)
388
+ - `full`:所有目录 + 参考工程
389
+ - `demo`:Python+SQLite+React+AntD6 全栈 demo
390
+
391
+ ---
392
+
393
+ ## License
394
+
395
+ [Apache-2.0](./LICENSE)