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.
- package/README.md +12 -0
- package/docs/en-US/ai-platform-installation.md +39 -0
- package/docs/en-US/commands.md +4 -2
- package/docs/en-US/getting-started.md +7 -29
- package/docs/en-US/installation.md +4 -39
- package/docs/en-US/scheme.example.yaml +2 -1
- package/docs/en-US/structure.md +2 -3
- package/docs/en-US/workflows.md +4 -4
- package/docs/ja-JP/ai-platform-installation.md +39 -0
- package/docs/ja-JP/commands.md +38 -0
- package/docs/ja-JP/concepts.md +35 -0
- package/docs/ja-JP/getting-started.md +39 -0
- package/docs/ja-JP/installation.md +18 -0
- package/docs/ja-JP/scheme.example.yaml +72 -0
- package/docs/ja-JP/structure.md +49 -0
- package/docs/ja-JP/ui-spec-modification-notes.md +35 -0
- package/docs/ja-JP/workflows.md +40 -0
- package/docs/zh-CN/ai-platform-installation.md +39 -0
- package/docs/zh-CN/commands.md +14 -2
- package/docs/zh-CN/getting-started.md +7 -29
- package/docs/zh-CN/installation.md +4 -39
- package/docs/zh-CN/quality_check.md +33 -0
- package/docs/zh-CN/scheme.example.yaml +2 -1
- package/docs/zh-CN/structure.md +2 -3
- package/docs/zh-CN/workflows.md +28 -4
- package/package.json +6 -2
- package/scripts/build_skill.cjs +57 -0
- package/scripts/transform_quality_standard.py +306 -0
- package/skills/visual-spec-skill/SKILL-ja-JP.md +384 -0
- package/skills/visual-spec-skill/SKILL-zh-CN.md +56 -2
- package/skills/visual-spec-skill/SKILL.md +65 -3
- package/skills/visual-spec-skill/prompts/vspec_accept/accept.md +23 -6
- package/skills/visual-spec-skill/prompts/vspec_detail/auth.md +6 -2
- package/skills/visual-spec-skill/prompts/vspec_detail/code_rules.md +14 -2
- package/skills/visual-spec-skill/prompts/vspec_detail/cron_job.md +29 -8
- package/skills/visual-spec-skill/prompts/vspec_detail/data_permission.md +4 -0
- package/skills/visual-spec-skill/prompts/vspec_detail/decision_matrix.md +20 -4
- package/skills/visual-spec-skill/prompts/vspec_detail/expression_tree.md +34 -6
- package/skills/visual-spec-skill/prompts/vspec_detail/file_export.md +14 -2
- package/skills/visual-spec-skill/prompts/vspec_detail/file_import.md +14 -2
- package/skills/visual-spec-skill/prompts/vspec_detail/formula.md +14 -2
- package/skills/visual-spec-skill/prompts/vspec_detail/interaction.md +21 -4
- package/skills/visual-spec-skill/prompts/vspec_detail/judgemental_matrix.md +22 -4
- package/skills/visual-spec-skill/prompts/vspec_detail/logging_matrix.md +14 -3
- package/skills/visual-spec-skill/prompts/vspec_detail/mq.md +14 -3
- package/skills/visual-spec-skill/prompts/vspec_detail/nfp.md +26 -7
- package/skills/visual-spec-skill/prompts/vspec_detail/notification_matrix.md +14 -3
- package/skills/visual-spec-skill/prompts/vspec_detail/page_load.md +35 -8
- package/skills/visual-spec-skill/prompts/vspec_detail/payment.md +6 -2
- package/skills/visual-spec-skill/prompts/vspec_detail/post_submit_check.md +14 -2
- package/skills/visual-spec-skill/prompts/vspec_detail/post_submit_navigation.md +15 -3
- package/skills/visual-spec-skill/prompts/vspec_detail/post_submit_processing.md +14 -2
- package/skills/visual-spec-skill/prompts/vspec_detail/rbac.md +24 -4
- package/skills/visual-spec-skill/prompts/vspec_detail/state_machine.md +30 -4
- package/skills/visual-spec-skill/prompts/vspec_detail/timeline.md +34 -6
- package/skills/visual-spec-skill/prompts/vspec_detail/validation_matrix.md +14 -3
- package/skills/visual-spec-skill/prompts/vspec_more_q/more_q.md +82 -0
- package/skills/visual-spec-skill/prompts/vspec_mrd/mrd.md +73 -0
- package/skills/visual-spec-skill/prompts/vspec_new/background.md +236 -30
- package/skills/visual-spec-skill/prompts/vspec_new/dependencies.md +28 -6
- package/skills/visual-spec-skill/prompts/vspec_new/details_boundaries.md +17 -7
- package/skills/visual-spec-skill/prompts/vspec_new/details_constraints.md +17 -7
- package/skills/visual-spec-skill/prompts/vspec_new/details_pre_post.md +32 -17
- package/skills/visual-spec-skill/prompts/vspec_new/details_symmetry.md +17 -7
- package/skills/visual-spec-skill/prompts/vspec_new/details_variations.md +17 -7
- package/skills/visual-spec-skill/prompts/vspec_new/flows.md +4 -0
- package/skills/visual-spec-skill/prompts/vspec_new/functions.md +18 -3
- package/skills/visual-spec-skill/prompts/vspec_new/questions.md +30 -2
- package/skills/visual-spec-skill/prompts/vspec_new/roles.md +20 -4
- package/skills/visual-spec-skill/prompts/vspec_new/scenarios.md +9 -2
- package/skills/visual-spec-skill/prompts/vspec_new/stakeholders.md +21 -5
- package/skills/visual-spec-skill/prompts/vspec_new/terms.md +21 -6
- package/skills/visual-spec-skill/prompts/vspec_plan/estimate.md +95 -9
- package/skills/visual-spec-skill/prompts/vspec_plan/schedule.md +36 -3
- package/skills/visual-spec-skill/prompts/vspec_qc/qc.md +17 -3
- package/skills/visual-spec-skill/prompts/vspec_qc/quality_standard.md +769 -26
- package/skills/visual-spec-skill/prompts/vspec_refine/refine.md +48 -23
- package/skills/visual-spec-skill/prompts/vspec_refine/refine_q.md +47 -20
- package/skills/visual-spec-skill/prompts/vspec_test/test.md +4 -0
- package/skills/visual-spec-skill/prompts/vspec_upgrade/upgrade.md +13 -2
- package/skills/visual-spec-skill/prompts/vspec_verify/model.md +49 -24
- package/skills/visual-spec-skill/prompts/vspec_verify/prototype.md +9 -1
- package/skills/visual-spec-skill/prompts/vspec_verify/prototype_calendar.md +16 -4
- /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
package/README.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
This repo provides a requirements analysis and delivery assistant Skill. It offers a `/vspec:*` command-driven workflow that turns raw requirements into reviewable artifacts: specs, data models, runnable prototypes, detailed design, acceptance cases, tests, and integrated implementation inputs.
|
|
2
2
|
|
|
3
|
+
## Installation
|
|
4
|
+
|
|
5
|
+
Install the Skill into your AI editor configuration directory (Trae / Claude Code / Cursor / GitHub Copilot, etc.):
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Docs:
|
|
12
|
+
- Installation: `docs/en-US/installation.md`
|
|
13
|
+
- Multi-agent installation: `docs/en-US/ai-platform-installation.md`
|
|
14
|
+
|
|
3
15
|
## Overview
|
|
4
16
|
|
|
5
17
|
- Requirements analysis: generate background, stakeholders, roles, terms, flows, scenarios, details, dependencies, function list, and open questions
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Multi-Agent Installation Guide
|
|
2
|
+
|
|
3
|
+
Recommended: use the official skills.sh installer (the skills CLI). It can install the same Skill to different AI platforms (Trae / Claude Code / Cursor / GitHub Copilot, etc.) by placing it into the correct skills directory.
|
|
4
|
+
|
|
5
|
+
## Option 1: skills.sh (Recommended)
|
|
6
|
+
|
|
7
|
+
The installer can auto-detect supported agents and prompt you for installation scope (project vs global).
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Target a specific agent (examples):
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Trae (project scope)
|
|
17
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill -a trae
|
|
18
|
+
|
|
19
|
+
# Claude Code (project scope)
|
|
20
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill -a claude-code
|
|
21
|
+
|
|
22
|
+
# Cursor (project scope)
|
|
23
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill -a cursor
|
|
24
|
+
|
|
25
|
+
# GitHub Copilot (project scope)
|
|
26
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill -a github-copilot
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Global install (available across all projects for the current user):
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill -g
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
List skills in this repository:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npx skills add visual-req/visual-spec --list
|
|
39
|
+
```
|
package/docs/en-US/commands.md
CHANGED
|
@@ -5,20 +5,22 @@
|
|
|
5
5
|
| `/vspec:new` | Generate baseline spec artifacts from raw requirements | Raw requirement text + interactive Q&A | `/specs/` (original, stakeholders, roles, terms, flows, scenarios, scenario_details, dependencies, functions, questions) + initializes `/docs/*` archive directories |
|
|
6
6
|
| `/vspec:refine` | Apply refinement materials and sync impacted details and prototypes | `/docs/refine/*` (or command args) + baseline `/specs/background/original.md` + prerequisite `/specs/details/` | Appends to `/specs/background/original.md` (change list + canonical) + updates impacted `/specs/details/` and `/specs/prototypes/` |
|
|
7
7
|
| `/vspec:refine-q` | Merge answered questions back into the requirement | `/specs/background/original.md` + `/specs/background/questions.md` | Appends to `/specs/background/original.md` (adopted items + change list + canonical) |
|
|
8
|
+
| `/vspec:more-q` | Append more clarification questions | `/specs/background/original.md` + `/specs/background/questions.md` | Appends new items to `/specs/background/questions.md` (with answering guidance) |
|
|
8
9
|
| `/vspec:detail` | Expand per-function detailed specs | `/specs/functions/*` + supporting artifacts (background/flows/roles; models if any) | `/specs/details/<function_slug>/*` (RBAC, interaction, validation, logging, notifications, MQ, import/export, cron, etc.) |
|
|
9
10
|
| `/vspec:verify` | Generate models and prototype for fast validation | Existing `/specs/` artifacts (functions + details + roles) | `/specs/models/*.md`, `/specs/prototypes/` (stack-selected runnable prototype + `scenario.html` review page) |
|
|
10
11
|
| `/vspec:accept` | Generate acceptance test cases | functions/scenarios/details/roles/models | `/specs/acceptance/<function_slug>/acceptance_cases.md`, `/specs/acceptance/index.md` |
|
|
11
12
|
| `/vspec:append-test` | Generate automated test code | acceptance cases + repo test stack | Writes into existing test directories or `/tests/` |
|
|
12
13
|
| `/vspec:impl` | Generate integrated backend + frontend implementation | specs/details/models/dependencies | Writes integrated implementation code (API contract, backend, frontend integration) |
|
|
13
14
|
| `/vspec:upgrade` | Analyze and generate new specs based on legacy materials | `/docs/current/file_list.md` + `/docs/legacy/*` (optional templates/texts/assets) + existing `/specs/background/original.md` (if any) | Generate/update `/specs/` in `/vspec:new` structure + sync technical selections to `/scheme.yaml` |
|
|
14
|
-
| `/vspec:qc` | Run quality checks on `/specs/` artifacts | built-in standard + optional project `quality_standard.md` + `/specs/` | `/specs/qc_report.md` |
|
|
15
|
+
| `/vspec:qc` | Run quality checks on `/specs/` artifacts | built-in standard + optional `domain_quality_standard.md` + optional project `quality_standard.md` + `/specs/` | `/specs/qc_report.md` |
|
|
15
16
|
| `/vspec:plan` | Estimation and scheduling | functions/roles/flows/dependencies/details | `/specs/plan/plan_estimate.md`, `/specs/plan/plan_schedule.html` |
|
|
17
|
+
| `/vspec:mrd` | Generate MRD market pack | `/specs/background/*` + `/specs/flows/*` + `/specs/functions/*` (if any) | `/docs/market/*.md` (market/competitors/users/product_design) |
|
|
16
18
|
|
|
17
19
|
## `/vspec:new`
|
|
18
20
|
|
|
19
21
|
- When to use: you just received the requirement and information is incomplete; you need a shared language and a first-cut spec quickly
|
|
20
22
|
- Key outputs: stakeholders, roles, terms, flows, scenarios, function list, open questions
|
|
21
|
-
- Directory initialization: creates `/docs/` and its subdirectories (legacy/current/
|
|
23
|
+
- Directory initialization: creates `/docs/` and its subdirectories (legacy/current/refine/templates/texts/assets) for input archiving and future command inputs
|
|
22
24
|
|
|
23
25
|
## `/vspec:refine`
|
|
24
26
|
|
|
@@ -4,39 +4,22 @@ This package provides a `/vspec:*` command-driven Skill that turns raw requireme
|
|
|
4
4
|
|
|
5
5
|
### 1. Installation
|
|
6
6
|
|
|
7
|
-
Install the
|
|
7
|
+
Install the Skill into your AI editor configuration directory:
|
|
8
8
|
|
|
9
9
|
- Installation and verification: `installation.md`
|
|
10
10
|
|
|
11
|
-
Install / update (
|
|
11
|
+
Install / update (skills.sh):
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
Install / update (pnpm):
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
pnpm add -g visual-spec@latest
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
Install / update (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. Recommended Workflow
|
|
38
18
|
|
|
39
19
|
- Initial spec: `/vspec:new`
|
|
20
|
+
- Optional language:
|
|
21
|
+
- Single language: `/vspec:new lang=zh-CN` (or `lang=en`, `lang=ja`) sets `/scheme.yaml` `selected.language` and generates docs in that language
|
|
22
|
+
- Multi-language (prototype switch): `/vspec:new lang=zh-CN,en` sets docs default to `zh-CN` and sets `/scheme.yaml` `selected.languages` for prototype UI language switching
|
|
40
23
|
- Midway it generates the canonical requirement file (`/specs/background/original.md`) and asks clarification questions
|
|
41
24
|
- Answer those questions in chat first, then type “continue” to finish `/vspec:new` (do not write these clarification answers into `questions.md`)
|
|
42
25
|
- It also generates an open question list (`/specs/background/questions.md`) for later merging
|
|
@@ -51,7 +34,7 @@ yarn dlx -p visual-spec@latest vspec
|
|
|
51
34
|
|
|
52
35
|
### 3. Key Directories
|
|
53
36
|
|
|
54
|
-
- `/docs/`: input archive (legacy/current/
|
|
37
|
+
- `/docs/`: input archive (legacy/current/refine/templates/texts/assets)
|
|
55
38
|
- `/specs/`: generated artifacts (background/details/models/prototypes/acceptance, etc.)
|
|
56
39
|
- `/scheme.yaml`: stack and package manager selection (prototype and implementation must follow it)
|
|
57
40
|
|
|
@@ -72,11 +55,6 @@ Next:
|
|
|
72
55
|
- Run: `/vspec:refine`
|
|
73
56
|
- Result: appends updates to `/specs/background/original.md` and syncs impacted `/specs/details/` and `/specs/prototypes/`
|
|
74
57
|
|
|
75
|
-
#### Changes (`change`)
|
|
76
|
-
|
|
77
|
-
- Put change materials into `/docs/change/` (optional `file_list.md`)
|
|
78
|
-
- Result: performs impact analysis, updates artifacts (prefers `/specs/details/<module_slug>/`), and updates the change log
|
|
79
|
-
|
|
80
58
|
#### Upgrade/Redesign (`upgrade`)
|
|
81
59
|
|
|
82
60
|
- List input materials in `/docs/current/file_list.md` (legacy system under `/docs/legacy/`, new inputs under `/docs/current/`)
|
|
@@ -1,53 +1,18 @@
|
|
|
1
1
|
## Install into Skill-Enabled AI Editors
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Recommended: use the official skills.sh installer (the skills CLI) to install into a Skill-enabled AI editor (Trae / Qwen / Kiro, etc.). The installer can auto-detect available agents and place `visual-spec-skill` into the correct `skills/` directory.
|
|
4
4
|
|
|
5
5
|
### Prerequisites
|
|
6
6
|
|
|
7
7
|
- Node.js >= 14
|
|
8
8
|
|
|
9
|
-
### Install / Update (
|
|
9
|
+
### Install / Update (Recommended: skills.sh)
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
### Install / Update (pnpm)
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
pnpm add -g visual-spec@latest
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
### Install / Update (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
|
-
### Install to a Custom Directory (`--target-skills-dir`)
|
|
36
|
-
|
|
37
|
-
By default, the install script copies the Skill into `.trae/skills/visual-spec-skill` under the current working directory. If you need to install into a custom `skills/` directory (for example, a shared editor config directory), run:
|
|
38
|
-
|
|
39
|
-
```bash
|
|
40
|
-
vspec --target-skills-dir /path/to/skills --force
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Notes:
|
|
44
|
-
- `--target-skills-dir` should point to the `skills/` directory; the installer will append `visual-spec-skill/`.
|
|
45
|
-
- You can also pass a full target directory (including `visual-spec-skill`) via `--target-skill-dir`:
|
|
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
|
### Next
|
|
52
16
|
|
|
53
17
|
- Getting started: `getting-started.md`
|
|
18
|
+
- Multi-agent installation: `ai-platform-installation.md`
|
|
@@ -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 # default output language: en | zh-CN | ja
|
|
11
|
+
languages: [en] # optional supported languages for prototype switching, e.g. [zh-CN, en]
|
|
11
12
|
|
|
12
13
|
prototype_options:
|
|
13
14
|
calendar_view:
|
package/docs/en-US/structure.md
CHANGED
|
@@ -14,8 +14,7 @@ The Skill generates artifacts under `/specs/` (incrementally by command stage) a
|
|
|
14
14
|
│ ├─ legacy/ # Legacy system materials (features, permissions, interactions, APIs, etc.)
|
|
15
15
|
│ ├─ current/ # New/additional materials for this iteration (goals, deltas, flows, UI constraints, etc.)
|
|
16
16
|
│ │ └─ file_list.md # Upgrade entry list (/vspec:upgrade reads/generates)
|
|
17
|
-
│ ├─
|
|
18
|
-
│ │ └─ file_list.md # Optional ordered input list
|
|
17
|
+
│ ├─ dependencies/ # External systems library (existing dependency docs; optional but recommended)
|
|
19
18
|
│ ├─ refine/ # Refinement inputs (/vspec:refine reads)
|
|
20
19
|
│ │ └─ file_list.md # Optional ordered input list
|
|
21
20
|
│ ├─ templates/ # Templates (PRD/copy/UI/table templates, optional)
|
|
@@ -66,7 +65,7 @@ The Skill generates artifacts under `/specs/` (incrementally by command stage) a
|
|
|
66
65
|
```
|
|
67
66
|
|
|
68
67
|
Notes:
|
|
69
|
-
- `docs/`: archive business inputs and delivery alignment materials. Use subdirectories like `legacy/current/
|
|
68
|
+
- `docs/`: archive business inputs and delivery alignment materials. Use subdirectories like `legacy/current/dependencies/refine/templates/texts/assets` and include source/version in filenames.
|
|
70
69
|
- `scheme.yaml`: selects the stack and options used by `/vspec:verify` and `/vspec:impl`. It reads `scheme.yaml` at the project root first, then `/specs/scheme.yaml`. If neither exists, it creates a default `scheme.yaml`.
|
|
71
70
|
|
|
72
71
|
Next:
|
package/docs/en-US/workflows.md
CHANGED
|
@@ -54,8 +54,8 @@ Optional: segmented prototype generation
|
|
|
54
54
|
- `/specs/plan/plan_estimate.md`
|
|
55
55
|
- `/specs/plan/plan_schedule.html`
|
|
56
56
|
|
|
57
|
-
## Installation (
|
|
57
|
+
## Installation (skills.sh)
|
|
58
58
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
59
|
+
```bash
|
|
60
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill
|
|
61
|
+
```
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# 複数 AI プラットフォーム向けインストールガイド
|
|
2
|
+
|
|
3
|
+
推奨:skills.sh の公式インストーラ(skills CLI)を利用します。同一の Skill を、Trae / Claude Code / Cursor / GitHub Copilot など複数の AI プラットフォームに対して、それぞれの `skills/` ディレクトリへインストールできます。
|
|
4
|
+
|
|
5
|
+
## 方法 1:skills.sh(推奨)
|
|
6
|
+
|
|
7
|
+
インストーラは利用可能な agent を自動検出し、プロジェクト単位/グローバル単位のインストールも選択できます。
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
特定の agent を指定する例:
|
|
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
|
+
```
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
## コマンド一覧
|
|
2
|
+
|
|
3
|
+
| コマンド | 目的 | 主な入力 | 主な出力 |
|
|
4
|
+
| --- | --- | --- | --- |
|
|
5
|
+
| `/vspec:new` | 生要件からベースライン spec を生成 | 要件テキスト + 対話 Q&A | `/specs/`(background/roles/terms/flows/scenarios/scenario_details/dependencies/functions/questions)+ `/docs/*` の初期化 |
|
|
6
|
+
| `/vspec:refine` | 追補資料を反映し、詳細と原型を同期更新 | `/docs/refine/*`(または引数)+ `/specs/background/original.md` + `/specs/details/` | `original.md` に追記(変更点 + 新口径)+ 影響範囲の `/specs/details/` と `/specs/prototypes/` 更新 |
|
|
7
|
+
| `/vspec:refine-q` | questions の回答を要件へ取り込み | `/specs/background/original.md` + `/specs/background/questions.md` | `original.md` に追記(採用項目 + 変更点 + 新口径) |
|
|
8
|
+
| `/vspec:more-q` | 質問の追加生成(追補) | `/specs/background/original.md` + `/specs/background/questions.md` | `questions.md` へ追記(回答手順付き) |
|
|
9
|
+
| `/vspec:detail` | 機能ごとの実装可能レベルの詳細 spec を生成 | `/specs/functions/*` + 関連成果物 | `/specs/details/<function_slug>/*` |
|
|
10
|
+
| `/vspec:verify` | モデルと実行可能プロトタイプを生成 | 既存 `/specs/`(functions + details + roles) | `/specs/models/*.md`、`/specs/prototypes/`(原型 + `scenario.html`) |
|
|
11
|
+
| `/vspec:accept` | 受入テストケースを生成 | functions/scenarios/details/roles/models | `/specs/acceptance/<function_slug>/acceptance_cases.md`、`/specs/acceptance/index.md` |
|
|
12
|
+
| `/vspec:append-test` | 自動テストコードを生成 | acceptance + リポジトリのテストスタック | 既存テストディレクトリ(なければ `/tests/`)に書き込み |
|
|
13
|
+
| `/vspec:impl` | バックエンド + フロントエンドの統合実装を生成 | specs/details/models/dependencies | 統合実装コード(API 契約、backend、frontend 連携) |
|
|
14
|
+
| `/vspec:upgrade` | 既存資料から specs を再生成/更新 | `/docs/current/file_list.md` + `/docs/legacy/*` + 既存 `original.md`(任意) | `/specs/` 更新 + `/scheme.yaml` に選定内容同期 |
|
|
15
|
+
| `/vspec:qc` | `/specs/` の品質チェック | 組み込み標準 + 任意 `domain_quality_standard.md` + 任意 `quality_standard.md` | `/specs/qc_report.md` |
|
|
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` |
|
|
18
|
+
|
|
19
|
+
## `/vspec:new`
|
|
20
|
+
|
|
21
|
+
- 使いどころ:情報が揃っていない段階で、レビュー可能な共通言語を素早く作る
|
|
22
|
+
- 主な出力:ステークホルダー、ロール、用語、フロー、シナリオ、機能一覧、未解決質問
|
|
23
|
+
- ディレクトリ初期化:`/docs/` とその配下(legacy/current/refine/templates/texts/assets)を作成
|
|
24
|
+
|
|
25
|
+
## `/vspec:detail`
|
|
26
|
+
|
|
27
|
+
- 使いどころ:設計・実装前に、各機能を実装可能な粒度まで落とし込む
|
|
28
|
+
- 主な出力:RBAC(コントロール単位)、データ権限、ロード/操作/バリデーション、状態遷移、ログ/通知、MQ、入出力、定期実行
|
|
29
|
+
|
|
30
|
+
## `/vspec:verify`
|
|
31
|
+
|
|
32
|
+
- 使いどころ:詳細が揃った後、モデルと画面形状を早期に検証し認識齟齬を減らす
|
|
33
|
+
- 前提:`/specs/details/` が存在し空でないこと
|
|
34
|
+
|
|
35
|
+
## `/vspec:append-test`
|
|
36
|
+
|
|
37
|
+
- 使いどころ:受入ケースを、実行可能な自動テストへ落とす
|
|
38
|
+
- 注意:このコマンドはテストコードの生成/追記のみ(テスト実行はしない)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
## 設計原則
|
|
2
|
+
|
|
3
|
+
### 1. 成果物で合意する
|
|
4
|
+
|
|
5
|
+
- 「会話」を「レビュー可能な成果物」に変換して、認識合わせのコストを下げる
|
|
6
|
+
- 成果物は段階的に深くなる:要件 → specs(`/specs`)→ models → prototype → details → acceptance/tests/code
|
|
7
|
+
|
|
8
|
+
### 2. シナリオ駆動で分解する
|
|
9
|
+
|
|
10
|
+
- apply/approve/cancel/change/execute などのノード連鎖で、主経路とロールバック経路を網羅
|
|
11
|
+
- 各機能は「実行可能な操作 + 検証可能な期待結果」にマッピングされるべき
|
|
12
|
+
|
|
13
|
+
### 3. RBAC とデータ権限を先に設計する
|
|
14
|
+
|
|
15
|
+
- 画面は見えても操作できない、を防ぐためコントロール単位まで RBAC を落とす
|
|
16
|
+
- データ権限を独立に設計し、RBAC と合成する
|
|
17
|
+
|
|
18
|
+
### 4. 実装に落ちる詳細にする
|
|
19
|
+
|
|
20
|
+
- ロード/操作/送信後の挙動をチェックリストや表で表現し、実装とレビューを容易にする
|
|
21
|
+
- バリデーション/ログ/通知はマトリクスで抜け漏れと追跡可能性を担保する
|
|
22
|
+
|
|
23
|
+
### 5. 一貫性と観測性をデフォルトにする
|
|
24
|
+
|
|
25
|
+
- 外部依存、リトライ、補償、監査ログなどを明示的に扱う
|
|
26
|
+
- trace_id/request_id、監査、アラートなどを前提にする
|
|
27
|
+
|
|
28
|
+
### 6. Acceptance → Automation → Integration
|
|
29
|
+
|
|
30
|
+
- 受入ケースを開発と QA の共通言語にする
|
|
31
|
+
- 既存のテストフレームワーク/ディレクトリ規約を優先して保守負担を下げる
|
|
32
|
+
|
|
33
|
+
### 7. 変更しやすい要件
|
|
34
|
+
|
|
35
|
+
- 要件ドキュメントは編集しやすく、読みやすく、問題点を見つけやすく、素早く修正できるべき
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
## クイックスタート
|
|
2
|
+
|
|
3
|
+
このパッケージは `/vspec:*` コマンド駆動の Skill を提供します。生の要件から、レビュー可能な成果物(spec、データモデル、実行可能プロトタイプ、詳細設計、受入用ケース、テスト、実装入力)へ変換します。
|
|
4
|
+
|
|
5
|
+
### 1. インストール
|
|
6
|
+
|
|
7
|
+
- インストール:`installation.md`
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
### 2. 推奨フロー
|
|
14
|
+
|
|
15
|
+
- 初期 spec:`/vspec:new`
|
|
16
|
+
- 言語(任意):
|
|
17
|
+
- 単一言語:`/vspec:new lang=zh-CN`(または `lang=en`、`lang=ja`)。`/scheme.yaml` `selected.language` を設定し、文書成果物をその言語で統一します
|
|
18
|
+
- 多言語(プロトタイプ切替):`/vspec:new lang=zh-CN,en`。文書の既定言語を `zh-CN` にし、`/scheme.yaml` `selected.languages` を切替用言語集合として設定します
|
|
19
|
+
- 実行中に要件口径(`/specs/background/original.md`)を生成し、確認質問を提示
|
|
20
|
+
- まずチャットで回答し、その後「continue」と入力して `/vspec:new` を完了
|
|
21
|
+
- Q&A を要件へ反映:`/vspec:refine-q`(`/specs/background/questions.md` の回答済み項目を `original.md` に取り込む)
|
|
22
|
+
- 品質チェック:`/vspec:qc`(`/specs/qc_report.md` を出力)
|
|
23
|
+
- 詳細設計:`/vspec:detail`(RBAC/データ権限/画面のロード・操作・バリデーション等)
|
|
24
|
+
- 検証(モデル + 原型):`/vspec:verify`(`/specs/details/` が必要)
|
|
25
|
+
- 受入ケース:`/vspec:accept`
|
|
26
|
+
- 自動テスト生成:`/vspec:append-test`
|
|
27
|
+
- 実装入力/統合コード:`/vspec:impl`
|
|
28
|
+
- 既存資産からのアップグレード:`/vspec:upgrade`
|
|
29
|
+
- 見積・スケジュール:`/vspec:plan`
|
|
30
|
+
|
|
31
|
+
### 3. 主要ディレクトリ
|
|
32
|
+
|
|
33
|
+
- `/docs/`:入力アーカイブ(legacy/current/refine/templates/texts/assets)
|
|
34
|
+
- `/specs/`:生成成果物
|
|
35
|
+
- `/scheme.yaml`:スタック選択(プロトタイプと実装が従う)
|
|
36
|
+
|
|
37
|
+
参照:
|
|
38
|
+
|
|
39
|
+
- `structure.md`
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
## Skill 対応 AI エディタへのインストール
|
|
2
|
+
|
|
3
|
+
推奨:skills.sh の公式インストーラ(skills CLI)を使って、Skill 対応の AI エディタ(Trae / Qwen / Kiro など)へインストールします。インストーラは利用可能な agent を自動検出し、`visual-spec-skill` を適切な `skills/` ディレクトリへ配置します。
|
|
4
|
+
|
|
5
|
+
### 前提条件
|
|
6
|
+
|
|
7
|
+
- Node.js >= 14
|
|
8
|
+
|
|
9
|
+
### インストール / 更新(推奨:skills.sh)
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### 次へ
|
|
16
|
+
|
|
17
|
+
- クイックスタート:`getting-started.md`
|
|
18
|
+
- 複数 AI プラットフォーム向けインストール:`ai-platform-installation.md`
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
schema_version: 1
|
|
2
|
+
|
|
3
|
+
selected:
|
|
4
|
+
prototype_frontend_stack: vue3_vite_ts_antdv
|
|
5
|
+
prototype_frontend_framework: vue
|
|
6
|
+
prototype_frontend_ui_library: ant-design-vue
|
|
7
|
+
prototype_backend_stack: java17_springboot3
|
|
8
|
+
prototype_database: mysql8
|
|
9
|
+
package_manager: npm
|
|
10
|
+
language: en # デフォルト言語:en | zh-CN | ja
|
|
11
|
+
languages: [en] # 任意:プロトタイプ言語切替用(例:[zh-CN, en])
|
|
12
|
+
|
|
13
|
+
prototype_options:
|
|
14
|
+
calendar_view:
|
|
15
|
+
enabled: auto
|
|
16
|
+
view_default: month
|
|
17
|
+
resource_dimension: auto
|
|
18
|
+
|
|
19
|
+
catalog:
|
|
20
|
+
prototype_frontend_stacks:
|
|
21
|
+
- id: vue3_vite_ts_antdv
|
|
22
|
+
name: Vue 3 + Vite + TypeScript + Ant Design Vue
|
|
23
|
+
framework: vue
|
|
24
|
+
framework_version: "3"
|
|
25
|
+
build_tool: vite
|
|
26
|
+
language: typescript
|
|
27
|
+
ui_library: ant-design-vue
|
|
28
|
+
router: vue-router@4
|
|
29
|
+
state: pinia
|
|
30
|
+
http_client: axios
|
|
31
|
+
charting: echarts
|
|
32
|
+
date_library: dayjs
|
|
33
|
+
styling: less
|
|
34
|
+
lint: eslint
|
|
35
|
+
formatter: prettier
|
|
36
|
+
unit_test: vitest
|
|
37
|
+
e2e_test: playwright
|
|
38
|
+
|
|
39
|
+
- id: react18_vite_ts_antd
|
|
40
|
+
name: React 18 + Vite + TypeScript + Ant Design
|
|
41
|
+
framework: react
|
|
42
|
+
framework_version: "18"
|
|
43
|
+
build_tool: vite
|
|
44
|
+
language: typescript
|
|
45
|
+
ui_library: antd
|
|
46
|
+
router: react-router@6
|
|
47
|
+
state: redux-toolkit
|
|
48
|
+
http_client: axios
|
|
49
|
+
charting: echarts-for-react
|
|
50
|
+
date_library: dayjs
|
|
51
|
+
styling: less
|
|
52
|
+
lint: eslint
|
|
53
|
+
formatter: prettier
|
|
54
|
+
unit_test: vitest
|
|
55
|
+
e2e_test: playwright
|
|
56
|
+
|
|
57
|
+
prototype_backend_stacks:
|
|
58
|
+
- id: java17_springboot3
|
|
59
|
+
name: Java 17 + Spring Boot 3
|
|
60
|
+
language: java
|
|
61
|
+
framework: spring-boot
|
|
62
|
+
api_style: rest
|
|
63
|
+
auth: spring-security-jwt
|
|
64
|
+
orm: jpa_or_mybatis
|
|
65
|
+
|
|
66
|
+
- id: node18_nestjs10_ts
|
|
67
|
+
name: Node.js 18 + NestJS 10 + TypeScript
|
|
68
|
+
language: typescript
|
|
69
|
+
framework: nestjs
|
|
70
|
+
api_style: rest
|
|
71
|
+
auth: jwt
|
|
72
|
+
orm: prisma
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# ディレクトリ構成
|
|
2
|
+
|
|
3
|
+
このドキュメントは、対象プロジェクトで使うディレクトリ構成(Skill が生成する `/specs/` ツリー等)を説明します。
|
|
4
|
+
|
|
5
|
+
## 典型構成
|
|
6
|
+
|
|
7
|
+
```text
|
|
8
|
+
<your-project>/
|
|
9
|
+
├─ docs/ # 入力アーカイブ(/vspec:new が作成)
|
|
10
|
+
│ ├─ legacy/ # 既存/レガシー資料
|
|
11
|
+
│ ├─ current/ # 今回の入力資料
|
|
12
|
+
│ │ └─ file_list.md # upgrade の入力一覧(/vspec:upgrade)
|
|
13
|
+
│ ├─ refine/ # 追補資料(/vspec:refine)
|
|
14
|
+
│ │ └─ file_list.md # 任意の入力順序リスト
|
|
15
|
+
│ ├─ templates/ # テンプレート(任意)
|
|
16
|
+
│ ├─ texts/ # 文言(任意)
|
|
17
|
+
│ └─ assets/ # 画像等(任意)
|
|
18
|
+
├─ scheme.yaml # スタック選択(/vspec:verify, /vspec:impl)
|
|
19
|
+
└─ specs/
|
|
20
|
+
├─ background/
|
|
21
|
+
│ ├─ original.md
|
|
22
|
+
│ ├─ stakeholders.md
|
|
23
|
+
│ ├─ roles.md
|
|
24
|
+
│ ├─ terms.md
|
|
25
|
+
│ ├─ scenarios.md
|
|
26
|
+
│ ├─ scenario_details/
|
|
27
|
+
│ ├─ dependencies.md
|
|
28
|
+
│ └─ questions.md
|
|
29
|
+
├─ flows/
|
|
30
|
+
│ └─ *.puml
|
|
31
|
+
├─ functions/
|
|
32
|
+
│ └─ *.md
|
|
33
|
+
├─ details/
|
|
34
|
+
│ └─ <module_slug>/
|
|
35
|
+
├─ models/
|
|
36
|
+
│ └─ *.md
|
|
37
|
+
├─ prototypes/
|
|
38
|
+
│ └─ ...
|
|
39
|
+
├─ acceptance/
|
|
40
|
+
│ ├─ index.md
|
|
41
|
+
│ └─ ...
|
|
42
|
+
├─ qc_report.md
|
|
43
|
+
└─ plan/
|
|
44
|
+
├─ plan_estimate.md
|
|
45
|
+
└─ plan_schedule.html
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
補足:
|
|
49
|
+
- `scheme.yaml` はプロジェクトルートを優先し、なければ `/specs/scheme.yaml` を参照します。
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
## 背景
|
|
2
|
+
|
|
3
|
+
プロトタイプ(Web + Mobile)が拡大すると、ページ数と種類が増えます。UI 規約が統一されていないと、次の問題が起きやすくなります:
|
|
4
|
+
|
|
5
|
+
- 似たページ間でレイアウトが不統一(テーブル/フォーム/詳細)
|
|
6
|
+
- ステータスの色や文言が不統一
|
|
7
|
+
- Web と Mobile の見た目・表現が分断される
|
|
8
|
+
- 操作パターンが不統一(作成導線、Drawer/Modal の使い分けなど)
|
|
9
|
+
|
|
10
|
+
これを防ぐため、プロトタイプ生成は編集可能な UI 規約ファイル `/prototype_ui_convention.md` によって制約されます。
|
|
11
|
+
|
|
12
|
+
## 変更点
|
|
13
|
+
|
|
14
|
+
- プロジェクトレベルの制約ファイル `/prototype_ui_convention.md` を追加(`/scheme.yaml` と同じ階層)
|
|
15
|
+
- `/vspec:verify` がプロトタイプを生成/更新する際:
|
|
16
|
+
- `/prototype_ui_convention.md` がなければ、まずテンプレートを生成(既存ファイルは上書きしない)
|
|
17
|
+
- 以後の UI 生成は `/prototype_ui_convention.md` に従う
|
|
18
|
+
- より厳格な既存ルール(例:`/docs/current/ui_spec.md`)があれば `/prototype_ui_convention.md` に統合し、統合後のファイルを最終ソースにする
|
|
19
|
+
|
|
20
|
+
## UI 規約の変更方法
|
|
21
|
+
|
|
22
|
+
- 対象プロジェクトのルートで `/prototype_ui_convention.md` を編集
|
|
23
|
+
- 実装詳細よりも規約を更新する:
|
|
24
|
+
- 色/ステータスの対応表
|
|
25
|
+
- テーブル/フォーム/詳細の共通構造
|
|
26
|
+
- Drawer/Modal の利用ルール
|
|
27
|
+
- タイポグラフィと余白(Web/Mobile)
|
|
28
|
+
- 文言とフィードバック(成功/失敗/権限/空/エラー状態)
|
|
29
|
+
- 変更後に `/vspec:verify` を再実行して、生成/更新ページを規約に揃える
|
|
30
|
+
|
|
31
|
+
## 非推奨
|
|
32
|
+
|
|
33
|
+
- 規約をページごとの例外集にしない(全体の一貫性が崩れる)
|
|
34
|
+
- プロジェクトの選定スタックにない UI ライブラリを導入しない
|
|
35
|
+
- ページ単位で色/サイズを大量に固定しない(少数のトークンと構造ルールを優先)
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
## ワークフロー
|
|
2
|
+
|
|
3
|
+
### 1. 要件分析(`/vspec:new`)
|
|
4
|
+
|
|
5
|
+
- 生の要件を入力
|
|
6
|
+
- 前提・範囲・ルール・依存関係などの確認質問に回答
|
|
7
|
+
- `/specs/` にベースライン成果物(roles/terms/flows/scenarios/functions/dependencies/questions)を生成
|
|
8
|
+
|
|
9
|
+
### 2. 詳細 spec(`/vspec:detail`)
|
|
10
|
+
|
|
11
|
+
- `/specs/functions/*` を入力に、機能ごとの仕様を `/specs/details/<function_slug>/` に生成
|
|
12
|
+
- 目標:要件を実装可能な設計入力へ変換
|
|
13
|
+
|
|
14
|
+
### 3. 検証(`/vspec:verify`)
|
|
15
|
+
|
|
16
|
+
- 前提:`/specs/details/` が存在し空でない
|
|
17
|
+
- `/specs/models/*.md` と、`/scheme.yaml` の選択に従った実行可能プロトタイプを `/specs/prototypes/` に生成
|
|
18
|
+
|
|
19
|
+
### 4. 受入ケース(`/vspec:accept`)
|
|
20
|
+
|
|
21
|
+
- `/specs/acceptance/` に受入テストケースを生成
|
|
22
|
+
|
|
23
|
+
### 5. 自動テスト(`/vspec:append-test`)
|
|
24
|
+
|
|
25
|
+
- 受入ケースと既存テストスタックを読み、E2E/API/単体テストの最小セットを生成
|
|
26
|
+
- 注意:テスト実行は行わず、コード生成/追記のみ
|
|
27
|
+
|
|
28
|
+
### 6. 統合実装(`/vspec:impl`)
|
|
29
|
+
|
|
30
|
+
- specs/details/models/dependencies を読み、リポジトリの規約に沿った統合コードを生成
|
|
31
|
+
|
|
32
|
+
### 7. 見積・排期(`/vspec:plan`)
|
|
33
|
+
|
|
34
|
+
- 機能一覧とシナリオをもとに見積・排期(HTML)を生成
|
|
35
|
+
|
|
36
|
+
## インストール(skills.sh)
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npx skills add visual-req/visual-spec --skill visual-spec-skill
|
|
40
|
+
```
|