visual-spec 0.1.8 → 0.1.9

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 (84) hide show
  1. package/README.md +12 -0
  2. package/docs/en-US/ai-platform-installation.md +39 -0
  3. package/docs/en-US/commands.md +4 -2
  4. package/docs/en-US/getting-started.md +7 -29
  5. package/docs/en-US/installation.md +4 -39
  6. package/docs/en-US/scheme.example.yaml +2 -1
  7. package/docs/en-US/structure.md +2 -3
  8. package/docs/en-US/workflows.md +4 -4
  9. package/docs/ja-JP/ai-platform-installation.md +39 -0
  10. package/docs/ja-JP/commands.md +38 -0
  11. package/docs/ja-JP/concepts.md +35 -0
  12. package/docs/ja-JP/getting-started.md +39 -0
  13. package/docs/ja-JP/installation.md +18 -0
  14. package/docs/ja-JP/scheme.example.yaml +72 -0
  15. package/docs/ja-JP/structure.md +49 -0
  16. package/docs/ja-JP/ui-spec-modification-notes.md +35 -0
  17. package/docs/ja-JP/workflows.md +40 -0
  18. package/docs/zh-CN/ai-platform-installation.md +39 -0
  19. package/docs/zh-CN/commands.md +14 -2
  20. package/docs/zh-CN/getting-started.md +7 -29
  21. package/docs/zh-CN/installation.md +4 -39
  22. package/docs/zh-CN/quality_check.md +33 -0
  23. package/docs/zh-CN/scheme.example.yaml +2 -1
  24. package/docs/zh-CN/structure.md +2 -3
  25. package/docs/zh-CN/workflows.md +28 -4
  26. package/package.json +6 -2
  27. package/scripts/build_skill.cjs +57 -0
  28. package/scripts/transform_quality_standard.py +306 -0
  29. package/skills/visual-spec-skill/SKILL-ja-JP.md +384 -0
  30. package/skills/visual-spec-skill/SKILL-zh-CN.md +56 -2
  31. package/skills/visual-spec-skill/SKILL.md +65 -3
  32. package/skills/visual-spec-skill/prompts/vspec_accept/accept.md +23 -6
  33. package/skills/visual-spec-skill/prompts/vspec_detail/auth.md +6 -2
  34. package/skills/visual-spec-skill/prompts/vspec_detail/code_rules.md +14 -2
  35. package/skills/visual-spec-skill/prompts/vspec_detail/cron_job.md +29 -8
  36. package/skills/visual-spec-skill/prompts/vspec_detail/data_permission.md +4 -0
  37. package/skills/visual-spec-skill/prompts/vspec_detail/decision_matrix.md +20 -4
  38. package/skills/visual-spec-skill/prompts/vspec_detail/expression_tree.md +34 -6
  39. package/skills/visual-spec-skill/prompts/vspec_detail/file_export.md +14 -2
  40. package/skills/visual-spec-skill/prompts/vspec_detail/file_import.md +14 -2
  41. package/skills/visual-spec-skill/prompts/vspec_detail/formula.md +14 -2
  42. package/skills/visual-spec-skill/prompts/vspec_detail/interaction.md +21 -4
  43. package/skills/visual-spec-skill/prompts/vspec_detail/judgemental_matrix.md +22 -4
  44. package/skills/visual-spec-skill/prompts/vspec_detail/logging_matrix.md +14 -3
  45. package/skills/visual-spec-skill/prompts/vspec_detail/mq.md +14 -3
  46. package/skills/visual-spec-skill/prompts/vspec_detail/nfp.md +26 -7
  47. package/skills/visual-spec-skill/prompts/vspec_detail/notification_matrix.md +14 -3
  48. package/skills/visual-spec-skill/prompts/vspec_detail/page_load.md +35 -8
  49. package/skills/visual-spec-skill/prompts/vspec_detail/payment.md +6 -2
  50. package/skills/visual-spec-skill/prompts/vspec_detail/post_submit_check.md +14 -2
  51. package/skills/visual-spec-skill/prompts/vspec_detail/post_submit_navigation.md +15 -3
  52. package/skills/visual-spec-skill/prompts/vspec_detail/post_submit_processing.md +14 -2
  53. package/skills/visual-spec-skill/prompts/vspec_detail/rbac.md +24 -4
  54. package/skills/visual-spec-skill/prompts/vspec_detail/state_machine.md +30 -4
  55. package/skills/visual-spec-skill/prompts/vspec_detail/timeline.md +34 -6
  56. package/skills/visual-spec-skill/prompts/vspec_detail/validation_matrix.md +14 -3
  57. package/skills/visual-spec-skill/prompts/vspec_more_q/more_q.md +82 -0
  58. package/skills/visual-spec-skill/prompts/vspec_mrd/mrd.md +73 -0
  59. package/skills/visual-spec-skill/prompts/vspec_new/background.md +236 -30
  60. package/skills/visual-spec-skill/prompts/vspec_new/dependencies.md +28 -6
  61. package/skills/visual-spec-skill/prompts/vspec_new/details_boundaries.md +17 -7
  62. package/skills/visual-spec-skill/prompts/vspec_new/details_constraints.md +17 -7
  63. package/skills/visual-spec-skill/prompts/vspec_new/details_pre_post.md +32 -17
  64. package/skills/visual-spec-skill/prompts/vspec_new/details_symmetry.md +17 -7
  65. package/skills/visual-spec-skill/prompts/vspec_new/details_variations.md +17 -7
  66. package/skills/visual-spec-skill/prompts/vspec_new/flows.md +4 -0
  67. package/skills/visual-spec-skill/prompts/vspec_new/functions.md +18 -3
  68. package/skills/visual-spec-skill/prompts/vspec_new/questions.md +30 -2
  69. package/skills/visual-spec-skill/prompts/vspec_new/roles.md +20 -4
  70. package/skills/visual-spec-skill/prompts/vspec_new/scenarios.md +9 -2
  71. package/skills/visual-spec-skill/prompts/vspec_new/stakeholders.md +21 -5
  72. package/skills/visual-spec-skill/prompts/vspec_new/terms.md +21 -6
  73. package/skills/visual-spec-skill/prompts/vspec_plan/estimate.md +95 -9
  74. package/skills/visual-spec-skill/prompts/vspec_plan/schedule.md +36 -3
  75. package/skills/visual-spec-skill/prompts/vspec_qc/qc.md +17 -3
  76. package/skills/visual-spec-skill/prompts/vspec_qc/quality_standard.md +769 -26
  77. package/skills/visual-spec-skill/prompts/vspec_refine/refine.md +48 -23
  78. package/skills/visual-spec-skill/prompts/vspec_refine/refine_q.md +47 -20
  79. package/skills/visual-spec-skill/prompts/vspec_test/test.md +4 -0
  80. package/skills/visual-spec-skill/prompts/vspec_upgrade/upgrade.md +13 -2
  81. package/skills/visual-spec-skill/prompts/vspec_verify/model.md +49 -24
  82. package/skills/visual-spec-skill/prompts/vspec_verify/prototype.md +9 -1
  83. package/skills/visual-spec-skill/prompts/vspec_verify/prototype_calendar.md +16 -4
  84. /package/skills/visual-spec-skill/prompts/vspec_qc/{22. → }/351/234/200/346/261/202/345/210/206/346/236/220/351/224/231/351/242/230/346/234/254.xlsx" +0 -0
@@ -0,0 +1,39 @@
1
+ # 多 AI 平台安装指南
2
+
3
+ 推荐使用 skills.sh 的官方安装器(skills CLI)进行安装:同一套命令可面向不同 AI 平台(Trae / Claude Code / Cursor / GitHub Copilot 等)把 Skill 安装到对应的 skills 目录。
4
+
5
+ ## 方式一:skills.sh(推荐)
6
+
7
+ 安装器会自动检测本机支持的 agent,并提示选择安装位置与范围(项目级或全局)。
8
+
9
+ ```bash
10
+ npx skills add visual-req/visual-spec --skill visual-spec-skill
11
+ ```
12
+
13
+ 指定安装到某个 AI 平台(示例):
14
+
15
+ ```bash
16
+ # Trae(项目级)
17
+ npx skills add visual-req/visual-spec --skill visual-spec-skill -a trae
18
+
19
+ # Claude Code(项目级)
20
+ npx skills add visual-req/visual-spec --skill visual-spec-skill -a claude-code
21
+
22
+ # Cursor(项目级)
23
+ npx skills add visual-req/visual-spec --skill visual-spec-skill -a cursor
24
+
25
+ # GitHub Copilot(项目级)
26
+ npx skills add visual-req/visual-spec --skill visual-spec-skill -a github-copilot
27
+ ```
28
+
29
+ 全局安装(对当前用户所有项目生效):
30
+
31
+ ```bash
32
+ npx skills add visual-req/visual-spec --skill visual-spec-skill -g
33
+ ```
34
+
35
+ 查看该仓库包含的 skills:
36
+
37
+ ```bash
38
+ npx skills add visual-req/visual-spec --list
39
+ ```
@@ -5,20 +5,23 @@
5
5
  | `/vspec:new` | 从原始需求生成第一版规格产物 | 原始需求文本 + 交互式问答 | `/specs/`(original、stakeholders、roles、terms、flows、scenarios、scenario_details、dependencies、functions、questions)+ 初始化 `/docs/*` 输入归档目录 |
6
6
  | `/vspec:refine` | 应用补充/澄清材料,并同步更新详情与原型 | `/docs/refine/*`(或命令参数)+ `/specs/background/original.md` + 前置条件 `/specs/details/` | 追加更新到 `/specs/background/original.md`(变更清单 + 最新口径)+ 更新受影响的 `/specs/details/` 与 `/specs/prototypes/` |
7
7
  | `/vspec:refine-q` | 将已回答的问题合并回需求并形成新口径 | `/specs/background/original.md` + `/specs/background/questions.md` | 追加到 `/specs/background/original.md`(采纳项 + 变更清单 + 最新口径) |
8
+ | `/vspec:more-q` | 追加更多“待确认问题”到 questions 清单 | `/specs/background/original.md` + `/specs/background/questions.md` | 追加写入 `/specs/background/questions.md`(新增问题 + 回答指引) |
8
9
  | `/vspec:detail` | 展开到“可实现”的单功能详细规格 | `/specs/functions/*` + 支撑产物(background/flows/roles;models 若已存在) | `/specs/details/<function_slug>/*`(RBAC、交互、校验、日志、通知、MQ、导入导出、定时任务等) |
9
10
  | `/vspec:verify` | 快速验证:生成模型与可运行原型用于评审 | 现有 `/specs/` 产物(functions + details + roles) | `/specs/models/*.md`、`/specs/prototypes/`(按 `scheme.yaml` 选栈生成可运行原型 + `scenario.html` 评审页) |
10
11
  | `/vspec:accept` | 生成验收用例 | functions/scenarios/details/roles/models | `/specs/acceptance/<function_slug>/acceptance_cases.md`、`/specs/acceptance/index.md` |
11
12
  | `/vspec:append-test` | 生成自动化测试代码 | 验收用例 + 仓库测试技术栈 | 写入既有测试目录或 `/tests/` |
12
13
  | `/vspec:impl` | 生成后端 + 前端联调实现代码 | specs/details/models/dependencies | 写入集成实现代码(API 合同、后端、前端对接) |
13
14
  | `/vspec:upgrade` | 基于遗留材料做升级/重构分析并生成新规格 | `/docs/current/file_list.md` + `/docs/legacy/*`(可选 templates/texts/assets)+ 既有 `/specs/background/original.md`(可选) | 生成/更新 `/specs/`(沿用 `/vspec:new` 结构)+ 同步技术选型到 `/scheme.yaml` |
14
- | `/vspec:qc` | 对 `/specs/` 产物做质量检查 | 内置标准 + 可选 `quality_standard.md` + `/specs/` | `/specs/qc_report.md` |
15
+ | `/vspec:qc` | 对 `/specs/` 产物做质量检查 | 内置标准 + 可选 `domain_quality_standard.md` + 可选 `quality_standard.md` + `/specs/` | `/specs/qc_report.md` |
15
16
  | `/vspec:plan` | 估算与排期 | functions/roles/flows/dependencies/details | `/specs/plan/plan_estimate.md`、`/specs/plan/plan_schedule.html` |
17
+ | `/vspec:mrd` | 生成 MRD:市场/竞品/用户/产品设计 | `/specs/background/*` + `/specs/flows/*` + `/specs/functions/*`(如有) | `/docs/market/*.md`(market/competitors/users/product_design) |
16
18
 
17
19
  ## `/vspec:new`
18
20
 
19
21
  - 适用场景:刚拿到需求且信息不完整,需要快速形成“可评审的共同语言”
20
22
  - 关键输出:干系人、角色、术语、流程、场景、功能清单、开放问题
21
- - 目录初始化:创建 `/docs/` 及其子目录(legacy/current/change/refine/templates/texts/assets)用于输入归档与后续命令使用
23
+ - 目录初始化:创建 `/docs/` 及其子目录(legacy/current/refine/templates/texts/assets)用于输入归档与后续命令使用
24
+ - 提示:生成“开放问题/待确认问题”后,你可以把回答工作委托给 AI 先给出建议答案,你只需要逐条确认/修改即可(推荐做法:先让 AI 代答一版,再由业务确认口径)
22
25
 
23
26
  ## `/vspec:refine`
24
27
 
@@ -36,6 +39,15 @@
36
39
  - 适用场景:业务已在 `/specs/background/questions.md` 填写答案,需要合并回需求并形成新口径
37
40
  - 关键输出:采纳的 Q&A 项 + 变更清单 + 最新口径
38
41
 
42
+ ## `/vspec:more-q`
43
+
44
+ - 适用场景:问题清单还不够,或需求发生变更,需要补充更多“待确认问题”
45
+ - 关键输出:追加到 `/specs/background/questions.md` 末尾的新问题条目(延续编号、不重复),并提供“回答指引”
46
+ - 推荐用法:
47
+ - 先执行 `/vspec:more-q` 生成/补充问题
48
+ - 业务按编号逐条填写问题的“回答/回答者/回答时间/状态”
49
+ - 再执行 `/vspec:refine-q` 合并答案进入 `original.md`
50
+
39
51
  ## `/vspec:detail`
40
52
 
41
53
  - 适用场景:在设计/实现前,需要把每个功能点展开到“可实现”的规格粒度
@@ -4,39 +4,22 @@
4
4
 
5
5
  ### 1. 安装
6
6
 
7
- 先全局安装 npm 包,再把 Skill 安装到 AI 编辑器的配置目录:
7
+ Skill 安装到 AI 编辑器的配置目录:
8
8
 
9
9
  - 安装与校验:`installation.md`
10
10
 
11
- 安装/更新(npm):
11
+ 安装/更新(skills.sh):
12
12
 
13
13
  ```bash
14
- npm install -g visual-spec@latest
15
- ```
16
-
17
- 安装/更新(pnpm):
18
-
19
- ```bash
20
- pnpm add -g visual-spec@latest
21
- ```
22
-
23
- 安装/更新(yarn):
24
-
25
- Yarn Classic:
26
-
27
- ```bash
28
- yarn global add visual-spec@latest
29
- ```
30
-
31
- Yarn Berry(v2+):
32
-
33
- ```bash
34
- yarn dlx -p visual-spec@latest vspec
14
+ npx skills add visual-req/visual-spec --skill visual-spec-skill
35
15
  ```
36
16
 
37
17
  ### 2. 推荐流程
38
18
 
39
19
  - 初始规格:`/vspec:new`
20
+ - 可选语言:
21
+ - 单语言:`/vspec:new lang=zh-CN`(或 `lang=en`、`lang=ja`),会把 `/scheme.yaml` 的 `selected.language` 设为该值,并让后续文档产物全程按该语言输出
22
+ - 多语言(原型可切换):`/vspec:new lang=zh-CN,en`,文档默认输出 `zh-CN`,并把 `/scheme.yaml` 的 `selected.languages` 设为可切换语言集合
40
23
  - 执行中会先生成需求口径文件(`/specs/background/original.md`),并在该步骤提出若干澄清问题
41
24
  - 你需要先在对话中回答这些问题,然后输入“继续”才能完成 `/vspec:new` 全流程(这些澄清回答不写入 `questions.md`)
42
25
  - 执行过程中还会生成开放问题清单(`/specs/background/questions.md`),用于后续合并
@@ -51,7 +34,7 @@ yarn dlx -p visual-spec@latest vspec
51
34
 
52
35
  ### 3. 关键目录
53
36
 
54
- - `/docs/`:输入归档(legacy/current/change/refine/templates/texts/assets)
37
+ - `/docs/`:输入归档(legacy/current/refine/templates/texts/assets)
55
38
  - `/specs/`:生成产物(background/details/models/prototypes/acceptance 等)
56
39
  - `/scheme.yaml`:技术栈与包管理器选择(原型与实现必须遵循)
57
40
 
@@ -72,11 +55,6 @@ yarn dlx -p visual-spec@latest vspec
72
55
  - 运行:`/vspec:refine`
73
56
  - 结果:向 `/specs/background/original.md` 追加更新,并同步更新受影响的 `/specs/details/` 与 `/specs/prototypes/`
74
57
 
75
- #### 变更(`change`)
76
-
77
- - 把变更材料放到 `/docs/change/`(可选 `file_list.md`)
78
- - 结果:做影响分析并更新产物(优先 `/specs/details/<module_slug>/`),同时更新变更日志
79
-
80
58
  #### 升级/重构(`upgrade`)
81
59
 
82
60
  - 在 `/docs/current/file_list.md` 中列出输入材料(遗留系统在 `/docs/legacy/`,新增输入在 `/docs/current/`)
@@ -1,53 +1,18 @@
1
1
  ## 安装到支持 Skill 的 AI 编辑器
2
2
 
3
- 本包使用脚本把内置的 Skill 目录复制到你的 AI 编辑器配置目录(Trae / Qwen / Kiro 等)。不同编辑器的配置路径可能不同,但安装逻辑一致:把 `visual-spec-skill` 安装到目标目录的 `skills/` 下。
3
+ 推荐使用 skills.sh 的官方安装器(skills CLI)安装到支持 Skill AI 编辑器(Trae / Qwen / Kiro 等)。安装器会自动识别可用的 agent,并把 `visual-spec-skill` 安装到对应的 `skills/` 目录。
4
4
 
5
5
  ### 前置条件
6
6
 
7
7
  - Node.js >= 14
8
8
 
9
- ### 安装/更新(npm
9
+ ### 安装/更新(推荐:skills.sh
10
10
 
11
11
  ```bash
12
- npm install -g visual-spec@latest
13
- ```
14
-
15
- ### 安装/更新(pnpm)
16
-
17
- ```bash
18
- pnpm add -g visual-spec@latest
19
- ```
20
-
21
- ### 安装/更新(yarn)
22
-
23
- Yarn Classic:
24
-
25
- ```bash
26
- yarn global add visual-spec@latest
27
- ```
28
-
29
- Yarn Berry(v2+):
30
-
31
- ```bash
32
- yarn dlx -p visual-spec@latest vspec
33
- ```
34
-
35
- ### 指定安装目录(`--target-skills-dir`)
36
-
37
- 默认情况下,安装脚本会把 Skill 安装到当前目录的 `.trae/skills/visual-spec-skill`。如果你需要安装到自定义的 `skills/` 目录(例如统一放在某个编辑器配置目录),可以在安装后执行:
38
-
39
- ```bash
40
- vspec --target-skills-dir /path/to/skills --force
41
- ```
42
-
43
- 说明:
44
- - `--target-skills-dir` 传入的是“skills 目录”,脚本会自动追加子目录 `visual-spec-skill/`
45
- - 你也可以使用 `--target-skill-dir` 传入完整目标目录(包含 `visual-spec-skill`):
46
-
47
- ```bash
48
- vspec --target-skill-dir /path/to/skills/visual-spec-skill --force
12
+ npx skills add visual-req/visual-spec --skill visual-spec-skill
49
13
  ```
50
14
 
51
15
  ### 下一步
52
16
 
53
17
  - 快速开始:`getting-started.md`
18
+ - 多 AI 平台安装指南:`ai-platform-installation.md`
@@ -0,0 +1,33 @@
1
+ ## 需求质量检查(独立使用)
2
+
3
+ 本节说明如何不依赖 `/vspec:qc`,单独利用内置的质量标准文件,对“Word/Markdown/文档库”等任意格式的需求文档进行质量扫描,并生成质量问题表格。
4
+
5
+ ### 准备
6
+
7
+ - 质量标准文件路径(任选其一,取当前环境存在者):
8
+ - Skill 根目录:`/prompts/vspec_qc/quality_standard.md`
9
+ - 源码路径:`skills/visual-spec-skill/prompts/vspec_qc/quality_standard.md`
10
+ - 你的需求文档(PRD、功能说明、规格等),支持 Word/PDF/Markdown 等
11
+
12
+ ### 使用方式(以 DeepSeek 聊天式 AI 为例)
13
+
14
+ 1. 在聊天窗口上传两份文件:
15
+ - `quality_standard.md`(质量标准)
16
+ - 你的需求文档(Word/PDF/Markdown 等)
17
+ 2. 在输入框键入:
18
+
19
+ 请按照质量标准对需求文档进行质量检查,并生成质量检查结果的表格。
20
+
21
+ 3. 若需要结构化表格,可补充表头要求,例如:
22
+ - 编号
23
+ - 问题分类/标题
24
+ - 是否通过(是/否/部分)
25
+ - 问题摘要
26
+ - 涉及位置(章节/段落/页码)
27
+ - 修复建议
28
+
29
+ ### 建议
30
+
31
+ - 对于“上下限、时间口径、公式精度、权限与数据权限、外部依赖失败策略”等容易遗漏的部分,可在提问中强调“请重点覆盖边界/异常/幂等/回滚/审计/对账”等关键维度
32
+ - 如果发现高频问题,可将其沉淀到你项目根目录的 `domain_quality_standard.md`,作为领域补充标准,供 `/vspec:qc` 合并使用
33
+
@@ -7,7 +7,8 @@ selected:
7
7
  prototype_backend_stack: java17_springboot3
8
8
  prototype_database: mysql8
9
9
  package_manager: npm
10
- language: zh-CN
10
+ language: en # 文档默认语言:en | zh-CN | ja
11
+ languages: [en] # 可选:原型可切换语言集合,例如 [zh-CN, en]
11
12
 
12
13
  prototype_options:
13
14
  calendar_view:
@@ -13,8 +13,7 @@ Skill 会按命令阶段逐步在 `/specs/` 下生成产物,并维护少量项
13
13
  │ ├─ legacy/ # 遗留系统材料(功能、权限、交互、API 等)
14
14
  │ ├─ current/ # 本次迭代新增/补充材料(目标、差异、流程、UI 约束等)
15
15
  │ │ └─ file_list.md # upgrade 入口清单(/vspec:upgrade 读取/生成)
16
- │ ├─ change/ # 变更输入归档(可选)
17
- │ │ └─ file_list.md # 可选:有序输入清单
16
+ │ ├─ dependencies/ # 外部依赖系统文档库(已有依赖系统说明,推荐)
18
17
  │ ├─ refine/ # 补充/澄清输入(/vspec:refine 读取)
19
18
  │ │ └─ file_list.md # 可选:有序输入清单
20
19
  │ ├─ templates/ # 模板(PRD/文案/UI/表格模板,可选)
@@ -65,7 +64,7 @@ Skill 会按命令阶段逐步在 `/specs/` 下生成产物,并维护少量项
65
64
  ```
66
65
 
67
66
  说明:
68
- - `docs/`:归档业务输入与交付对齐材料。建议使用 `legacy/current/change/refine/templates/texts/assets` 等子目录,并在文件名中包含来源/版本信息。
67
+ - `docs/`:归档业务输入与交付对齐材料。建议使用 `legacy/current/dependencies/refine/templates/texts/assets` 等子目录,并在文件名中包含来源/版本信息。
69
68
  - `scheme.yaml`:选择 `/vspec:verify` 与 `/vspec:impl` 使用的技术栈与选项。读取顺序为项目根目录的 `scheme.yaml` 优先,其次 `/specs/scheme.yaml`。若都不存在则生成默认 `scheme.yaml`。
70
69
 
71
70
  下一步:
@@ -54,8 +54,32 @@
54
54
  - `/specs/plan/plan_estimate.md`
55
55
  - `/specs/plan/plan_schedule.html`
56
56
 
57
- ## 安装(npm)
57
+ ## 独立使用质量规范(不依赖 `/vspec:qc`)
58
58
 
59
- - 推荐在目标项目根目录安装:`npm install <git-url>`
60
- - 安装后 Skill 会被复制到:`<your-project>/.trae/skills/visual-spec-skill/`
61
- - 需要时可手动安装:`npx vspec --force`
59
+ 内置质检标准文件位于(任选其一,取你当前环境中存在的路径):
60
+ - Skill 根目录下:`/prompts/vspec_qc/quality_standard.md`
61
+ - 本仓库源码路径:`skills/visual-spec-skill/prompts/vspec_qc/quality_standard.md`
62
+
63
+ 你可以把它作为“通用需求质检标准”,独立用于检查其他方式写出来的需求文档(不要求必须由 `/vspec:*` 生成)。
64
+
65
+ 以 DeepSeek 聊天窗口为例(其他大模型/聊天产品同理):
66
+ 1. 上传 2 份文件:
67
+ - `quality_standard.md`(质检标准)
68
+ - 你的需求文档(例如 PRD/需求说明/功能规格)
69
+ 2. 在聊天窗口输入以下指令:
70
+
71
+ 请按照质量标准对需求文档进行质量检查,并生成质量检查结果的表格。
72
+
73
+ 建议输出表格列(可选):
74
+ - 检查项编号
75
+ - 检查项标题
76
+ - 是否通过(是/否/部分)
77
+ - 发现的问题摘要
78
+ - 涉及的文档位置(章节/段落)
79
+ - 修复建议
80
+
81
+ ## 安装(skills.sh)
82
+
83
+ ```bash
84
+ npx skills add visual-req/visual-spec --skill visual-spec-skill
85
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "visual-spec",
3
- "version": "0.1.8",
3
+ "version": "0.1.9",
4
4
  "description": "AI skill: visual-spec-skill (/vspec:* commands) for requirement analysis, prototyping, detailing, testing, and planning.",
5
5
  "license": "MIT",
6
6
  "type": "commonjs",
@@ -10,15 +10,19 @@
10
10
  "scripts": {
11
11
  "postinstall": "node scripts/postinstall.cjs",
12
12
  "install-skill": "node scripts/postinstall.cjs --force",
13
- "dry-run": "node scripts/postinstall.cjs --dry-run"
13
+ "dry-run": "node scripts/postinstall.cjs --dry-run",
14
+ "build-skill": "node scripts/build_skill.cjs"
14
15
  },
15
16
  "files": [
16
17
  "skills/visual-spec-skill/SKILL.md",
17
18
  "skills/visual-spec-skill/SKILL-zh-CN.md",
19
+ "skills/visual-spec-skill/SKILL-ja-JP.md",
18
20
  "skills/visual-spec-skill/prompts/vspec_accept/",
19
21
  "skills/visual-spec-skill/prompts/vspec_detail/",
20
22
  "skills/visual-spec-skill/prompts/vspec_impl/",
21
23
  "skills/visual-spec-skill/prompts/vspec_new/",
24
+ "skills/visual-spec-skill/prompts/vspec_more_q/",
25
+ "skills/visual-spec-skill/prompts/vspec_mrd/",
22
26
  "skills/visual-spec-skill/prompts/vspec_plan/",
23
27
  "skills/visual-spec-skill/prompts/vspec_qc/",
24
28
  "skills/visual-spec-skill/prompts/vspec_refine/",
@@ -0,0 +1,57 @@
1
+ const { spawnSync } = require("node:child_process");
2
+ const fs = require("node:fs");
3
+ const path = require("node:path");
4
+
5
+ function getRepoRoot() {
6
+ return path.resolve(__dirname, "..");
7
+ }
8
+
9
+ function readPackageJson(repoRoot) {
10
+ const packageJsonPath = path.join(repoRoot, "package.json");
11
+ return JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
12
+ }
13
+
14
+ function ensureDir(dirPath) {
15
+ fs.mkdirSync(dirPath, { recursive: true });
16
+ }
17
+
18
+ function main() {
19
+ const repoRoot = getRepoRoot();
20
+ const pkg = readPackageJson(repoRoot);
21
+
22
+ const skillDir = path.join(repoRoot, "skills", "visual-spec-skill");
23
+ if (!fs.existsSync(skillDir)) {
24
+ throw new Error(`Skill dir not found: ${skillDir}`);
25
+ }
26
+
27
+ const distDir = path.join(repoRoot, "dist");
28
+ ensureDir(distDir);
29
+
30
+ const version = pkg.version || "0.0.0";
31
+ const outputPath = path.join(distDir, `visual-spec-skill-${version}.skill`);
32
+
33
+ if (fs.existsSync(outputPath)) {
34
+ fs.rmSync(outputPath);
35
+ }
36
+
37
+ const result = spawnSync(
38
+ "zip",
39
+ ["-r", outputPath, ".", "-x", "*.DS_Store", "-x", "*/.DS_Store"],
40
+ { cwd: skillDir, stdio: "inherit" }
41
+ );
42
+
43
+ if (result.error) {
44
+ throw new Error(
45
+ `Failed to run 'zip'. Please ensure 'zip' is installed and available in PATH. ${result.error.message}`
46
+ );
47
+ }
48
+
49
+ if (result.status !== 0) {
50
+ process.exit(result.status);
51
+ }
52
+
53
+ process.stdout.write(`${outputPath}\n`);
54
+ }
55
+
56
+ main();
57
+