spec-runner 1.6.0 → 1.8.0
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/bin/spec-runner-installer.js +7 -85
- package/package.json +1 -1
- package/spec-runner/templates/.claude/rules/agent-delegation.md +1 -0
- package/spec-runner/templates/.claude/rules/design-docs.md +34 -26
- package/spec-runner/templates/.claude/skills/architecture-definition/SKILL.md +12 -4
- package/spec-runner/templates/.claude/skills/architecture-skill-development/SKILL.md +40 -20
- package/spec-runner/templates/.claude/skills/ddd-seed/SKILL.md +11 -12
- package/spec-runner/templates/.claude/skills/ddd-seed/templates/01_/350/246/201/344/273/266/345/256/232/347/276/251//343/203/246/343/203/223/343/202/255/343/202/277/343/202/271/350/250/200/350/252/236/350/276/236/346/233/270.md +1 -1
- package/spec-runner/templates/.claude/skills/ddd-seed/templates/01_/350/246/201/344/273/266/345/256/232/347/276/251//350/246/201/344/273/266/345/256/232/347/276/251.md +1 -1
- package/spec-runner/templates/.claude/skills/ddd-seed/templates/02_/346/246/202/350/246/201/350/250/255/350/250/210//343/203/211/343/203/241/343/202/244/343/203/263/343/203/242/343/203/207/343/203/253.md +1 -1
- package/spec-runner/templates/.claude/skills/ddd-seed/templates/02_/346/246/202/350/246/201/350/250/255/350/250/210//343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271/344/270/200/350/246/247.md +1 -1
- package/spec-runner/templates/.claude/skills/ddd-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/02_/343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271/UC-{/346/227/245/346/234/254/350/252/236/345/220/215}.md +0 -15
- package/spec-runner/templates/.claude/skills/design-change/SKILL.md +35 -20
- package/spec-runner/templates/.claude/skills/existing-project-to-docs/SKILL.md +45 -24
- package/spec-runner/templates/.claude/skills/frontend-seed/SKILL.md +121 -0
- package/spec-runner/templates/.claude/skills/frontend-seed/templates/01_/350/246/201/344/273/266/345/256/232/347/276/251//350/246/201/344/273/266/345/256/232/347/276/251.md +35 -0
- package/spec-runner/templates/.claude/skills/frontend-seed/templates/02_/346/246/202/350/246/201/350/250/255/350/250/210//343/202/263/343/203/263/343/203/235/343/203/274/343/203/215/343/203/263/343/203/210/344/270/200/350/246/247.md +19 -0
- package/spec-runner/templates/.claude/skills/frontend-seed/templates/02_/346/246/202/350/246/201/350/250/255/350/250/210//347/224/273/351/235/242/344/270/200/350/246/247.md +25 -0
- package/spec-runner/templates/.claude/skills/frontend-seed/templates/02_/346/246/202/350/246/201/350/250/255/350/250/210//347/224/273/351/235/242/351/201/267/347/247/273/345/233/263.md +23 -0
- package/spec-runner/templates/.claude/skills/frontend-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/01_/347/224/273/351/235/242/{/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/{/347/224/273/351/235/242/345/220/215}.md +65 -0
- package/spec-runner/templates/.claude/skills/frontend-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/02_/343/202/263/343/203/263/343/203/235/343/203/274/343/203/215/343/203/263/343/203/210/{/343/202/263/343/203/263/343/203/235/343/203/274/343/203/215/343/203/263/343/203/210/345/220/215}.md +41 -0
- package/spec-runner/templates/.claude/skills/frontend-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/90_ADR/ADR-{/346/227/245/346/234/254/350/252/236/345/220/215}.md +46 -0
- package/spec-runner/templates/.claude/skills/simple-seed/SKILL.md +9 -10
- package/spec-runner/templates/.claude/skills/simple-seed/templates/02_/346/246/202/350/246/201/350/250/255/350/250/210//343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271/344/270/200/350/246/247.md +1 -1
- package/spec-runner/templates/.claude/skills/simple-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/01_/343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271/UC-{/346/227/245/346/234/254/350/252/236/345/220/215}.md +0 -15
- package/spec-runner/templates/.github/instructions/design-docs.instructions.md +33 -25
- package/spec-runner/templates/.github/skills/architecture-definition/SKILL.md +12 -4
- package/spec-runner/templates/.github/skills/architecture-skill-development/SKILL.md +40 -20
- package/spec-runner/templates/.github/skills/ddd-seed/SKILL.md +11 -12
- package/spec-runner/templates/.github/skills/design-change/SKILL.md +35 -20
- package/spec-runner/templates/.github/skills/existing-project-to-docs/SKILL.md +45 -24
- package/spec-runner/templates/.github/skills/frontend-seed/SKILL.md +121 -0
- package/spec-runner/templates/.github/skills/frontend-seed/templates/01_/350/246/201/344/273/266/345/256/232/347/276/251//350/246/201/344/273/266/345/256/232/347/276/251.md +35 -0
- package/spec-runner/templates/.github/skills/frontend-seed/templates/02_/346/246/202/350/246/201/350/250/255/350/250/210//343/202/263/343/203/263/343/203/235/343/203/274/343/203/215/343/203/263/343/203/210/344/270/200/350/246/247.md +19 -0
- package/spec-runner/templates/.github/skills/frontend-seed/templates/02_/346/246/202/350/246/201/350/250/255/350/250/210//347/224/273/351/235/242/344/270/200/350/246/247.md +25 -0
- package/spec-runner/templates/.github/skills/frontend-seed/templates/02_/346/246/202/350/246/201/350/250/255/350/250/210//347/224/273/351/235/242/351/201/267/347/247/273/345/233/263.md +23 -0
- package/spec-runner/templates/.github/skills/frontend-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/01_/347/224/273/351/235/242/{/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/{/347/224/273/351/235/242/345/220/215}.md +65 -0
- package/spec-runner/templates/.github/skills/frontend-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/02_/343/202/263/343/203/263/343/203/235/343/203/274/343/203/215/343/203/263/343/203/210/{/343/202/263/343/203/263/343/203/235/343/203/274/343/203/215/343/203/263/343/203/210/345/220/215}.md +41 -0
- package/spec-runner/templates/.github/skills/frontend-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/90_ADR/ADR-{/346/227/245/346/234/254/350/252/236/345/220/215}.md +46 -0
- package/spec-runner/templates/.github/skills/simple-seed/SKILL.md +9 -10
- package/spec-runner/templates/.spec-runner/references/resources.md +46 -0
- package/spec-runner/templates/.claude/skills/design-change/references//345/275/261/351/237/277/347/257/204/345/233/262/343/203/201/343/202/247/343/203/203/343/202/257/343/203/252/343/202/271/343/203/210.md +0 -59
- package/spec-runner/templates/.claude/skills/spec-probe/SKILL.md +0 -12
- package/spec-runner/templates/.github/skills/design-change/references//345/275/261/351/237/277/347/257/204/345/233/262/343/203/201/343/202/247/343/203/203/343/202/257/343/203/252/343/202/271/343/203/210.md +0 -59
- package/spec-runner/templates/.github/skills/spec-probe/SKILL.md +0 -12
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: simple-seed
|
|
3
|
-
description: レイヤードアーキテクチャ / CRUD 中心のプロジェクト向け docs
|
|
3
|
+
description: レイヤードアーキテクチャ / CRUD 中心のプロジェクト向け docs 正本開発フロー(バックエンド担当)。ドメイン層を持たず UC・サービス層で設計する。architecture.yaml の style: layered のときに使う。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# simple-seed
|
|
@@ -12,7 +12,7 @@ description: レイヤードアーキテクチャ / CRUD 中心のプロジェ
|
|
|
12
12
|
| キー | 用途 |
|
|
13
13
|
|------|------|
|
|
14
14
|
| `style` | このスキル(`layered`)が適切かを確認 |
|
|
15
|
-
| `has_frontend` | `true` なら
|
|
15
|
+
| `has_frontend` | `true` なら `frontend-seed` が並走していることを確認 |
|
|
16
16
|
| `folder_structure` | `maps_to` パスの基準として参照する |
|
|
17
17
|
|
|
18
18
|
設計フェーズで新たな方針・コンポーネントが確定したら、都度 architecture.yaml を最新状態に保つ。
|
|
@@ -30,6 +30,7 @@ Phase 5: TDD → 実装
|
|
|
30
30
|
## 前提ルール
|
|
31
31
|
|
|
32
32
|
- docs は正本とし、各ドキュメントに `spec_runner`ヘッダーを付ける
|
|
33
|
+
- バックエンドの設計はすべて `docs/バックエンド/` 配下に置く
|
|
33
34
|
- 詳細設計は `01_ユースケース/` `02_DB・外部サービス/` の 2 層で構成する
|
|
34
35
|
- `maps_to` は必ず設定する。パス推定に頼らない
|
|
35
36
|
- 実装ファイルのパスは UC ドキュメント本文に書かない。`maps_to` ヘッダーで管理する
|
|
@@ -37,21 +38,21 @@ Phase 5: TDD → 実装
|
|
|
37
38
|
|
|
38
39
|
## Phase 1: 要件定義
|
|
39
40
|
|
|
40
|
-
`architecture-definition` で完了済み。`docs
|
|
41
|
+
`architecture-definition` で完了済み。`docs/バックエンド/01_要件定義/` が存在することを確認して次へ進む。
|
|
41
42
|
|
|
42
43
|
## Phase 2: 概要設計
|
|
43
44
|
|
|
44
45
|
テンプレート: `templates/02_概要設計/`
|
|
45
46
|
|
|
46
47
|
1. 要件定義からユースケースを洗い出す(Query / Command を意識)
|
|
47
|
-
2. テンプレートをコピーして `docs
|
|
48
|
-
3. コンポーネント全体図・外部 IF を整理し `docs
|
|
48
|
+
2. テンプレートをコピーして `docs/バックエンド/02_概要設計/ユースケース一覧.md` を作る
|
|
49
|
+
3. コンポーネント全体図・外部 IF を整理し `docs/バックエンド/02_概要設計/システム全体俯瞰.md` を作る
|
|
49
50
|
4. ユーザーに確認・承認を得る
|
|
50
51
|
|
|
51
52
|
### 出力
|
|
52
53
|
|
|
53
54
|
```
|
|
54
|
-
docs
|
|
55
|
+
docs/バックエンド/02_概要設計/
|
|
55
56
|
ユースケース一覧.md
|
|
56
57
|
システム全体俯瞰.md
|
|
57
58
|
90_ADR/
|
|
@@ -82,17 +83,15 @@ UC → DB・外部サービス の順に設計する。
|
|
|
82
83
|
|
|
83
84
|
テンプレート: `templates/03_詳細設計/01_ユースケース/UC-{日本語名}.md`
|
|
84
85
|
|
|
85
|
-
> `has_frontend: true` の場合は各 UC ファイルに「画面レイアウト」セクションを含める。`false` なら削除する。
|
|
86
|
-
|
|
87
86
|
```
|
|
88
|
-
docs
|
|
87
|
+
docs/バックエンド/03_詳細設計/01_ユースケース/
|
|
89
88
|
UC-{日本語名}.md
|
|
90
89
|
```
|
|
91
90
|
|
|
92
91
|
### 4-2. DB・外部サービス(必要時のみ)
|
|
93
92
|
|
|
94
93
|
```
|
|
95
|
-
docs
|
|
94
|
+
docs/バックエンド/03_詳細設計/02_DB・外部サービス/
|
|
96
95
|
スキーマ定義.dbml
|
|
97
96
|
外部サービス.md
|
|
98
97
|
```
|
|
@@ -46,21 +46,6 @@ sequenceDiagram
|
|
|
46
46
|
|------------|---------|------|
|
|
47
47
|
| {エラーケース} | {発生条件} | {対応} |
|
|
48
48
|
|
|
49
|
-
## 画面レイアウト
|
|
50
|
-
|
|
51
|
-
> `has_frontend: true` のときのみ記載する。不要なら削除する。
|
|
52
|
-
|
|
53
|
-
- 画面名: {画面名}
|
|
54
|
-
- 遷移元: {前の画面 or -}
|
|
55
|
-
- 遷移先: {次の画面 or -}
|
|
56
|
-
|
|
57
|
-
```
|
|
58
|
-
{画面レイアウト概要 — ASCII art / Markdown テーブルで表現}
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
- 主要 UI 要素:
|
|
62
|
-
- {入力フォーム・ボタン・一覧表示など}
|
|
63
|
-
|
|
64
49
|
## テスト観点
|
|
65
50
|
|
|
66
51
|
- {正常系の観点}
|
|
@@ -4,16 +4,6 @@ applyTo: "docs/**"
|
|
|
4
4
|
|
|
5
5
|
# 設計書共通ルール
|
|
6
6
|
|
|
7
|
-
## フェーズ管理
|
|
8
|
-
|
|
9
|
-
- ユーザー承認なしにフェーズを進めない
|
|
10
|
-
- フェーズは必ず `要件定義 -> 概要設計 -> 詳細設計 -> TDD -> 実装` の順に進める
|
|
11
|
-
|
|
12
|
-
## テンプレート
|
|
13
|
-
|
|
14
|
-
- 設計書は必ずテンプレートをコピーして生成する。独自にゼロから作成しない
|
|
15
|
-
- 手順: テンプレートを読む → 出力先へコピーする → プレースホルダーを埋める
|
|
16
|
-
|
|
17
7
|
## ヘッダー
|
|
18
8
|
|
|
19
9
|
- `docs/**` の全設計書にヘッダーを付ける
|
|
@@ -40,6 +30,8 @@ spec_runner:
|
|
|
40
30
|
|
|
41
31
|
### node_id 体系
|
|
42
32
|
|
|
33
|
+
#### バックエンド
|
|
34
|
+
|
|
43
35
|
| 対象 | node_id 形式 | 例 |
|
|
44
36
|
|------|-------------|-----|
|
|
45
37
|
| 要件定義 | `requirement.{名前}` | `requirement.要件定義` |
|
|
@@ -51,26 +43,42 @@ spec_runner:
|
|
|
51
43
|
| UC 詳細設計 | `detail.usecase.{UC名}` | `detail.usecase.注文確定` |
|
|
52
44
|
| DB・外部サービス | `detail.db.{名前}` | `detail.db.スキーマ定義` |
|
|
53
45
|
|
|
46
|
+
#### フロントエンド(has_frontend: true のみ)
|
|
47
|
+
|
|
48
|
+
| 対象 | node_id 形式 | 例 |
|
|
49
|
+
|------|-------------|-----|
|
|
50
|
+
| 要件定義 | `frontend.requirement.{名前}` | `frontend.requirement.要件定義` |
|
|
51
|
+
| 画面一覧 | `frontend.overview.画面一覧` | — |
|
|
52
|
+
| 画面遷移図 | `frontend.overview.画面遷移図` | — |
|
|
53
|
+
| コンポーネント一覧 | `frontend.overview.コンポーネント一覧` | — |
|
|
54
|
+
| ADR | `frontend.adr.{slug}` | `frontend.adr.0404-UIフレームワーク選定` |
|
|
55
|
+
| 画面詳細設計 | `frontend.detail.画面.{画面名}` | `frontend.detail.画面.ログイン` |
|
|
56
|
+
| コンポーネント詳細設計 | `frontend.detail.component.{名前}` | `frontend.detail.component.ボタン` |
|
|
57
|
+
|
|
54
58
|
## 命名規則
|
|
55
59
|
|
|
60
|
+
### バックエンド
|
|
61
|
+
|
|
56
62
|
| 対象 | 規則 | 例 |
|
|
57
63
|
|------|------|-----|
|
|
58
|
-
| `docs
|
|
59
|
-
| `docs
|
|
60
|
-
| `docs
|
|
61
|
-
| `docs
|
|
64
|
+
| `docs/バックエンド/01_要件定義` | 日本語 | `要件定義.md`, `ユビキタス言語辞書.md` |
|
|
65
|
+
| `docs/バックエンド/02_概要設計` | 日本語 | `ユースケース一覧.md`, `システム全体俯瞰.md` |
|
|
66
|
+
| `docs/バックエンド/02_概要設計`(style: ddd のみ) | 日本語 | `ドメインモデル.md` |
|
|
67
|
+
| `docs/バックエンド/02_概要設計/90_ADR/{対象}/` | `mmdd-{日本語タイトル}.md` | `0404-注文集約の設計.md` |
|
|
62
68
|
| `{対象}` の選択肢 | `全体` / `ドメイン` / `UC` / `DB` | — |
|
|
63
|
-
| `docs
|
|
64
|
-
| `docs
|
|
65
|
-
| `docs
|
|
69
|
+
| `docs/バックエンド/03_詳細設計/01_ドメイン`(style: ddd のみ) | 日本語 | `注文.md`, `在庫.md` |
|
|
70
|
+
| `docs/バックエンド/03_詳細設計/02_ユースケース`(style: ddd) / `01_ユースケース`(style: layered) | `UC-{日本語名}.md` | `UC-注文確定.md` |
|
|
71
|
+
| `docs/バックエンド/03_詳細設計/03_DB・外部サービス`(style: ddd) / `02_DB・外部サービス`(style: layered) | 日本語 | `スキーマ定義.dbml`, `外部サービス.md` |
|
|
66
72
|
|
|
67
|
-
|
|
73
|
+
### フロントエンド(has_frontend: true のみ)
|
|
68
74
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
75
|
+
| 対象 | 規則 | 例 |
|
|
76
|
+
|------|------|-----|
|
|
77
|
+
| `docs/フロントエンド/01_要件定義` | 日本語 | `要件定義.md` |
|
|
78
|
+
| `docs/フロントエンド/02_概要設計` | 日本語 | `画面一覧.md`, `画面遷移図.md`, `コンポーネント一覧.md` |
|
|
79
|
+
| `docs/フロントエンド/02_概要設計/90_ADR/` | `mmdd-{日本語タイトル}.md` | `0404-UIフレームワーク選定.md` |
|
|
80
|
+
| `docs/フロントエンド/03_詳細設計/01_画面/{カテゴリ名}/` | 日本語 | `ログイン.md`, `ダッシュボード.md` |
|
|
81
|
+
| `docs/フロントエンド/03_詳細設計/02_コンポーネント/` | 日本語 | `ボタン.md`, `モーダル.md` |
|
|
74
82
|
|
|
75
83
|
## 文書品質
|
|
76
84
|
|
|
@@ -90,8 +98,8 @@ spec_runner:
|
|
|
90
98
|
|
|
91
99
|
| 種別 | 内容 | 置き場所 |
|
|
92
100
|
|------|------|---------|
|
|
93
|
-
| ドメインモデル | ビジネスルール・集約・値オブジェクト・不変条件 | `docs
|
|
94
|
-
| データモデル | DBスキーマ・テーブル定義・カラム定義・インデックス | `docs
|
|
101
|
+
| ドメインモデル | ビジネスルール・集約・値オブジェクト・不変条件 | `docs/バックエンド/03_詳細設計/01_ドメイン/` |
|
|
102
|
+
| データモデル | DBスキーマ・テーブル定義・カラム定義・インデックス | `docs/バックエンド/03_詳細設計/03_DB・外部サービス/` |
|
|
95
103
|
|
|
96
104
|
- `01_ドメイン/` に DB スキーマ・テーブル定義・カラム定義を書かない
|
|
97
105
|
- `03_DB・外部サービス/` にビジネスルール・ドメインロジックを書かない
|
|
@@ -20,10 +20,12 @@ Phase 5: architecture-skill-development へ自動移行
|
|
|
20
20
|
|
|
21
21
|
テンプレート: `.claude/skills/ddd-seed/templates/01_要件定義/`
|
|
22
22
|
|
|
23
|
-
1.
|
|
23
|
+
1. 背景・提供価値・制約・スコープ外について、曖昧な点があれば一問一答で深掘りする(各質問に推奨回答を添える。コードで確認できることは質問しない)
|
|
24
24
|
2. ユーザーから背景、提供価値、制約、スコープ外を確認する
|
|
25
|
-
3.
|
|
26
|
-
|
|
25
|
+
3. テンプレートをコピーして以下を作る
|
|
26
|
+
- `docs/バックエンド/01_要件定義/要件定義.md`
|
|
27
|
+
- `has_frontend: true` の場合は `docs/フロントエンド/01_要件定義/要件定義.md` も作る
|
|
28
|
+
4. ドメイン用語が出てきたら `docs/バックエンド/01_要件定義/ユビキタス言語辞書.md` に随時追記する
|
|
27
29
|
5. アーキテクチャスタイルを選択する
|
|
28
30
|
|
|
29
31
|
| スタイル | 選ぶ基準 |
|
|
@@ -87,4 +89,10 @@ Phase 4 が承認されたら、ユーザーにコマンドを打たせずに `a
|
|
|
87
89
|
1. `architecture-skill-development` に渡す前提(docs・architecture.yaml・確定済みフォルダ構造)を要約する
|
|
88
90
|
2. project 専用 skill に切り出すべき反復フローを列挙する
|
|
89
91
|
3. 確認なしに `architecture-skill-development` Phase 1 へ進む
|
|
90
|
-
4.
|
|
92
|
+
4. スキル整備完了後、以下のスキルで概要設計へ進む
|
|
93
|
+
|
|
94
|
+
| 条件 | 起動するスキル |
|
|
95
|
+
|------|--------------|
|
|
96
|
+
| `style: ddd` | `ddd-seed`(バックエンド) |
|
|
97
|
+
| `style: layered` | `simple-seed`(バックエンド) |
|
|
98
|
+
| `has_frontend: true` | 上記に加えて `frontend-seed` を並走させる |
|
|
@@ -18,7 +18,7 @@ Phase 6: セットアップ専用 skill のアーカイブ提案
|
|
|
18
18
|
|
|
19
19
|
## Phase 1: 入力の確認
|
|
20
20
|
|
|
21
|
-
1. `docs
|
|
21
|
+
1. `docs/バックエンド/01_要件定義/**` を読む。`has_frontend: true` の場合は `docs/フロントエンド/01_要件定義/**` も読む
|
|
22
22
|
2. `.spec-runner/architecture/architecture.yaml` を読む
|
|
23
23
|
3. 固定化すべき判断と project 固有判断を切り分ける
|
|
24
24
|
|
|
@@ -37,18 +37,19 @@ Phase 6: セットアップ専用 skill のアーカイブ提案
|
|
|
37
37
|
2. 常時守る約束は rule にする
|
|
38
38
|
3. 毎回コピーする設計書は template にする
|
|
39
39
|
|
|
40
|
-
###
|
|
40
|
+
### プロジェクト専用スキルの作成
|
|
41
41
|
|
|
42
|
-
`architecture.yaml` の `style`
|
|
42
|
+
`architecture.yaml` の `style` に応じた seed(`ddd-seed` / `simple-seed`)がインストール済みの場合、どのように専用スキルを作るかをユーザーに確認する。
|
|
43
43
|
|
|
44
|
-
|
|
|
45
|
-
|
|
46
|
-
|
|
|
47
|
-
|
|
|
44
|
+
| 選択肢 | 内容 |
|
|
45
|
+
|--------|------|
|
|
46
|
+
| 新規に作る | `harness-format.md` を基に、このプロジェクトのフローをゼロから記述する |
|
|
47
|
+
| リネームだけ | seed ファイルをプロジェクト専用名に変更する |
|
|
48
|
+
| リネーム+構成変更 | seed をリネームしたうえでフェーズ構成・テンプレートパスをプロジェクトの実態に合わせて書き換える |
|
|
48
49
|
|
|
49
|
-
|
|
50
|
+
seed が存在しない場合は「新規に作る」で進める。
|
|
50
51
|
|
|
51
|
-
|
|
52
|
+
`has_frontend: true` の場合は、`frontend-seed` と バックエンド seed の両方を並走させる旨を専用スキルに明記する。
|
|
52
53
|
|
|
53
54
|
4. ユーザーに確認・承認を得る
|
|
54
55
|
|
|
@@ -57,12 +58,25 @@ Phase 6: セットアップ専用 skill のアーカイブ提案
|
|
|
57
58
|
インストール時に配布された基盤 skill のプレースホルダーを、このプロジェクトの実態に書き換える。
|
|
58
59
|
以降の書き換えはすべて `architecture.yaml` の `integrations` に従う(`claude` のみなら `.claude/` だけ、`github` のみなら `.github/` だけ、両方なら対で更新する)。
|
|
59
60
|
|
|
61
|
+
### インフラ構成ファイルの整備
|
|
62
|
+
|
|
63
|
+
`architecture.yaml` の `language` / `folder_structure` / `testing_policy` を参照して以下を作成する。
|
|
64
|
+
|
|
65
|
+
1. **`.gitignore`**: 言語・フレームワーク固有のパターン(依存パッケージ・ビルド成果物・キャッシュ)と、プロジェクト固有の除外パス(`.env`、`docs/` 等)をユーザーと確認して作成する
|
|
66
|
+
2. **`.dockerignore`**: `.git`・`docs/`・`tests/`・依存パッケージ・ビルド成果物をビルドコンテキストから除外する。ユーザーに追加除外パスを確認する
|
|
67
|
+
3. **`Dockerfile.test`**: テスト実行専用イメージを作成する
|
|
68
|
+
- ベースイメージをユーザーに確認する(例: `python:3.12-slim`, `node:20-alpine`)
|
|
69
|
+
- テスト依存(テストフレームワーク・カバレッジツール等)をインストールする
|
|
70
|
+
- `has_frontend: true` の場合はフロントエンド用も作成する
|
|
71
|
+
|
|
60
72
|
### test-config.md の書き換え
|
|
61
73
|
|
|
62
74
|
`rules/test-config.md`(GitHub Copilot は `instructions/test-config.instructions.md`)はテスト実行コマンドの単一ソースとして `test-driven-development` スキルと `run-tests` エージェントの両方から参照される。`architecture.yaml` の `testing_policy` を参照して書き換える。
|
|
63
75
|
|
|
64
|
-
1.
|
|
65
|
-
2.
|
|
76
|
+
1. **Docker Compose サービス名の確認**: バックエンド・フロントエンドそれぞれのサービス名をユーザーに確認する(例: `backend`, `frontend`)
|
|
77
|
+
2. **LocalStack の確認**: AWS サービスを使うか確認する。使う場合は対象サービス(S3, SQS, DynamoDB 等)と LocalStack のサービス名をユーザーに確認する
|
|
78
|
+
3. **テスト実行コマンド**: `docker compose run --rm <service> <test-command>` の形式で各コマンドを書き換える
|
|
79
|
+
4. **テスト構成**: `tests/` のディレクトリ構成が実態と異なる場合は書き換える
|
|
66
80
|
|
|
67
81
|
### test-driven-development の書き換え
|
|
68
82
|
|
|
@@ -71,13 +85,6 @@ Phase 6: セットアップ専用 skill のアーカイブ提案
|
|
|
71
85
|
1. **fixture / テストデータ**: このプロジェクトの実際のクラス名・DB 接続方法・ヘルパ関数パターンを記述する
|
|
72
86
|
2. **モックのルール**: 使用する外部サービスとモック手段(ライブラリ名など)を具体化する
|
|
73
87
|
|
|
74
|
-
### 影響範囲チェックリストの書き換え
|
|
75
|
-
|
|
76
|
-
`.claude/skills/design-change/references/影響範囲チェックリスト.md` をプロジェクト固有の変更カテゴリとパスに合わせて書き換える。
|
|
77
|
-
|
|
78
|
-
1. 変更カテゴリをプロジェクトの構成要素(モジュール・サービス・ドメインなど)に合わせて追加・削除する
|
|
79
|
-
2. 詳細設計のパスを `architecture.yaml` の `folder_structure` に合わせて書き換える
|
|
80
|
-
|
|
81
88
|
### code-style.md の書き換え
|
|
82
89
|
|
|
83
90
|
`architecture.yaml` の `language` と `folder_structure` を参照して、以下を実際の値に置き換える。
|
|
@@ -88,6 +95,19 @@ Phase 6: セットアップ専用 skill のアーカイブ提案
|
|
|
88
95
|
3. **言語・型固有ルール**: `<your-language-and-type-rules>` を言語・フレームワークに合わせた具体的なルールに書き換える
|
|
89
96
|
4. **プロジェクト構造**: `<your-project-structure>` を `folder_structure` の実際のディレクトリ構成に書き換える
|
|
90
97
|
|
|
98
|
+
### リファレンス URL の登録
|
|
99
|
+
|
|
100
|
+
`.spec-runner/references/resources.md` に、このプロジェクトで使う公式ドキュメントの URL を登録する。
|
|
101
|
+
|
|
102
|
+
1. ユーザーに以下を確認する:
|
|
103
|
+
- 言語・フレームワーク・ツールの公式ドキュメント URL
|
|
104
|
+
- 参考にしているサンプルリポジトリ・リファレンス実装
|
|
105
|
+
- API 仕様(OpenAPI など)
|
|
106
|
+
- 社内 Wiki・Notion などの内部ドキュメント
|
|
107
|
+
- その他ベストプラクティス記事・移行ガイドなど
|
|
108
|
+
2. 教えてもらった情報を名前・カテゴリとともに `.spec-runner/references/resources.md` の該当テーブルに書き込む
|
|
109
|
+
3. ユーザーが追加を終えたら次へ進む
|
|
110
|
+
|
|
91
111
|
### その他の基盤 skill
|
|
92
112
|
|
|
93
113
|
同様のプレースホルダーや汎用記述が他の skill にあれば、同じ要領で書き換える。
|
|
@@ -109,8 +129,8 @@ Phase 6: セットアップ専用 skill のアーカイブ提案
|
|
|
109
129
|
|---|---|
|
|
110
130
|
| `architecture-definition` | 新規プロジェクト初期化専用。アーキテクチャ確定後は不要 |
|
|
111
131
|
| `existing-project-to-docs` | 既存プロジェクト取り込み専用。docs 生成後は不要 |
|
|
112
|
-
| `ddd-seed`
|
|
113
|
-
| `
|
|
132
|
+
| `ddd-seed` / `simple-seed` | プロジェクト専用スキル作成後は不要 |
|
|
133
|
+
| `frontend-seed` | `has_frontend: true` かつプロジェクト専用スキル作成後は不要 |
|
|
114
134
|
| `architecture-skill-development`(このファイル自身) | project 専用 skill が安定したら不要。アーキテクチャ大変更時は再利用可 |
|
|
115
135
|
|
|
116
136
|
### 手順
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ddd-seed
|
|
3
|
-
description: UC/DDD 駆動の docs
|
|
3
|
+
description: UC/DDD 駆動の docs 正本開発フローの種(バックエンド担当)。新規プロジェクトの初期テンプレートとして使い、architecture-skill-development でプロジェクト専用スキルに育てる。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# ddd-seed
|
|
@@ -12,7 +12,7 @@ description: UC/DDD 駆動の docs 正本開発フローの種。新規プロジ
|
|
|
12
12
|
| キー | 用途 |
|
|
13
13
|
|------|------|
|
|
14
14
|
| `style` | このスキル(`ddd`)が適切かを確認 |
|
|
15
|
-
| `has_frontend` | `true` なら
|
|
15
|
+
| `has_frontend` | `true` なら `frontend-seed` が並走していることを確認 |
|
|
16
16
|
| `folder_structure` | `maps_to` パスの基準として参照する |
|
|
17
17
|
|
|
18
18
|
設計フェーズで新たな方針・コンポーネントが確定したら、都度 architecture.yaml を最新状態に保つ。
|
|
@@ -30,6 +30,7 @@ Phase 5: TDD → 実装
|
|
|
30
30
|
## 前提ルール
|
|
31
31
|
|
|
32
32
|
- docs は正本とし、各ドキュメントに `spec_runner`ヘッダーを付ける
|
|
33
|
+
- バックエンドの設計はすべて `docs/バックエンド/` 配下に置く
|
|
33
34
|
- 詳細設計は `01_ドメイン/` `02_ユースケース/` `03_DB・外部サービス/` の 3 層で構成する
|
|
34
35
|
- ドメインを先に設計し、UC はドメインを参照する形で書く。ドメインの中に UC は入れない
|
|
35
36
|
- `maps_to` は必ず設定する。パス推定に頼らない
|
|
@@ -38,20 +39,20 @@ Phase 5: TDD → 実装
|
|
|
38
39
|
|
|
39
40
|
## Phase 1: 要件定義
|
|
40
41
|
|
|
41
|
-
`architecture-definition` で完了済み。`docs
|
|
42
|
+
`architecture-definition` で完了済み。`docs/バックエンド/01_要件定義/` が存在することを確認して次へ進む。
|
|
42
43
|
|
|
43
44
|
## Phase 2: 概要設計
|
|
44
45
|
|
|
45
46
|
### 2-1. ユースケース一覧
|
|
46
47
|
|
|
47
48
|
1. 要件定義からユースケースを洗い出す(Query / Command を意識)
|
|
48
|
-
2. `docs
|
|
49
|
+
2. `docs/バックエンド/02_概要設計/ユースケース一覧.md` を作る
|
|
49
50
|
3. ユーザーに確認・承認を得る
|
|
50
51
|
|
|
51
52
|
### 2-2. ドメインモデル + システム全体俯瞰
|
|
52
53
|
|
|
53
|
-
1. UC から集約・境界コンテキストを整理し `docs
|
|
54
|
-
2. コンポーネント全体図・外部 IF を整理し `docs
|
|
54
|
+
1. UC から集約・境界コンテキストを整理し `docs/バックエンド/02_概要設計/ドメインモデル.md` を作る
|
|
55
|
+
2. コンポーネント全体図・外部 IF を整理し `docs/バックエンド/02_概要設計/システム全体俯瞰.md` を作る
|
|
55
56
|
3. ユーザーに確認・承認を得る
|
|
56
57
|
|
|
57
58
|
### 出力
|
|
@@ -59,7 +60,7 @@ Phase 5: TDD → 実装
|
|
|
59
60
|
テンプレート: `templates/02_概要設計/ユースケース一覧.md` / `templates/02_概要設計/ドメインモデル.md` / `templates/02_概要設計/システム全体俯瞰.md`
|
|
60
61
|
|
|
61
62
|
```
|
|
62
|
-
docs
|
|
63
|
+
docs/バックエンド/02_概要設計/
|
|
63
64
|
ユースケース一覧.md
|
|
64
65
|
ドメインモデル.md
|
|
65
66
|
システム全体俯瞰.md
|
|
@@ -94,7 +95,7 @@ docs/02_概要設計/
|
|
|
94
95
|
テンプレート: `templates/03_詳細設計/01_ドメイン/{ドメイン名}.md`
|
|
95
96
|
|
|
96
97
|
```
|
|
97
|
-
docs
|
|
98
|
+
docs/バックエンド/03_詳細設計/01_ドメイン/
|
|
98
99
|
{ドメイン名}.md
|
|
99
100
|
```
|
|
100
101
|
|
|
@@ -104,17 +105,15 @@ docs/03_詳細設計/01_ドメイン/
|
|
|
104
105
|
|
|
105
106
|
テンプレート: `templates/03_詳細設計/02_ユースケース/UC-{日本語名}.md`
|
|
106
107
|
|
|
107
|
-
> `has_frontend: true` の場合は各 UC ファイルに「画面レイアウト」セクションを含める。`false` なら削除する。
|
|
108
|
-
|
|
109
108
|
```
|
|
110
|
-
docs
|
|
109
|
+
docs/バックエンド/03_詳細設計/02_ユースケース/
|
|
111
110
|
UC-{日本語名}.md
|
|
112
111
|
```
|
|
113
112
|
|
|
114
113
|
### 4-3. DB・外部サービス(必要時のみ)
|
|
115
114
|
|
|
116
115
|
```
|
|
117
|
-
docs
|
|
116
|
+
docs/バックエンド/03_詳細設計/03_DB・外部サービス/
|
|
118
117
|
スキーマ定義.dbml
|
|
119
118
|
外部サービス.md
|
|
120
119
|
```
|
|
@@ -7,7 +7,6 @@ description: 既存機能の変更を docs 正本で進めるフローガイド
|
|
|
7
7
|
|
|
8
8
|
フェーズは順番通りに進める。ユーザーの承認なしに先へ進めない。
|
|
9
9
|
|
|
10
|
-
影響範囲のチェックリストは `references/影響範囲チェックリスト.md` を参照する。
|
|
11
10
|
ADR テンプレートは `templates/90_ADR/ADRテンプレート.md` を使用する。
|
|
12
11
|
|
|
13
12
|
## 前提: architecture.yaml の読み込み
|
|
@@ -17,7 +16,7 @@ ADR テンプレートは `templates/90_ADR/ADRテンプレート.md` を使用
|
|
|
17
16
|
| キー | 用途 |
|
|
18
17
|
|------|------|
|
|
19
18
|
| `style` | Phase 4/5 のフォルダパス・設計順序を決定 |
|
|
20
|
-
| `has_frontend` |
|
|
19
|
+
| `has_frontend` | `true` なら `docs/フロントエンド/` の設計書も変更対象に含める |
|
|
21
20
|
| `folder_structure` | 影響ドキュメントのパス確認に使用 |
|
|
22
21
|
|
|
23
22
|
設計変更によって方針・構成に変化があった場合は、architecture.yaml も合わせて更新する。
|
|
@@ -35,16 +34,18 @@ Phase 6: TDD → 実装 → 検証
|
|
|
35
34
|
|
|
36
35
|
## Phase 1: 変更要求の整理と軽い影響調査
|
|
37
36
|
|
|
38
|
-
1.
|
|
37
|
+
1. 変更の背景や目的について曖昧な点があれば、一問一答で深掘りする(各質問に推奨回答を添える。コードで確認できることは質問しない)
|
|
39
38
|
2. 以下をユーザーにヒアリングする
|
|
40
39
|
- 変更の背景・課題
|
|
41
40
|
- 変更の目的・期待する結果
|
|
42
41
|
- 影響を受ける機能カテゴリ
|
|
42
|
+
- バックエンド / フロントエンド / 両方のどちらに影響するか
|
|
43
43
|
- 技術的・ビジネス的制約
|
|
44
44
|
3. 変更起点となる docs を特定する
|
|
45
45
|
4. `@analyze-impact` に委任して `depends_on` / `maps_to` を辿る影響ファイルを洗い出す
|
|
46
|
-
5.
|
|
47
|
-
6.
|
|
46
|
+
5. `has_frontend: true` かつバックエンドの **API(UC の入出力・エンドポイント)** が変わる場合、フロントエンドの画面設計も影響対象に追加する(`docs/フロントエンド/03_詳細設計/01_画面/` の「API連携」セクションを確認)
|
|
47
|
+
6. 変更が影響するドメインと成果物を一覧化する
|
|
48
|
+
7. ユーザーに確認・承認を得る
|
|
48
49
|
|
|
49
50
|
## Phase 2: ADR 作成(必要時)
|
|
50
51
|
|
|
@@ -60,15 +61,16 @@ Phase 6: TDD → 実装 → 検証
|
|
|
60
61
|
|
|
61
62
|
| 対象 | 配置先 |
|
|
62
63
|
|------|--------|
|
|
63
|
-
| システム横断の決定 | `docs
|
|
64
|
-
| ドメイン設計の決定 | `docs
|
|
65
|
-
| UC フローの決定 | `docs
|
|
66
|
-
| DB・外部サービスの決定 | `docs
|
|
64
|
+
| システム横断の決定 | `docs/バックエンド/02_概要設計/90_ADR/全体/` |
|
|
65
|
+
| ドメイン設計の決定 | `docs/バックエンド/02_概要設計/90_ADR/ドメイン/` |
|
|
66
|
+
| UC フローの決定 | `docs/バックエンド/02_概要設計/90_ADR/UC/` |
|
|
67
|
+
| DB・外部サービスの決定 | `docs/バックエンド/02_概要設計/90_ADR/DB/` |
|
|
68
|
+
| フロントエンドの決定 | `docs/フロントエンド/02_概要設計/90_ADR/` |
|
|
67
69
|
|
|
68
70
|
## Phase 3: 影響ドキュメントの確定
|
|
69
71
|
|
|
70
|
-
1. `
|
|
71
|
-
2
|
|
72
|
+
1. `@analyze-impact` に委任して `depends_on` / `maps_to` を辿る影響ファイルを網羅的に洗い出す
|
|
73
|
+
2. ヘッダーの `depends_on` / `maps_to` を使って候補を絞る
|
|
72
74
|
3. 修正が必要なファイルをチェックリスト形式で提示する
|
|
73
75
|
4. `@review-design` エージェントに委任して、現時点の設計書⇔実装の乖離も合わせて確認する
|
|
74
76
|
5. ユーザーに確認・承認を得る
|
|
@@ -77,25 +79,38 @@ Phase 6: TDD → 実装 → 検証
|
|
|
77
79
|
|
|
78
80
|
概要設計では「何をするか」に留める。変更理由は ADR または本文で追えるようにする。
|
|
79
81
|
|
|
80
|
-
|
|
82
|
+
### バックエンド
|
|
83
|
+
|
|
84
|
+
1. `docs/バックエンド/02_概要設計/ユースケース一覧.md` / `システム全体俯瞰.md` / ADR を必要順に修正する
|
|
81
85
|
2. `style: ddd` の場合: `ドメインモデル.md` も必要に応じて修正する
|
|
82
|
-
|
|
83
|
-
|
|
86
|
+
|
|
87
|
+
### フロントエンド(has_frontend: true かつ影響がある場合)
|
|
88
|
+
|
|
89
|
+
1. `docs/フロントエンド/02_概要設計/画面一覧.md` / `画面遷移図.md` / `コンポーネント一覧.md` を必要順に修正する
|
|
90
|
+
|
|
91
|
+
修正完了ごとにチェックリストを更新する。全概要設計の修正完了後、ユーザーに確認・承認を得る。
|
|
84
92
|
|
|
85
93
|
## Phase 5: 詳細設計の修正
|
|
86
94
|
|
|
95
|
+
### バックエンド
|
|
96
|
+
|
|
87
97
|
`style: ddd` の場合:
|
|
88
98
|
|
|
89
|
-
1. `docs
|
|
90
|
-
2. `docs
|
|
91
|
-
3. DB・外部サービスの変更がある場合は `docs
|
|
99
|
+
1. `docs/バックエンド/03_詳細設計/01_ドメイン/**` のドメイン設計を修正する
|
|
100
|
+
2. `docs/バックエンド/03_詳細設計/02_ユースケース/**` の UC 設計を修正する
|
|
101
|
+
3. DB・外部サービスの変更がある場合は `docs/バックエンド/03_詳細設計/03_DB・外部サービス/**` を修正する
|
|
92
102
|
|
|
93
103
|
`style: layered` の場合:
|
|
94
104
|
|
|
95
|
-
1. `docs
|
|
96
|
-
2. DB・外部サービスの変更がある場合は `docs
|
|
105
|
+
1. `docs/バックエンド/03_詳細設計/01_ユースケース/**` の UC 設計を修正する
|
|
106
|
+
2. DB・外部サービスの変更がある場合は `docs/バックエンド/03_詳細設計/02_DB・外部サービス/**` を修正する
|
|
107
|
+
|
|
108
|
+
### フロントエンド(has_frontend: true かつ影響がある場合)
|
|
109
|
+
|
|
110
|
+
1. `docs/フロントエンド/03_詳細設計/01_画面/**` の画面設計を修正する
|
|
111
|
+
2. コンポーネントの変更がある場合は `docs/フロントエンド/03_詳細設計/02_コンポーネント/**` を修正する
|
|
97
112
|
|
|
98
|
-
|
|
113
|
+
ヘッダーの `depends_on` / `maps_to` を更新する。ユーザーに最終確認を得る。
|
|
99
114
|
|
|
100
115
|
## Phase 6: TDD → 実装 → 検証
|
|
101
116
|
|