spec-runner 1.8.0 → 2.0.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 +8 -6
- package/package.json +1 -1
- package/spec-runner/templates/.claude/rules/code-style.md +4 -0
- package/spec-runner/templates/.claude/rules/design-docs.md +2 -1
- package/spec-runner/templates/.claude/skills/architecture-skill-development/SKILL.md +18 -2
- package/spec-runner/templates/.claude/skills/ddd-seed/SKILL.md +57 -12
- package/spec-runner/templates/.claude/skills/ddd-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/03_DB/343/203/273/345/244/226/351/203/250/343/202/265/343/203/274/343/203/223/343/202/271/DB//343/203/236/343/202/244/343/202/260/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/346/210/246/347/225/245.md +40 -0
- package/spec-runner/templates/.claude/skills/ddd-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/03_DB/343/203/273/345/244/226/351/203/250/343/202/265/343/203/274/343/203/223/343/202/271/{/343/203/227/343/203/255/343/203/220/343/202/244/343/203/200/343/203/274/345/220/215}/{/343/202/265/343/203/274/343/203/223/343/202/271/345/220/215}.md +24 -0
- package/spec-runner/templates/.claude/skills/ddd-seed/templates/04_/350/252/277/346/237/273/350/263/207/346/226/231/{/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/{/343/203/210/343/203/224/343/203/203/343/202/257/345/220/215}.md +20 -0
- package/spec-runner/templates/.claude/skills/ddd-seed/templates/90_ADR/ADR/343/203/206/343/203/263/343/203/227/343/203/254/343/203/274/343/203/210.md +48 -0
- package/spec-runner/templates/.claude/skills/design-change/SKILL.md +35 -4
- package/spec-runner/templates/.claude/skills/design-change/templates/90_ADR/ADR/343/203/206/343/203/263/343/203/227/343/203/254/343/203/274/343/203/210.md +0 -1
- package/spec-runner/templates/.claude/skills/frontend-seed/SKILL.md +32 -7
- 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 +2 -0
- package/spec-runner/templates/.claude/skills/frontend-seed/templates/04_/350/252/277/346/237/273/350/263/207/346/226/231/{/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/{/343/203/210/343/203/224/343/203/203/343/202/257/345/220/215}.md +20 -0
- package/spec-runner/templates/.claude/skills/frontend-seed/templates/90_ADR/ADR/343/203/206/343/203/263/343/203/227/343/203/254/343/203/274/343/203/210.md +48 -0
- package/spec-runner/templates/.claude/skills/simple-seed/SKILL.md +57 -10
- package/spec-runner/templates/.claude/skills/simple-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 +34 -0
- package/spec-runner/templates/.claude/skills/simple-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/02_DB/343/203/273/345/244/226/351/203/250/343/202/265/343/203/274/343/203/223/343/202/271/DB//343/203/236/343/202/244/343/202/260/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/346/210/246/347/225/245.md +40 -0
- package/spec-runner/templates/.claude/skills/simple-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/02_DB/343/203/273/345/244/226/351/203/250/343/202/265/343/203/274/343/203/223/343/202/271/{/343/203/227/343/203/255/343/203/220/343/202/244/343/203/200/343/203/274/345/220/215}/{/343/202/265/343/203/274/343/203/223/343/202/271/345/220/215}.md +24 -0
- package/spec-runner/templates/.claude/skills/simple-seed/templates/04_/350/252/277/346/237/273/350/263/207/346/226/231/{/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/{/343/203/210/343/203/224/343/203/203/343/202/257/345/220/215}.md +20 -0
- package/spec-runner/templates/.claude/skills/simple-seed/templates/90_ADR/ADR/343/203/206/343/203/263/343/203/227/343/203/254/343/203/274/343/203/210.md +48 -0
- package/spec-runner/templates/.github/instructions/code-style.instructions.md +4 -0
- package/spec-runner/templates/.github/instructions/design-docs.instructions.md +2 -1
- package/spec-runner/templates/.github/skills/architecture-skill-development/SKILL.md +18 -2
- package/spec-runner/templates/.github/skills/ddd-seed/SKILL.md +57 -12
- package/spec-runner/templates/.github/skills/ddd-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/03_DB/343/203/273/345/244/226/351/203/250/343/202/265/343/203/274/343/203/223/343/202/271/DB//343/203/236/343/202/244/343/202/260/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/346/210/246/347/225/245.md +40 -0
- package/spec-runner/templates/.github/skills/ddd-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/03_DB/343/203/273/345/244/226/351/203/250/343/202/265/343/203/274/343/203/223/343/202/271/{/343/203/227/343/203/255/343/203/220/343/202/244/343/203/200/343/203/274/345/220/215}/{/343/202/265/343/203/274/343/203/223/343/202/271/345/220/215}.md +24 -0
- package/spec-runner/templates/.github/skills/ddd-seed/templates/04_/350/252/277/346/237/273/350/263/207/346/226/231/{/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/{/343/203/210/343/203/224/343/203/203/343/202/257/345/220/215}.md +20 -0
- package/spec-runner/templates/.github/skills/ddd-seed/templates/90_ADR/ADR/343/203/206/343/203/263/343/203/227/343/203/254/343/203/274/343/203/210.md +48 -0
- package/spec-runner/templates/.github/skills/design-change/SKILL.md +35 -4
- package/spec-runner/templates/.github/skills/design-change/templates/90_ADR/ADR/343/203/206/343/203/263/343/203/227/343/203/254/343/203/274/343/203/210.md +0 -1
- package/spec-runner/templates/.github/skills/frontend-seed/SKILL.md +32 -7
- 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 +2 -0
- package/spec-runner/templates/.github/skills/frontend-seed/templates/04_/350/252/277/346/237/273/350/263/207/346/226/231/{/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/{/343/203/210/343/203/224/343/203/203/343/202/257/345/220/215}.md +20 -0
- package/spec-runner/templates/.github/skills/frontend-seed/templates/90_ADR/ADR/343/203/206/343/203/263/343/203/227/343/203/254/343/203/274/343/203/210.md +48 -0
- package/spec-runner/templates/.github/skills/simple-seed/SKILL.md +57 -10
- package/spec-runner/templates/.github/skills/simple-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 +34 -0
- package/spec-runner/templates/.github/skills/simple-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/02_DB/343/203/273/345/244/226/351/203/250/343/202/265/343/203/274/343/203/223/343/202/271/DB//343/203/236/343/202/244/343/202/260/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/346/210/246/347/225/245.md +40 -0
- package/spec-runner/templates/.github/skills/simple-seed/templates/03_/350/251/263/347/264/260/350/250/255/350/250/210/02_DB/343/203/273/345/244/226/351/203/250/343/202/265/343/203/274/343/203/223/343/202/271/{/343/203/227/343/203/255/343/203/220/343/202/244/343/203/200/343/203/274/345/220/215}/{/343/202/265/343/203/274/343/203/223/343/202/271/345/220/215}.md +24 -0
- package/spec-runner/templates/.github/skills/simple-seed/templates/04_/350/252/277/346/237/273/350/263/207/346/226/231/{/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/{/343/203/210/343/203/224/343/203/203/343/202/257/345/220/215}.md +20 -0
- package/spec-runner/templates/.github/skills/simple-seed/templates/90_ADR/ADR/343/203/206/343/203/263/343/203/227/343/203/254/343/203/274/343/203/210.md +48 -0
- package/spec-runner/templates/.spec-runner/references/resources.md +1 -1
- package/spec-runner/templates/copilot-instructions.md +22 -0
- /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-{ → {/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/UC-{}/346/227/245/346/234/254/350/252/236/345/220/215}.md" +0 -0
- /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-{ → {/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/UC-{}/346/227/245/346/234/254/350/252/236/345/220/215}.md" +0 -0
- /package/spec-runner/templates/.github/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-{ → {/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/UC-{}/346/227/245/346/234/254/350/252/236/345/220/215}.md" +0 -0
- /package/spec-runner/templates/.github/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-{ → {/343/202/253/343/203/206/343/202/264/343/203/252/345/220/215}/UC-{}/346/227/245/346/234/254/350/252/236/345/220/215}.md" +0 -0
|
@@ -23,8 +23,9 @@ description: レイヤードアーキテクチャ / CRUD 中心のプロジェ
|
|
|
23
23
|
Phase 1: 要件定義
|
|
24
24
|
Phase 2: 概要設計(ユースケース + システム全体俯瞰)
|
|
25
25
|
Phase 3: ADR(必要時のみ)
|
|
26
|
-
Phase 4:
|
|
27
|
-
Phase 5:
|
|
26
|
+
Phase 4: ベストプラクティス調査(必要時のみ)
|
|
27
|
+
Phase 5: 詳細設計(UC → DB・外部サービス)
|
|
28
|
+
Phase 6: TDD → 実装
|
|
28
29
|
```
|
|
29
30
|
|
|
30
31
|
## 前提ルール
|
|
@@ -63,6 +64,8 @@ docs/バックエンド/02_概要設計/
|
|
|
63
64
|
|
|
64
65
|
## Phase 3: ADR(必要時のみ)
|
|
65
66
|
|
|
67
|
+
ADR テンプレート: `templates/90_ADR/ADRテンプレート.md`
|
|
68
|
+
|
|
66
69
|
1. 設計判断が必要な場合だけ ADR を作る
|
|
67
70
|
2. 提案時に必ず 3 案を比較する。ドキュメントには採用案と採用理由のみ記録する
|
|
68
71
|
3. ファイル名は `mmdd-{日本語タイトル}.md`、配置先は対象フォルダ
|
|
@@ -75,30 +78,74 @@ docs/バックエンド/02_概要設計/
|
|
|
75
78
|
|
|
76
79
|
4. 採用案を概要設計へ反映してから次へ進む
|
|
77
80
|
|
|
78
|
-
## Phase 4:
|
|
81
|
+
## Phase 4: ベストプラクティス調査(必要時のみ)
|
|
82
|
+
|
|
83
|
+
ADR で使用サービス・技術が確定した後、詳細設計に入る前に実施する。
|
|
84
|
+
|
|
85
|
+
1. 「詳細設計に先立ち、ベストプラクティスを調査すべき技術・サービスはありますか?」とユーザーに確認する
|
|
86
|
+
2. 調査する技術・サービスの公式ドキュメント URL を `.spec-runner/references/resources.md` に追記する(ユーザーが知っている URL + AI が有用と判断した URL も積極的に追加する)
|
|
87
|
+
3. WebSearch(resources.md の URL を起点に)でベストプラクティスを調査し、結果を保存する
|
|
88
|
+
4. 調査不要の場合はスキップして次へ進む
|
|
89
|
+
|
|
90
|
+
テンプレート: `templates/04_調査資料/{カテゴリ名}/{トピック名}.md`
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
docs/バックエンド/04_調査資料/
|
|
94
|
+
{カテゴリ名}/ # 例: AWS/, GCP/, 設計パターン/
|
|
95
|
+
{トピック名}.md # 例: DynamoDB-キー設計.md, S3-アクセス制御.md
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
- 1 調査テーマ = 1 ファイル(複数テーマは別ファイルに分ける)
|
|
99
|
+
- ユーザーに確認・承認を得てから次へ進む
|
|
100
|
+
|
|
101
|
+
## Phase 5: 詳細設計
|
|
79
102
|
|
|
80
103
|
UC → DB・外部サービス の順に設計する。
|
|
81
104
|
|
|
82
|
-
###
|
|
105
|
+
### 5-1. ユースケース
|
|
106
|
+
|
|
107
|
+
カテゴリ(機能ドメイン)でディレクトリを切る。
|
|
83
108
|
|
|
84
|
-
テンプレート: `templates/03_詳細設計/01_ユースケース/UC-{日本語名}.md`
|
|
109
|
+
テンプレート: `templates/03_詳細設計/01_ユースケース/{カテゴリ名}/UC-{日本語名}.md`
|
|
85
110
|
|
|
86
111
|
```
|
|
87
112
|
docs/バックエンド/03_詳細設計/01_ユースケース/
|
|
88
|
-
|
|
113
|
+
{カテゴリ名}/ # 例: 注文/, 在庫/, ユーザー/
|
|
114
|
+
UC-{日本語名}.md
|
|
89
115
|
```
|
|
90
116
|
|
|
91
|
-
###
|
|
117
|
+
### 5-2. DB・外部サービス(必要時のみ)
|
|
118
|
+
|
|
119
|
+
テンプレート: `templates/03_詳細設計/02_DB・外部サービス/{プロバイダー名}/{サービス名}.md`
|
|
92
120
|
|
|
93
121
|
```
|
|
94
122
|
docs/バックエンド/03_詳細設計/02_DB・外部サービス/
|
|
95
|
-
|
|
96
|
-
|
|
123
|
+
DB/
|
|
124
|
+
スキーマ定義.dbml
|
|
125
|
+
マイグレーション戦略.md
|
|
126
|
+
{プロバイダー名}/ # 例: AWS/, GCP/, Azure/
|
|
127
|
+
{サービス名}.md # 例: S3.md, DynamoDB.md, Athena.md
|
|
97
128
|
```
|
|
98
129
|
|
|
130
|
+
- DB 関連ファイルは `DB/` カテゴリに置く
|
|
131
|
+
- 外部サービスはクラウドプロバイダー(AWS / GCP / Azure など)をカテゴリフォルダとし、中にサービス名の md を置く
|
|
132
|
+
- `外部サービス.md` のような汎用名は使わない
|
|
133
|
+
|
|
99
134
|
3. ユーザーに確認・承認を得る
|
|
100
135
|
|
|
101
|
-
## Phase 5:
|
|
136
|
+
## Phase 5.5: マイグレーション戦略
|
|
137
|
+
|
|
138
|
+
スキーマ定義が確定した後、TDD に入る前に実施する。
|
|
139
|
+
|
|
140
|
+
1. Migration ツール・命名規則・Up/Down 方針をユーザーと確認する
|
|
141
|
+
2. ゼロダウンタイムの要否を確認する
|
|
142
|
+
3. ロールバック方針・既存データの扱いを決める
|
|
143
|
+
4. `docs/バックエンド/03_詳細設計/02_DB・外部サービス/DB/マイグレーション戦略.md` を作る
|
|
144
|
+
5. ユーザーに確認・承認を得る
|
|
145
|
+
|
|
146
|
+
テンプレート: `templates/03_詳細設計/02_DB・外部サービス/DB/マイグレーション戦略.md`
|
|
147
|
+
|
|
148
|
+
## Phase 6: TDD → 実装
|
|
102
149
|
|
|
103
150
|
`test-driven-development` スキルへ移行する。
|
|
104
151
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
spec_runner:
|
|
3
|
+
node_id: requirement.要件定義
|
|
4
|
+
kind: requirement
|
|
5
|
+
depends_on: []
|
|
6
|
+
maps_to:
|
|
7
|
+
- docs/バックエンド/02_概要設計/
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 要件定義
|
|
11
|
+
|
|
12
|
+
## 解決すべき課題・提供価値
|
|
13
|
+
|
|
14
|
+
- {課題}
|
|
15
|
+
- {提供価値}
|
|
16
|
+
|
|
17
|
+
## 対象ユーザー
|
|
18
|
+
|
|
19
|
+
- {ユーザー種別}: {説明}
|
|
20
|
+
|
|
21
|
+
## 非機能要件
|
|
22
|
+
|
|
23
|
+
| 項目 | 内容 |
|
|
24
|
+
|------|------|
|
|
25
|
+
| {パフォーマンス} | {要件} |
|
|
26
|
+
| {セキュリティ} | {要件} |
|
|
27
|
+
|
|
28
|
+
## スコープ外
|
|
29
|
+
|
|
30
|
+
- {スコープ外の機能・要件}
|
|
31
|
+
|
|
32
|
+
## 技術・ビジネス制約
|
|
33
|
+
|
|
34
|
+
- {制約}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
spec_runner:
|
|
3
|
+
node_id: detail.db.マイグレーション戦略
|
|
4
|
+
kind: migration_strategy
|
|
5
|
+
depends_on:
|
|
6
|
+
- detail.db.スキーマ定義
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# マイグレーション戦略
|
|
10
|
+
|
|
11
|
+
## ツール
|
|
12
|
+
|
|
13
|
+
- **Migration ツール**: {Flyway / Alembic / Prisma Migrate / その他}
|
|
14
|
+
- **ファイル命名規則**: {例: V{バージョン}__{説明}.sql}
|
|
15
|
+
|
|
16
|
+
## Up / Down 方針
|
|
17
|
+
|
|
18
|
+
- **Up**: {適用時の方針}
|
|
19
|
+
- **Down**: {ロールバック時の方針 / Down 不要の場合はその理由}
|
|
20
|
+
|
|
21
|
+
## 既存データの扱い
|
|
22
|
+
|
|
23
|
+
| ケース | 対応方針 |
|
|
24
|
+
|--------|---------|
|
|
25
|
+
| {既存レコードの変換} | {方針} |
|
|
26
|
+
| {seed データ} | {方針} |
|
|
27
|
+
| {データ移行スクリプト} | {方針} |
|
|
28
|
+
|
|
29
|
+
## ゼロダウンタイム戦略
|
|
30
|
+
|
|
31
|
+
- **要否**: {必要 / 不要}
|
|
32
|
+
- **方針**: {例: backward compatible な変更を先に適用 → デプロイ → 旧カラム削除}
|
|
33
|
+
|
|
34
|
+
## ロールバック方針
|
|
35
|
+
|
|
36
|
+
- {ロールバック手順・条件}
|
|
37
|
+
|
|
38
|
+
## 適用順序・依存関係
|
|
39
|
+
|
|
40
|
+
- {Migration ファイル間の依存がある場合に記載}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
spec_runner:
|
|
3
|
+
type: external-service
|
|
4
|
+
provider: {プロバイダー名}
|
|
5
|
+
service: {サービス名}
|
|
6
|
+
maps_to: ""
|
|
7
|
+
depends_on: []
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# {サービス名}
|
|
11
|
+
|
|
12
|
+
## 用途・役割
|
|
13
|
+
|
|
14
|
+
## 設定・接続情報
|
|
15
|
+
|
|
16
|
+
| 項目 | 値 |
|
|
17
|
+
|------|-----|
|
|
18
|
+
| | |
|
|
19
|
+
|
|
20
|
+
## データ構造・スキーマ
|
|
21
|
+
|
|
22
|
+
## アクセス制御・権限
|
|
23
|
+
|
|
24
|
+
## 注意事項
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
spec_runner:
|
|
3
|
+
node_id: adr.{decision_slug}
|
|
4
|
+
kind: adr
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# {決定内容のタイトル}
|
|
8
|
+
|
|
9
|
+
**ステータス**: 提案 / 採用 / 廃止 / 置換
|
|
10
|
+
**日付**: YYYY-MM-DD
|
|
11
|
+
|
|
12
|
+
## コンテキスト
|
|
13
|
+
|
|
14
|
+
| 項目 | 内容 |
|
|
15
|
+
|------|------|
|
|
16
|
+
| 現在の状況 | {問題・課題} |
|
|
17
|
+
| 要件 | {実現する必要があること} |
|
|
18
|
+
| 制約 | {技術的・ビジネス的制約} |
|
|
19
|
+
|
|
20
|
+
## 決定
|
|
21
|
+
|
|
22
|
+
**採用案**: {案名}
|
|
23
|
+
|
|
24
|
+
### 採用理由
|
|
25
|
+
|
|
26
|
+
- {理由1}
|
|
27
|
+
- {理由2}
|
|
28
|
+
|
|
29
|
+
### 実装方針
|
|
30
|
+
|
|
31
|
+
1. {方針1}
|
|
32
|
+
2. {方針2}
|
|
33
|
+
3. {方針3}
|
|
34
|
+
|
|
35
|
+
## 影響
|
|
36
|
+
|
|
37
|
+
| カテゴリ | 項目 | 内容 |
|
|
38
|
+
|----------|------|------|
|
|
39
|
+
| システム | 新規追加 | {コンポーネント} |
|
|
40
|
+
| システム | 変更 | {コンポーネント} |
|
|
41
|
+
| パフォーマンス | 処理速度 | {変化} |
|
|
42
|
+
| コスト | 追加コスト | {影響} |
|
|
43
|
+
| 制約 | 将来課題 | {課題} |
|
|
44
|
+
|
|
45
|
+
### 反映が必要な文書
|
|
46
|
+
|
|
47
|
+
- `docs/02_概要設計/{対象文書}.md`
|
|
48
|
+
- `docs/03_詳細設計/src/{対象パス}.md`
|
|
@@ -7,6 +7,10 @@ paths: ["src/**", "tests/**"]
|
|
|
7
7
|
|
|
8
8
|
> このファイルはテンプレートです。`architecture-skill-development` で言語・フレームワーク・プロジェクト構造に合わせて書き換えてください。
|
|
9
9
|
|
|
10
|
+
## スキルファースト原則
|
|
11
|
+
|
|
12
|
+
コードの修正・実装を始める前に、必ず CLAUDE.md の「開発ワークフロー」を確認し、対応するスキルを特定してから着手する。スキルなしで直接コードや設計書を変更してはならない。
|
|
13
|
+
|
|
10
14
|
## 命名規則
|
|
11
15
|
|
|
12
16
|
> 以下の表をプロジェクトの言語・規約に合わせて書き換える。
|
|
@@ -68,7 +68,8 @@ spec_runner:
|
|
|
68
68
|
| `{対象}` の選択肢 | `全体` / `ドメイン` / `UC` / `DB` | — |
|
|
69
69
|
| `docs/バックエンド/03_詳細設計/01_ドメイン`(style: ddd のみ) | 日本語 | `注文.md`, `在庫.md` |
|
|
70
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`,
|
|
71
|
+
| `docs/バックエンド/03_詳細設計/03_DB・外部サービス`(style: ddd) / `02_DB・外部サービス`(style: layered) | 日本語 | `スキーマ定義.dbml`, `AWS/S3.md`, `GCP/BigQuery.md` |
|
|
72
|
+
| `docs/バックエンド/04_調査資料/{カテゴリ名}/` | 日本語 | `AWS/DynamoDB-キー設計.md`, `設計パターン/CQRS.md` |
|
|
72
73
|
|
|
73
74
|
### フロントエンド(has_frontend: true のみ)
|
|
74
75
|
|
|
@@ -51,6 +51,19 @@ seed が存在しない場合は「新規に作る」で進める。
|
|
|
51
51
|
|
|
52
52
|
`has_frontend: true` の場合は、`frontend-seed` と バックエンド seed の両方を並走させる旨を専用スキルに明記する。
|
|
53
53
|
|
|
54
|
+
### テンプレートの移行
|
|
55
|
+
|
|
56
|
+
seed からスキルを作成した場合(リネーム・リネーム+構成変更)、seed の `templates/` を新しいスキルの `templates/` にそのままコピーする。
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
# 例: ddd-seed → my-feature の場合
|
|
60
|
+
cp -r .github/skills/ddd-seed/templates/ .github/skills/my-feature/templates/
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
コピー後、このプロジェクトで不要なテンプレートファイルを削除し、必要なテンプレートファイルを追加してユーザーに承認を得る。プレースホルダー(`{カテゴリ名}` 等)はそのまま残す。
|
|
64
|
+
|
|
65
|
+
`integrations` に従い `.claude/` / `.github/` 両系で同様に実施する。seed 本体は Phase 6 でアーカイブするまで削除しない。
|
|
66
|
+
|
|
54
67
|
4. ユーザーに確認・承認を得る
|
|
55
68
|
|
|
56
69
|
## Phase 4: 基盤 skill のプロジェクト固有化
|
|
@@ -144,10 +157,13 @@ seed が存在しない場合は「新規に作る」で進める。
|
|
|
144
157
|
- `scripts/scan.js` — **削除しない**。`@analyze-impact` が常時依存しているため
|
|
145
158
|
5. `CLAUDE.md` を更新する
|
|
146
159
|
- 「初回自動起動」セクション(spec-runner インストール時に生成されたもの)を削除する
|
|
147
|
-
-
|
|
148
|
-
-
|
|
160
|
+
- **必ず「開発ワークフロー」セクションを設け、各作業でどの skill を使うかを全て明記する。** skill の記載がない CLAUDE.md は未完成とみなす
|
|
161
|
+
- 以下のフォーマットをベースに、このプロジェクトで使う skill を全て列挙する:
|
|
149
162
|
```markdown
|
|
150
163
|
## 開発ワークフロー
|
|
164
|
+
|
|
165
|
+
作業を開始するときは必ず対応するスキルを使うこと。スキルなしで直接実装・設計を進めてはならない。
|
|
166
|
+
|
|
151
167
|
新機能を実装するときは `/feature-development` を使う。
|
|
152
168
|
既存機能を変更するときは `/design-change` を使う。
|
|
153
169
|
テストを書くときは `/test-driven-development` を使う。
|
|
@@ -23,8 +23,9 @@ description: UC/DDD 駆動の docs 正本開発フローの種(バックエン
|
|
|
23
23
|
Phase 1: 要件定義
|
|
24
24
|
Phase 2: 概要設計(ユースケース + ドメインモデル)
|
|
25
25
|
Phase 3: ADR(必要時のみ)
|
|
26
|
-
Phase 4:
|
|
27
|
-
Phase 5:
|
|
26
|
+
Phase 4: ベストプラクティス調査(必要時のみ)
|
|
27
|
+
Phase 5: 詳細設計(ドメイン → UC → DB・外部サービス)
|
|
28
|
+
Phase 6: TDD → 実装
|
|
28
29
|
```
|
|
29
30
|
|
|
30
31
|
## 前提ルール
|
|
@@ -73,6 +74,8 @@ docs/バックエンド/02_概要設計/
|
|
|
73
74
|
|
|
74
75
|
## Phase 3: ADR(必要時のみ)
|
|
75
76
|
|
|
77
|
+
ADR テンプレート: `templates/90_ADR/ADRテンプレート.md`
|
|
78
|
+
|
|
76
79
|
1. 設計判断が必要な場合だけ ADR を作る
|
|
77
80
|
2. 提案時に必ず 3 案を比較する。ドキュメントには採用案と採用理由のみ記録する
|
|
78
81
|
3. ファイル名は `mmdd-{日本語タイトル}.md`、配置先は対象フォルダ
|
|
@@ -86,11 +89,31 @@ docs/バックエンド/02_概要設計/
|
|
|
86
89
|
|
|
87
90
|
4. 採用案を概要設計へ反映してから次へ進む
|
|
88
91
|
|
|
89
|
-
## Phase 4:
|
|
92
|
+
## Phase 4: ベストプラクティス調査(必要時のみ)
|
|
93
|
+
|
|
94
|
+
ADR で使用サービス・技術が確定した後、詳細設計に入る前に実施する。
|
|
95
|
+
|
|
96
|
+
1. 「詳細設計に先立ち、ベストプラクティスを調査すべき技術・サービスはありますか?」とユーザーに確認する
|
|
97
|
+
2. 調査する技術・サービスの公式ドキュメント URL を `.spec-runner/references/resources.md` に追記する(ユーザーが知っている URL + AI が有用と判断した URL も積極的に追加する)
|
|
98
|
+
3. WebSearch(resources.md の URL を起点に)でベストプラクティスを調査し、結果を保存する
|
|
99
|
+
4. 調査不要の場合はスキップして次へ進む
|
|
100
|
+
|
|
101
|
+
テンプレート: `templates/04_調査資料/{カテゴリ名}/{トピック名}.md`
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
docs/バックエンド/04_調査資料/
|
|
105
|
+
{カテゴリ名}/ # 例: AWS/, GCP/, 設計パターン/
|
|
106
|
+
{トピック名}.md # 例: DynamoDB-キー設計.md, S3-アクセス制御.md
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
- 1 調査テーマ = 1 ファイル(複数テーマは別ファイルに分ける)
|
|
110
|
+
- ユーザーに確認・承認を得てから次へ進む
|
|
111
|
+
|
|
112
|
+
## Phase 5: 詳細設計
|
|
90
113
|
|
|
91
114
|
ドメイン → UC → DB・外部サービス の順に設計する。
|
|
92
115
|
|
|
93
|
-
###
|
|
116
|
+
### 5-1. ドメイン
|
|
94
117
|
|
|
95
118
|
テンプレート: `templates/03_詳細設計/01_ドメイン/{ドメイン名}.md`
|
|
96
119
|
|
|
@@ -99,27 +122,49 @@ docs/バックエンド/03_詳細設計/01_ドメイン/
|
|
|
99
122
|
{ドメイン名}.md
|
|
100
123
|
```
|
|
101
124
|
|
|
102
|
-
###
|
|
125
|
+
### 5-2. ユースケース
|
|
103
126
|
|
|
104
|
-
シーケンス図は UC ファイルに Mermaid
|
|
127
|
+
シーケンス図は UC ファイルに Mermaid で埋め込む。カテゴリ(集約・境界コンテキスト)でディレクトリを切る。
|
|
105
128
|
|
|
106
|
-
テンプレート: `templates/03_詳細設計/02_ユースケース/UC-{日本語名}.md`
|
|
129
|
+
テンプレート: `templates/03_詳細設計/02_ユースケース/{カテゴリ名}/UC-{日本語名}.md`
|
|
107
130
|
|
|
108
131
|
```
|
|
109
132
|
docs/バックエンド/03_詳細設計/02_ユースケース/
|
|
110
|
-
|
|
133
|
+
{カテゴリ名}/ # 例: 注文/, 在庫/, ユーザー/
|
|
134
|
+
UC-{日本語名}.md
|
|
111
135
|
```
|
|
112
136
|
|
|
113
|
-
###
|
|
137
|
+
### 5-3. DB・外部サービス(必要時のみ)
|
|
138
|
+
|
|
139
|
+
テンプレート: `templates/03_詳細設計/03_DB・外部サービス/{プロバイダー名}/{サービス名}.md`
|
|
114
140
|
|
|
115
141
|
```
|
|
116
142
|
docs/バックエンド/03_詳細設計/03_DB・外部サービス/
|
|
117
|
-
|
|
118
|
-
|
|
143
|
+
DB/
|
|
144
|
+
スキーマ定義.dbml
|
|
145
|
+
マイグレーション戦略.md
|
|
146
|
+
{プロバイダー名}/ # 例: AWS/, GCP/, Azure/
|
|
147
|
+
{サービス名}.md # 例: S3.md, DynamoDB.md, Athena.md
|
|
119
148
|
```
|
|
120
149
|
|
|
150
|
+
- DB 関連ファイルは `DB/` カテゴリに置く
|
|
151
|
+
- 外部サービスはクラウドプロバイダー(AWS / GCP / Azure など)をカテゴリフォルダとし、中にサービス名の md を置く
|
|
152
|
+
- `外部サービス.md` のような汎用名は使わない
|
|
153
|
+
|
|
121
154
|
4. ユーザーに確認・承認を得る
|
|
122
155
|
|
|
123
|
-
## Phase 5:
|
|
156
|
+
## Phase 5.5: マイグレーション戦略
|
|
157
|
+
|
|
158
|
+
スキーマ定義が確定した後、TDD に入る前に実施する。
|
|
159
|
+
|
|
160
|
+
1. Migration ツール・命名規則・Up/Down 方針をユーザーと確認する
|
|
161
|
+
2. ゼロダウンタイムの要否を確認する
|
|
162
|
+
3. ロールバック方針・既存データの扱いを決める
|
|
163
|
+
4. `docs/バックエンド/03_詳細設計/03_DB・外部サービス/DB/マイグレーション戦略.md` を作る
|
|
164
|
+
5. ユーザーに確認・承認を得る
|
|
165
|
+
|
|
166
|
+
テンプレート: `templates/03_詳細設計/03_DB・外部サービス/DB/マイグレーション戦略.md`
|
|
167
|
+
|
|
168
|
+
## Phase 6: TDD → 実装
|
|
124
169
|
|
|
125
170
|
`test-driven-development` スキルへ移行する。
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
spec_runner:
|
|
3
|
+
node_id: detail.db.マイグレーション戦略
|
|
4
|
+
kind: migration_strategy
|
|
5
|
+
depends_on:
|
|
6
|
+
- detail.db.スキーマ定義
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# マイグレーション戦略
|
|
10
|
+
|
|
11
|
+
## ツール
|
|
12
|
+
|
|
13
|
+
- **Migration ツール**: {Flyway / Alembic / Prisma Migrate / その他}
|
|
14
|
+
- **ファイル命名規則**: {例: V{バージョン}__{説明}.sql}
|
|
15
|
+
|
|
16
|
+
## Up / Down 方針
|
|
17
|
+
|
|
18
|
+
- **Up**: {適用時の方針}
|
|
19
|
+
- **Down**: {ロールバック時の方針 / Down 不要の場合はその理由}
|
|
20
|
+
|
|
21
|
+
## 既存データの扱い
|
|
22
|
+
|
|
23
|
+
| ケース | 対応方針 |
|
|
24
|
+
|--------|---------|
|
|
25
|
+
| {既存レコードの変換} | {方針} |
|
|
26
|
+
| {seed データ} | {方針} |
|
|
27
|
+
| {データ移行スクリプト} | {方針} |
|
|
28
|
+
|
|
29
|
+
## ゼロダウンタイム戦略
|
|
30
|
+
|
|
31
|
+
- **要否**: {必要 / 不要}
|
|
32
|
+
- **方針**: {例: backward compatible な変更を先に適用 → デプロイ → 旧カラム削除}
|
|
33
|
+
|
|
34
|
+
## ロールバック方針
|
|
35
|
+
|
|
36
|
+
- {ロールバック手順・条件}
|
|
37
|
+
|
|
38
|
+
## 適用順序・依存関係
|
|
39
|
+
|
|
40
|
+
- {Migration ファイル間の依存がある場合に記載}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
spec_runner:
|
|
3
|
+
type: external-service
|
|
4
|
+
provider: {プロバイダー名}
|
|
5
|
+
service: {サービス名}
|
|
6
|
+
maps_to: ""
|
|
7
|
+
depends_on: []
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# {サービス名}
|
|
11
|
+
|
|
12
|
+
## 用途・役割
|
|
13
|
+
|
|
14
|
+
## 設定・接続情報
|
|
15
|
+
|
|
16
|
+
| 項目 | 値 |
|
|
17
|
+
|------|-----|
|
|
18
|
+
| | |
|
|
19
|
+
|
|
20
|
+
## データ構造・スキーマ
|
|
21
|
+
|
|
22
|
+
## アクセス制御・権限
|
|
23
|
+
|
|
24
|
+
## 注意事項
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
spec_runner:
|
|
3
|
+
node_id: adr.{decision_slug}
|
|
4
|
+
kind: adr
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# {決定内容のタイトル}
|
|
8
|
+
|
|
9
|
+
**ステータス**: 提案 / 採用 / 廃止 / 置換
|
|
10
|
+
**日付**: YYYY-MM-DD
|
|
11
|
+
|
|
12
|
+
## コンテキスト
|
|
13
|
+
|
|
14
|
+
| 項目 | 内容 |
|
|
15
|
+
|------|------|
|
|
16
|
+
| 現在の状況 | {問題・課題} |
|
|
17
|
+
| 要件 | {実現する必要があること} |
|
|
18
|
+
| 制約 | {技術的・ビジネス的制約} |
|
|
19
|
+
|
|
20
|
+
## 決定
|
|
21
|
+
|
|
22
|
+
**採用案**: {案名}
|
|
23
|
+
|
|
24
|
+
### 採用理由
|
|
25
|
+
|
|
26
|
+
- {理由1}
|
|
27
|
+
- {理由2}
|
|
28
|
+
|
|
29
|
+
### 実装方針
|
|
30
|
+
|
|
31
|
+
1. {方針1}
|
|
32
|
+
2. {方針2}
|
|
33
|
+
3. {方針3}
|
|
34
|
+
|
|
35
|
+
## 影響
|
|
36
|
+
|
|
37
|
+
| カテゴリ | 項目 | 内容 |
|
|
38
|
+
|----------|------|------|
|
|
39
|
+
| システム | 新規追加 | {コンポーネント} |
|
|
40
|
+
| システム | 変更 | {コンポーネント} |
|
|
41
|
+
| パフォーマンス | 処理速度 | {変化} |
|
|
42
|
+
| コスト | 追加コスト | {影響} |
|
|
43
|
+
| 制約 | 将来課題 | {課題} |
|
|
44
|
+
|
|
45
|
+
### 反映が必要な文書
|
|
46
|
+
|
|
47
|
+
- `docs/02_概要設計/{対象文書}.md`
|
|
48
|
+
- `docs/03_詳細設計/src/{対象パス}.md`
|
|
@@ -28,8 +28,9 @@ Phase 1: 変更要求の整理と軽い影響調査
|
|
|
28
28
|
Phase 2: ADR 作成(必要時)
|
|
29
29
|
Phase 3: 影響ドキュメントの確定
|
|
30
30
|
Phase 4: 概要設計の修正
|
|
31
|
-
Phase 5:
|
|
32
|
-
Phase 6:
|
|
31
|
+
Phase 5: ベストプラクティス調査(必要時)
|
|
32
|
+
Phase 6: 詳細設計の修正
|
|
33
|
+
Phase 7: TDD → 実装 → 検証
|
|
33
34
|
```
|
|
34
35
|
|
|
35
36
|
## Phase 1: 変更要求の整理と軽い影響調査
|
|
@@ -90,7 +91,24 @@ Phase 6: TDD → 実装 → 検証
|
|
|
90
91
|
|
|
91
92
|
修正完了ごとにチェックリストを更新する。全概要設計の修正完了後、ユーザーに確認・承認を得る。
|
|
92
93
|
|
|
93
|
-
## Phase 5:
|
|
94
|
+
## Phase 5: ベストプラクティス調査(必要時)
|
|
95
|
+
|
|
96
|
+
概要設計の修正が承認された後、詳細設計の修正に入る前に実施する。
|
|
97
|
+
|
|
98
|
+
1. 「詳細設計の修正に先立ち、ベストプラクティスを調査すべき技術・サービスはありますか?」とユーザーに確認する
|
|
99
|
+
2. 調査する技術・サービスの公式ドキュメント URL を `.spec-runner/references/resources.md` に追記する(ユーザーが知っている URL + AI が有用と判断した URL も積極的に追加する)
|
|
100
|
+
3. WebSearch(resources.md の URL を起点に)でベストプラクティスを調査し、結果を保存する
|
|
101
|
+
4. 調査不要の場合はスキップして次へ進む
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
docs/バックエンド/04_調査資料/
|
|
105
|
+
{カテゴリ名}/ # 例: AWS/, GCP/, 設計パターン/
|
|
106
|
+
{トピック名}.md
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
- ユーザーに確認・承認を得てから次へ進む
|
|
110
|
+
|
|
111
|
+
## Phase 6: 詳細設計の修正
|
|
94
112
|
|
|
95
113
|
### バックエンド
|
|
96
114
|
|
|
@@ -112,6 +130,19 @@ Phase 6: TDD → 実装 → 検証
|
|
|
112
130
|
|
|
113
131
|
ヘッダーの `depends_on` / `maps_to` を更新する。ユーザーに最終確認を得る。
|
|
114
132
|
|
|
115
|
-
## Phase 6:
|
|
133
|
+
## Phase 6.5: マイグレーション戦略(DB 変更がある場合のみ)
|
|
134
|
+
|
|
135
|
+
Phase 6 でスキーマ定義の変更があった場合に実施する。DB 変更がなければスキップして Phase 7 へ進む。
|
|
136
|
+
|
|
137
|
+
1. 既存の `DB/マイグレーション戦略.md` を確認し、今回の変更で影響する項目を洗い出す
|
|
138
|
+
2. 変更内容に応じて以下を更新する
|
|
139
|
+
- Up / Down 方針の変更有無
|
|
140
|
+
- ゼロダウンタイムの要否(既存データへの影響があるか)
|
|
141
|
+
- ロールバック方針の変更有無
|
|
142
|
+
- 既存データの変換が必要かどうか
|
|
143
|
+
3. `DB/マイグレーション戦略.md` を更新する
|
|
144
|
+
4. ユーザーに確認・承認を得る
|
|
145
|
+
|
|
146
|
+
## Phase 7: TDD → 実装 → 検証
|
|
116
147
|
|
|
117
148
|
設計書修正が承認されたら `test-driven-development` スキルへ移行する。
|