@k2works/claude-code-booster 0.16.0 → 0.16.2
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/LICENSE +21 -21
- package/README.md +42 -42
- package/bin/claude-code-booster +68 -68
- package/lib/assets/.claude/.mcp.json +45 -45
- package/lib/assets/.claude/COMMAND_TEMPLATE.md +122 -122
- package/lib/assets/.claude/README.md +140 -140
- package/lib/assets/.claude/commands/analysis-architecture.md +98 -98
- package/lib/assets/.claude/commands/analysis-data-model.md +94 -94
- package/lib/assets/.claude/commands/analysis-domain-model.md +101 -101
- package/lib/assets/.claude/commands/analysis-non-functional.md +103 -103
- package/lib/assets/.claude/commands/analysis-operation.md +104 -104
- package/lib/assets/.claude/commands/analysis-requirements.md +100 -100
- package/lib/assets/.claude/commands/analysis-tech-stack.md +113 -113
- package/lib/assets/.claude/commands/analysis-test-strategy.md +101 -101
- package/lib/assets/.claude/commands/analysis-ui-design.md +100 -100
- package/lib/assets/.claude/commands/analysis-usecases.md +100 -100
- package/lib/assets/.claude/commands/analysis.md +103 -103
- package/lib/assets/.claude/commands/dev-backend.md +144 -144
- package/lib/assets/.claude/commands/dev-frontend.md +126 -126
- package/lib/assets/.claude/commands/dev.md +96 -96
- package/lib/assets/.claude/commands/docs.md +213 -213
- package/lib/assets/.claude/commands/git-commit.md +47 -47
- package/lib/assets/.claude/commands/kill.md +108 -108
- package/lib/assets/.claude/commands/ops.md +507 -507
- package/lib/assets/.claude/commands/plan-github.md +212 -212
- package/lib/assets/.claude/commands/plan.md +237 -237
- package/lib/assets/.claude/commands/progress.md +171 -171
- package/lib/assets/.claude/settings.json +8 -7
- package/lib/assets/.claude/skills/ai-agent-guidelines/SKILL.md +119 -119
- package/lib/assets/.claude/skills/git-commit/SKILL.md +106 -106
- package/lib/assets/.devcontainer/devcontainer.json +34 -34
- package/lib/assets/.github/workflows/docker-publish.yml +77 -77
- package/lib/assets/.github/workflows/mkdocs.yml +39 -39
- package/lib/assets/AGENTS.md +94 -94
- package/lib/assets/CLAUDE.md +319 -319
- package/lib/assets/Dockerfile +104 -97
- package/lib/assets/README.md +234 -234
- package/lib/assets/docker-compose.yml +33 -33
- package/lib/assets/docs/assets/css/extra.css +29 -29
- package/lib/assets/docs/assets/js/extra.js +44 -44
- package/lib/assets/docs/index.md +14 -14
- package/lib/assets/docs/reference/Java/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/347/222/260/345/242/203/346/247/213/347/257/211/343/202/254/343/202/244/343/203/211.md +569 -569
- package/lib/assets/docs/reference/TypeScript/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/347/222/260/345/242/203/346/247/213/347/257/211/343/202/254/343/202/244/343/203/211.md +464 -464
- package/lib/assets/docs/reference/UI/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +445 -445
- package/lib/assets/docs/reference//343/202/210/343/201/204/343/202/275/343/203/225/343/203/210/343/202/246/343/202/247/343/202/242/343/201/250/343/201/257.md +219 -219
- package/lib/assets/docs/reference//343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +2193 -2193
- package/lib/assets/docs/reference//343/202/244/343/203/263/343/203/225/343/203/251/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +1878 -1878
- package/lib/assets/docs/reference//343/202/250/343/202/257/343/202/271/343/203/210/343/203/252/343/203/274/343/203/240/343/203/227/343/203/255/343/202/260/343/203/251/343/203/237/343/203/263/343/202/260.md +554 -554
- package/lib/assets/docs/reference//343/202/263/343/203/274/343/203/207/343/202/243/343/203/263/343/202/260/343/201/250/343/203/206/343/202/271/343/203/210/343/202/254/343/202/244/343/203/211.md +703 -703
- package/lib/assets/docs/reference//343/203/206/343/202/271/343/203/210/346/210/246/347/225/245/343/202/254/343/202/244/343/203/211.md +1309 -1309
- package/lib/assets/docs/reference//343/203/207/343/203/274/343/202/277/343/203/242/343/203/207/343/203/253/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +311 -311
- package/lib/assets/docs/reference//343/203/211/343/203/241/343/202/244/343/203/263/343/203/242/343/203/207/343/203/253/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +599 -599
- package/lib/assets/docs/reference//343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271/344/275/234/346/210/220/343/202/254/343/202/244/343/203/211.md +671 -671
- package/lib/assets/docs/reference//343/203/252/343/203/252/343/203/274/343/202/271/343/203/273/343/202/244/343/203/206/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/350/250/210/347/224/273/343/202/254/343/202/244/343/203/211.md +523 -523
- package/lib/assets/docs/reference//350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +1248 -1248
- package/lib/assets/docs/reference//351/201/213/347/224/250/350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +392 -392
- package/lib/assets/docs/reference//351/226/213/347/231/272/343/202/254/343/202/244/343/203/211.md +235 -235
- package/lib/assets/docs/reference//351/235/236/346/251/237/350/203/275/350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +1230 -1230
- package/lib/assets/docs/template/ADR.md +30 -30
- package/lib/assets/docs/template/README.md +50 -50
- package/lib/assets/docs/template//343/201/276/343/201/232/343/201/223/343/202/214/343/202/222/350/252/255/343/202/202/343/201/206/343/203/252/343/202/271/343/203/210.md +12 -12
- package/lib/assets/docs/template//343/202/244/343/203/206/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/345/256/214/344/272/206/345/240/261/345/221/212/346/233/270.md +58 -58
- package/lib/assets/docs/template//343/202/244/343/203/263/343/202/273/343/203/227/343/202/267/343/203/247/343/203/263/343/203/207/343/203/203/343/202/255.md +13 -13
- package/lib/assets/docs/template//345/256/214/345/205/250/345/275/242/345/274/217/343/201/256/343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271.md +68 -68
- package/lib/assets/docs/template//350/246/201/344/273/266/345/256/232/347/276/251.md +669 -669
- package/lib/assets/docs/template//350/250/255/350/250/210.md +163 -163
- package/lib/assets/flake.nix +22 -22
- package/lib/assets/gulpfile.js +18 -18
- package/lib/assets/mkdocs.yml +63 -63
- package/lib/assets/ops/docker/mkdoc/Dockerfile +19 -19
- package/lib/assets/ops/nix/environments/node/shell.nix +20 -20
- package/lib/assets/ops/nix/environments/python/shell.nix +20 -20
- package/lib/assets/ops/nix/shells/shell.nix +21 -17
- package/lib/assets/ops/scripts/journal.js +180 -180
- package/lib/assets/ops/scripts/mkdocs.js +113 -113
- package/lib/assets/package-lock.json +1640 -1640
- package/lib/assets/package.json +34 -33
- package/lib/gulpfile.js +37 -37
- package/package.json +40 -40
|
@@ -1,213 +1,213 @@
|
|
|
1
|
-
## Docs Command
|
|
2
|
-
|
|
3
|
-
設計ドキュメントの一覧表示、進捗確認、内容参照を行うコマンド。
|
|
4
|
-
|
|
5
|
-
### 使い方
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
/docs [オプション]
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
### オプション
|
|
12
|
-
|
|
13
|
-
- なし : ドキュメント一覧と進捗状況を表示
|
|
14
|
-
- `--list` : ドキュメント一覧のみを表示
|
|
15
|
-
- `--status` : ドキュメントの作成状況を詳細表示
|
|
16
|
-
- `--read <ファイル名>` : 指定したドキュメントの内容を表示
|
|
17
|
-
- `--summary` : 全ドキュメントの概要を表示
|
|
18
|
-
- `--update` : `docs/index.md` と `mkdocs.yml` を現在のドキュメント構成に合わせて更新
|
|
19
|
-
- `--update-index` : `docs/index.md` のみを更新
|
|
20
|
-
- `--update-mkdocs` : `mkdocs.yml` のみを更新
|
|
21
|
-
|
|
22
|
-
### 基本例
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
# ドキュメント一覧と進捗確認
|
|
26
|
-
/docs
|
|
27
|
-
「設計ドキュメントの一覧と作成状況を確認」
|
|
28
|
-
|
|
29
|
-
# 一覧のみ表示
|
|
30
|
-
/docs --list
|
|
31
|
-
「docs/design/ と docs/requirements/ のファイル一覧を表示」
|
|
32
|
-
|
|
33
|
-
# 詳細な進捗状況
|
|
34
|
-
/docs --status
|
|
35
|
-
「各ドキュメントの完成度や更新日時を含む詳細情報を表示」
|
|
36
|
-
|
|
37
|
-
# 特定ドキュメントの参照
|
|
38
|
-
/docs --read tech_stack
|
|
39
|
-
「技術スタック選定ドキュメントの内容を表示」
|
|
40
|
-
|
|
41
|
-
# 全ドキュメントの概要
|
|
42
|
-
/docs --summary
|
|
43
|
-
「全ドキュメントの目的と主要な内容を要約表示」
|
|
44
|
-
|
|
45
|
-
# docs/index.md と mkdocs.yml を更新
|
|
46
|
-
/docs --update
|
|
47
|
-
「現在のドキュメント構成に合わせて両ファイルを更新」
|
|
48
|
-
|
|
49
|
-
# docs/index.md のみ更新
|
|
50
|
-
/docs --update-index
|
|
51
|
-
「docs/index.md を現在のドキュメント構成に合わせて更新」
|
|
52
|
-
|
|
53
|
-
# mkdocs.yml のみ更新
|
|
54
|
-
/docs --update-mkdocs
|
|
55
|
-
「mkdocs.yml の nav セクションを現在のドキュメント構成に合わせて更新」
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### 詳細機能
|
|
59
|
-
|
|
60
|
-
#### ドキュメント構成
|
|
61
|
-
|
|
62
|
-
本プロジェクトのドキュメントは以下の構成で管理されています:
|
|
63
|
-
|
|
64
|
-
**要件定義ドキュメント** (`docs/requirements/`)
|
|
65
|
-
- `requirements_definition.md` : 要件定義書(RDRA 2.0)
|
|
66
|
-
- `business_usecase.md` : ビジネスユースケース
|
|
67
|
-
- `system_usecase.md` : システムユースケース
|
|
68
|
-
- `user_story.md` : ユーザーストーリー
|
|
69
|
-
|
|
70
|
-
**設計ドキュメント** (`docs/design/`)
|
|
71
|
-
- `architecture_backend.md` : バックエンドアーキテクチャ
|
|
72
|
-
- `architecture_frontend.md` : フロントエンドアーキテクチャ
|
|
73
|
-
- `architecture_infrastructure.md` : インフラストラクチャ
|
|
74
|
-
- `data-model.md` : データモデル設計
|
|
75
|
-
- `domain-model.md` : ドメインモデル設計
|
|
76
|
-
- `ui-design.md` : UI 設計
|
|
77
|
-
- `test_strategy.md` : テスト戦略
|
|
78
|
-
- `non_functional.md` : 非機能要件
|
|
79
|
-
- `operation.md` : 運用要件
|
|
80
|
-
- `tech_stack.md` : 技術スタック選定
|
|
81
|
-
|
|
82
|
-
#### ドキュメント参照
|
|
83
|
-
|
|
84
|
-
以下のコマンドで特定のドキュメントを参照できます:
|
|
85
|
-
|
|
86
|
-
```bash
|
|
87
|
-
# 技術スタックを参照
|
|
88
|
-
/docs --read tech_stack
|
|
89
|
-
|
|
90
|
-
# アーキテクチャを参照
|
|
91
|
-
/docs --read architecture_backend
|
|
92
|
-
|
|
93
|
-
# 要件定義を参照
|
|
94
|
-
/docs --read requirements_definition
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
#### ドキュメント更新機能
|
|
98
|
-
|
|
99
|
-
`--update` オプションを使用すると、現在のドキュメント構成に合わせて `docs/index.md` と `mkdocs.yml` を自動更新できます。
|
|
100
|
-
|
|
101
|
-
**docs/index.md の更新内容**:
|
|
102
|
-
- ドキュメント一覧をカテゴリ別に整理
|
|
103
|
-
- 各ドキュメントへのリンクと説明を生成
|
|
104
|
-
- 「まずこれを読もうリスト」形式で構成
|
|
105
|
-
|
|
106
|
-
**mkdocs.yml の更新内容**:
|
|
107
|
-
- `nav` セクションを現在のドキュメント構成に合わせて更新
|
|
108
|
-
- 要件定義、設計、開発、運用などのカテゴリで階層化
|
|
109
|
-
- 新しいドキュメントを自動的にナビゲーションに追加
|
|
110
|
-
|
|
111
|
-
```bash
|
|
112
|
-
# 更新前に差分を確認
|
|
113
|
-
/docs --status
|
|
114
|
-
「現在のドキュメント構成を確認」
|
|
115
|
-
|
|
116
|
-
# 両ファイルを更新
|
|
117
|
-
/docs --update
|
|
118
|
-
「docs/index.md と mkdocs.yml を更新」
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
### 出力例
|
|
122
|
-
|
|
123
|
-
```
|
|
124
|
-
設計ドキュメント一覧
|
|
125
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
126
|
-
|
|
127
|
-
📁 docs/requirements/
|
|
128
|
-
├─ ✅ requirements_definition.md (要件定義書)
|
|
129
|
-
├─ ✅ business_usecase.md (ビジネスユースケース)
|
|
130
|
-
├─ ✅ system_usecase.md (システムユースケース)
|
|
131
|
-
└─ ✅ user_story.md (ユーザーストーリー)
|
|
132
|
-
|
|
133
|
-
📁 docs/design/
|
|
134
|
-
├─ ✅ architecture_backend.md (バックエンドアーキテクチャ)
|
|
135
|
-
├─ ✅ architecture_frontend.md (フロントエンドアーキテクチャ)
|
|
136
|
-
├─ ✅ architecture_infrastructure.md (インフラストラクチャ)
|
|
137
|
-
├─ ✅ data-model.md (データモデル設計)
|
|
138
|
-
├─ ✅ domain-model.md (ドメインモデル設計)
|
|
139
|
-
├─ ✅ ui-design.md (UI 設計)
|
|
140
|
-
├─ ✅ test_strategy.md (テスト戦略)
|
|
141
|
-
├─ ✅ non_functional.md (非機能要件)
|
|
142
|
-
├─ ✅ operation.md (運用要件)
|
|
143
|
-
└─ ✅ tech_stack.md (技術スタック選定)
|
|
144
|
-
|
|
145
|
-
進捗: 14/14 ドキュメント完成 (100%)
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
#### --update 実行時の出力例
|
|
149
|
-
|
|
150
|
-
```
|
|
151
|
-
ドキュメント更新
|
|
152
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
153
|
-
|
|
154
|
-
📝 docs/index.md を更新しています...
|
|
155
|
-
✅ 要件定義セクションを追加
|
|
156
|
-
✅ 設計ドキュメントセクションを追加
|
|
157
|
-
✅ 開発ドキュメントセクションを追加
|
|
158
|
-
✅ 運用ドキュメントセクションを追加
|
|
159
|
-
|
|
160
|
-
📝 mkdocs.yml を更新しています...
|
|
161
|
-
✅ nav セクションを更新
|
|
162
|
-
✅ 14 件のドキュメントをナビゲーションに追加
|
|
163
|
-
|
|
164
|
-
更新完了!
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
### Claude との連携
|
|
168
|
-
|
|
169
|
-
```bash
|
|
170
|
-
# ドキュメント状況確認後に分析
|
|
171
|
-
/docs --status
|
|
172
|
-
「不足しているドキュメントがあれば作成を提案」
|
|
173
|
-
|
|
174
|
-
# 特定ドキュメントを参照して修正
|
|
175
|
-
/docs --read tech_stack
|
|
176
|
-
「技術スタックの内容を確認して改善点を提案」
|
|
177
|
-
|
|
178
|
-
# 全体概要を確認してレビュー
|
|
179
|
-
/docs --summary
|
|
180
|
-
「ドキュメント全体の整合性をレビュー」
|
|
181
|
-
|
|
182
|
-
# 新しいドキュメント作成後にインデックスを更新
|
|
183
|
-
/docs --update
|
|
184
|
-
「docs/index.md と mkdocs.yml を最新のドキュメント構成に同期」
|
|
185
|
-
|
|
186
|
-
# MkDocs でドキュメントサイトをプレビュー
|
|
187
|
-
/docs --update-mkdocs
|
|
188
|
-
「mkdocs.yml を更新後、mkdocs serve でプレビュー確認」
|
|
189
|
-
```
|
|
190
|
-
|
|
191
|
-
### 注意事項
|
|
192
|
-
|
|
193
|
-
- **前提条件**: `docs/` ディレクトリが存在すること
|
|
194
|
-
- **制限事項**: Markdown 形式のドキュメントのみ対応
|
|
195
|
-
- **推奨事項**: 定期的にドキュメントの進捗を確認し、最新の状態を維持すること
|
|
196
|
-
- **更新時の注意**: `--update` 実行前に現在の `docs/index.md` と `mkdocs.yml` をバックアップすることを推奨
|
|
197
|
-
- **MkDocs 依存**: `--update-mkdocs` を使用する場合、MkDocs がインストールされている必要がある
|
|
198
|
-
|
|
199
|
-
### ベストプラクティス
|
|
200
|
-
|
|
201
|
-
1. **定期確認**: 開発フェーズ移行前にドキュメントの完成度を確認する
|
|
202
|
-
2. **整合性維持**: コード変更時は関連ドキュメントも更新する
|
|
203
|
-
3. **レビュー活用**: チームレビュー前にドキュメント概要を共有する
|
|
204
|
-
4. **バージョン管理**: ドキュメントの変更は Git でコミットする
|
|
205
|
-
5. **インデックス同期**: 新しいドキュメント作成後は `--update` でインデックスを同期する
|
|
206
|
-
6. **プレビュー確認**: `--update-mkdocs` 後は `mkdocs serve` でナビゲーションを確認する
|
|
207
|
-
|
|
208
|
-
### 関連コマンド
|
|
209
|
-
|
|
210
|
-
- `/analysis` : 分析フェーズ全体の作業支援
|
|
211
|
-
- `/analysis-requirements` : 要件定義関連の作業支援
|
|
212
|
-
- `/analysis-architecture` : アーキテクチャ設計支援
|
|
213
|
-
- `/progress` : プロジェクト全体の進捗確認
|
|
1
|
+
## Docs Command
|
|
2
|
+
|
|
3
|
+
設計ドキュメントの一覧表示、進捗確認、内容参照を行うコマンド。
|
|
4
|
+
|
|
5
|
+
### 使い方
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
/docs [オプション]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### オプション
|
|
12
|
+
|
|
13
|
+
- なし : ドキュメント一覧と進捗状況を表示
|
|
14
|
+
- `--list` : ドキュメント一覧のみを表示
|
|
15
|
+
- `--status` : ドキュメントの作成状況を詳細表示
|
|
16
|
+
- `--read <ファイル名>` : 指定したドキュメントの内容を表示
|
|
17
|
+
- `--summary` : 全ドキュメントの概要を表示
|
|
18
|
+
- `--update` : `docs/index.md` と `mkdocs.yml` を現在のドキュメント構成に合わせて更新
|
|
19
|
+
- `--update-index` : `docs/index.md` のみを更新
|
|
20
|
+
- `--update-mkdocs` : `mkdocs.yml` のみを更新
|
|
21
|
+
|
|
22
|
+
### 基本例
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# ドキュメント一覧と進捗確認
|
|
26
|
+
/docs
|
|
27
|
+
「設計ドキュメントの一覧と作成状況を確認」
|
|
28
|
+
|
|
29
|
+
# 一覧のみ表示
|
|
30
|
+
/docs --list
|
|
31
|
+
「docs/design/ と docs/requirements/ のファイル一覧を表示」
|
|
32
|
+
|
|
33
|
+
# 詳細な進捗状況
|
|
34
|
+
/docs --status
|
|
35
|
+
「各ドキュメントの完成度や更新日時を含む詳細情報を表示」
|
|
36
|
+
|
|
37
|
+
# 特定ドキュメントの参照
|
|
38
|
+
/docs --read tech_stack
|
|
39
|
+
「技術スタック選定ドキュメントの内容を表示」
|
|
40
|
+
|
|
41
|
+
# 全ドキュメントの概要
|
|
42
|
+
/docs --summary
|
|
43
|
+
「全ドキュメントの目的と主要な内容を要約表示」
|
|
44
|
+
|
|
45
|
+
# docs/index.md と mkdocs.yml を更新
|
|
46
|
+
/docs --update
|
|
47
|
+
「現在のドキュメント構成に合わせて両ファイルを更新」
|
|
48
|
+
|
|
49
|
+
# docs/index.md のみ更新
|
|
50
|
+
/docs --update-index
|
|
51
|
+
「docs/index.md を現在のドキュメント構成に合わせて更新」
|
|
52
|
+
|
|
53
|
+
# mkdocs.yml のみ更新
|
|
54
|
+
/docs --update-mkdocs
|
|
55
|
+
「mkdocs.yml の nav セクションを現在のドキュメント構成に合わせて更新」
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### 詳細機能
|
|
59
|
+
|
|
60
|
+
#### ドキュメント構成
|
|
61
|
+
|
|
62
|
+
本プロジェクトのドキュメントは以下の構成で管理されています:
|
|
63
|
+
|
|
64
|
+
**要件定義ドキュメント** (`docs/requirements/`)
|
|
65
|
+
- `requirements_definition.md` : 要件定義書(RDRA 2.0)
|
|
66
|
+
- `business_usecase.md` : ビジネスユースケース
|
|
67
|
+
- `system_usecase.md` : システムユースケース
|
|
68
|
+
- `user_story.md` : ユーザーストーリー
|
|
69
|
+
|
|
70
|
+
**設計ドキュメント** (`docs/design/`)
|
|
71
|
+
- `architecture_backend.md` : バックエンドアーキテクチャ
|
|
72
|
+
- `architecture_frontend.md` : フロントエンドアーキテクチャ
|
|
73
|
+
- `architecture_infrastructure.md` : インフラストラクチャ
|
|
74
|
+
- `data-model.md` : データモデル設計
|
|
75
|
+
- `domain-model.md` : ドメインモデル設計
|
|
76
|
+
- `ui-design.md` : UI 設計
|
|
77
|
+
- `test_strategy.md` : テスト戦略
|
|
78
|
+
- `non_functional.md` : 非機能要件
|
|
79
|
+
- `operation.md` : 運用要件
|
|
80
|
+
- `tech_stack.md` : 技術スタック選定
|
|
81
|
+
|
|
82
|
+
#### ドキュメント参照
|
|
83
|
+
|
|
84
|
+
以下のコマンドで特定のドキュメントを参照できます:
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
# 技術スタックを参照
|
|
88
|
+
/docs --read tech_stack
|
|
89
|
+
|
|
90
|
+
# アーキテクチャを参照
|
|
91
|
+
/docs --read architecture_backend
|
|
92
|
+
|
|
93
|
+
# 要件定義を参照
|
|
94
|
+
/docs --read requirements_definition
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
#### ドキュメント更新機能
|
|
98
|
+
|
|
99
|
+
`--update` オプションを使用すると、現在のドキュメント構成に合わせて `docs/index.md` と `mkdocs.yml` を自動更新できます。
|
|
100
|
+
|
|
101
|
+
**docs/index.md の更新内容**:
|
|
102
|
+
- ドキュメント一覧をカテゴリ別に整理
|
|
103
|
+
- 各ドキュメントへのリンクと説明を生成
|
|
104
|
+
- 「まずこれを読もうリスト」形式で構成
|
|
105
|
+
|
|
106
|
+
**mkdocs.yml の更新内容**:
|
|
107
|
+
- `nav` セクションを現在のドキュメント構成に合わせて更新
|
|
108
|
+
- 要件定義、設計、開発、運用などのカテゴリで階層化
|
|
109
|
+
- 新しいドキュメントを自動的にナビゲーションに追加
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
# 更新前に差分を確認
|
|
113
|
+
/docs --status
|
|
114
|
+
「現在のドキュメント構成を確認」
|
|
115
|
+
|
|
116
|
+
# 両ファイルを更新
|
|
117
|
+
/docs --update
|
|
118
|
+
「docs/index.md と mkdocs.yml を更新」
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### 出力例
|
|
122
|
+
|
|
123
|
+
```
|
|
124
|
+
設計ドキュメント一覧
|
|
125
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
126
|
+
|
|
127
|
+
📁 docs/requirements/
|
|
128
|
+
├─ ✅ requirements_definition.md (要件定義書)
|
|
129
|
+
├─ ✅ business_usecase.md (ビジネスユースケース)
|
|
130
|
+
├─ ✅ system_usecase.md (システムユースケース)
|
|
131
|
+
└─ ✅ user_story.md (ユーザーストーリー)
|
|
132
|
+
|
|
133
|
+
📁 docs/design/
|
|
134
|
+
├─ ✅ architecture_backend.md (バックエンドアーキテクチャ)
|
|
135
|
+
├─ ✅ architecture_frontend.md (フロントエンドアーキテクチャ)
|
|
136
|
+
├─ ✅ architecture_infrastructure.md (インフラストラクチャ)
|
|
137
|
+
├─ ✅ data-model.md (データモデル設計)
|
|
138
|
+
├─ ✅ domain-model.md (ドメインモデル設計)
|
|
139
|
+
├─ ✅ ui-design.md (UI 設計)
|
|
140
|
+
├─ ✅ test_strategy.md (テスト戦略)
|
|
141
|
+
├─ ✅ non_functional.md (非機能要件)
|
|
142
|
+
├─ ✅ operation.md (運用要件)
|
|
143
|
+
└─ ✅ tech_stack.md (技術スタック選定)
|
|
144
|
+
|
|
145
|
+
進捗: 14/14 ドキュメント完成 (100%)
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
#### --update 実行時の出力例
|
|
149
|
+
|
|
150
|
+
```
|
|
151
|
+
ドキュメント更新
|
|
152
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
153
|
+
|
|
154
|
+
📝 docs/index.md を更新しています...
|
|
155
|
+
✅ 要件定義セクションを追加
|
|
156
|
+
✅ 設計ドキュメントセクションを追加
|
|
157
|
+
✅ 開発ドキュメントセクションを追加
|
|
158
|
+
✅ 運用ドキュメントセクションを追加
|
|
159
|
+
|
|
160
|
+
📝 mkdocs.yml を更新しています...
|
|
161
|
+
✅ nav セクションを更新
|
|
162
|
+
✅ 14 件のドキュメントをナビゲーションに追加
|
|
163
|
+
|
|
164
|
+
更新完了!
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Claude との連携
|
|
168
|
+
|
|
169
|
+
```bash
|
|
170
|
+
# ドキュメント状況確認後に分析
|
|
171
|
+
/docs --status
|
|
172
|
+
「不足しているドキュメントがあれば作成を提案」
|
|
173
|
+
|
|
174
|
+
# 特定ドキュメントを参照して修正
|
|
175
|
+
/docs --read tech_stack
|
|
176
|
+
「技術スタックの内容を確認して改善点を提案」
|
|
177
|
+
|
|
178
|
+
# 全体概要を確認してレビュー
|
|
179
|
+
/docs --summary
|
|
180
|
+
「ドキュメント全体の整合性をレビュー」
|
|
181
|
+
|
|
182
|
+
# 新しいドキュメント作成後にインデックスを更新
|
|
183
|
+
/docs --update
|
|
184
|
+
「docs/index.md と mkdocs.yml を最新のドキュメント構成に同期」
|
|
185
|
+
|
|
186
|
+
# MkDocs でドキュメントサイトをプレビュー
|
|
187
|
+
/docs --update-mkdocs
|
|
188
|
+
「mkdocs.yml を更新後、mkdocs serve でプレビュー確認」
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### 注意事項
|
|
192
|
+
|
|
193
|
+
- **前提条件**: `docs/` ディレクトリが存在すること
|
|
194
|
+
- **制限事項**: Markdown 形式のドキュメントのみ対応
|
|
195
|
+
- **推奨事項**: 定期的にドキュメントの進捗を確認し、最新の状態を維持すること
|
|
196
|
+
- **更新時の注意**: `--update` 実行前に現在の `docs/index.md` と `mkdocs.yml` をバックアップすることを推奨
|
|
197
|
+
- **MkDocs 依存**: `--update-mkdocs` を使用する場合、MkDocs がインストールされている必要がある
|
|
198
|
+
|
|
199
|
+
### ベストプラクティス
|
|
200
|
+
|
|
201
|
+
1. **定期確認**: 開発フェーズ移行前にドキュメントの完成度を確認する
|
|
202
|
+
2. **整合性維持**: コード変更時は関連ドキュメントも更新する
|
|
203
|
+
3. **レビュー活用**: チームレビュー前にドキュメント概要を共有する
|
|
204
|
+
4. **バージョン管理**: ドキュメントの変更は Git でコミットする
|
|
205
|
+
5. **インデックス同期**: 新しいドキュメント作成後は `--update` でインデックスを同期する
|
|
206
|
+
6. **プレビュー確認**: `--update-mkdocs` 後は `mkdocs serve` でナビゲーションを確認する
|
|
207
|
+
|
|
208
|
+
### 関連コマンド
|
|
209
|
+
|
|
210
|
+
- `/analysis` : 分析フェーズ全体の作業支援
|
|
211
|
+
- `/analysis-requirements` : 要件定義関連の作業支援
|
|
212
|
+
- `/analysis-architecture` : アーキテクチャ設計支援
|
|
213
|
+
- `/progress` : プロジェクト全体の進捗確認
|
|
@@ -1,47 +1,47 @@
|
|
|
1
|
-
---
|
|
2
|
-
allowed-tools: Bash(git:*), Bash(npm:*), Read(*.md), Fetch(*)
|
|
3
|
-
description: "ワーキングディレクトリでの変更をコミットします"
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
意味のある変更単位ごとにコミットを行うことは、コードの履歴を明確にし、将来の変更を追跡しやすくするために重要です。
|
|
7
|
-
|
|
8
|
-
以下の手順に従って、ワーキングディレクトリでの変更をコミットします。
|
|
9
|
-
|
|
10
|
-
### 1. 変更を確認する
|
|
11
|
-
|
|
12
|
-
まず、現在のワーキングディレクトリでの変更を確認します。以下のコマンドを実行してください:
|
|
13
|
-
|
|
14
|
-
```bash
|
|
15
|
-
git status
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
### 2. 変更をステージングする
|
|
19
|
-
|
|
20
|
-
変更をコミットする前に、ステージングエリアに追加する必要があります。以下のコマンドを使用して、すべての変更をステージングします:
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
git add 対象ファイルやディレクトリ
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
意味のある変更単位ごとにファイルを指定すること。無条件にすべての変更を追加しないでください。
|
|
27
|
-
|
|
28
|
-
### 3. コミットメッセージを作成する
|
|
29
|
-
|
|
30
|
-
コミットメッセージは、変更内容を簡潔に説明する重要な部分です。以下のコマンドを使用して、コミットを作成します:
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
git commit -m "コミットメッセージをここに入力"
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
- コミットメッセージは日本語で記述してください。
|
|
37
|
-
- Conventional Commitsのルールに従ってください。
|
|
38
|
-
- co-authorやコミットメッセージに"Claude Code"のキーワードは含めないこと。
|
|
39
|
-
|
|
40
|
-
### 4. コミットを確認する
|
|
41
|
-
コミットが正しく行われたかを確認するために、以下のコマンドを実行します:
|
|
42
|
-
|
|
43
|
-
```bash
|
|
44
|
-
git log --oneline
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
これにより、最近のコミットの一覧が表示され、コミットメッセージとハッシュが確認できます。
|
|
1
|
+
---
|
|
2
|
+
allowed-tools: Bash(git:*), Bash(npm:*), Read(*.md), Fetch(*)
|
|
3
|
+
description: "ワーキングディレクトリでの変更をコミットします"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
意味のある変更単位ごとにコミットを行うことは、コードの履歴を明確にし、将来の変更を追跡しやすくするために重要です。
|
|
7
|
+
|
|
8
|
+
以下の手順に従って、ワーキングディレクトリでの変更をコミットします。
|
|
9
|
+
|
|
10
|
+
### 1. 変更を確認する
|
|
11
|
+
|
|
12
|
+
まず、現在のワーキングディレクトリでの変更を確認します。以下のコマンドを実行してください:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
git status
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### 2. 変更をステージングする
|
|
19
|
+
|
|
20
|
+
変更をコミットする前に、ステージングエリアに追加する必要があります。以下のコマンドを使用して、すべての変更をステージングします:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
git add 対象ファイルやディレクトリ
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
意味のある変更単位ごとにファイルを指定すること。無条件にすべての変更を追加しないでください。
|
|
27
|
+
|
|
28
|
+
### 3. コミットメッセージを作成する
|
|
29
|
+
|
|
30
|
+
コミットメッセージは、変更内容を簡潔に説明する重要な部分です。以下のコマンドを使用して、コミットを作成します:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
git commit -m "コミットメッセージをここに入力"
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
- コミットメッセージは日本語で記述してください。
|
|
37
|
+
- Conventional Commitsのルールに従ってください。
|
|
38
|
+
- co-authorやコミットメッセージに"Claude Code"のキーワードは含めないこと。
|
|
39
|
+
|
|
40
|
+
### 4. コミットを確認する
|
|
41
|
+
コミットが正しく行われたかを確認するために、以下のコマンドを実行します:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
git log --oneline
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
これにより、最近のコミットの一覧が表示され、コミットメッセージとハッシュが確認できます。
|