@k2works/claude-code-booster 0.22.0 → 1.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/lib/assets/.claude/README.md +96 -80
- package/lib/assets/.claude/SKILLS_TEMPLATE.md +100 -0
- package/lib/assets/.claude/settings.local.json +2 -8
- package/lib/assets/.claude/skills/analyzing-architecture/SKILL.md +87 -0
- package/lib/assets/.claude/skills/analyzing-data-model/SKILL.md +80 -0
- package/lib/assets/.claude/skills/analyzing-domain-model/SKILL.md +88 -0
- package/lib/assets/.claude/skills/analyzing-non-functional/SKILL.md +91 -0
- package/lib/assets/.claude/skills/analyzing-operation/SKILL.md +91 -0
- package/lib/assets/.claude/skills/analyzing-requirements/SKILL.md +87 -0
- package/lib/assets/.claude/skills/analyzing-tech-stack/SKILL.md +102 -0
- package/lib/assets/.claude/skills/analyzing-test-strategy/SKILL.md +87 -0
- package/lib/assets/.claude/skills/analyzing-ui-design/SKILL.md +86 -0
- package/lib/assets/.claude/skills/analyzing-usecases/SKILL.md +87 -0
- package/lib/assets/.claude/skills/creating-adr/SKILL.md +115 -0
- package/lib/assets/.claude/skills/developing-backend/SKILL.md +89 -0
- package/lib/assets/.claude/skills/developing-frontend/SKILL.md +79 -0
- package/lib/assets/.claude/skills/killing-processes/SKILL.md +98 -0
- package/lib/assets/.claude/skills/managing-docs/SKILL.md +195 -0
- package/lib/assets/.claude/skills/managing-operations/DEPLOY.md +77 -0
- package/lib/assets/.claude/skills/managing-operations/SETUP_CSHARP.md +80 -0
- package/lib/assets/.claude/skills/managing-operations/SETUP_FRONTEND.md +84 -0
- package/lib/assets/.claude/skills/managing-operations/SETUP_JAVA.md +75 -0
- package/lib/assets/.claude/skills/managing-operations/SKILL.md +156 -0
- package/lib/assets/.claude/skills/orchestrating-analysis/SKILL.md +103 -0
- package/lib/assets/.claude/{commands/dev.md → skills/orchestrating-development/SKILL.md} +42 -49
- package/lib/assets/.claude/skills/planning-releases/SKILL.md +222 -0
- package/lib/assets/.claude/{commands/plan-github.md → skills/syncing-github-project/SKILL.md} +78 -159
- package/lib/assets/.claude/skills/tracking-progress/SKILL.md +164 -0
- package/lib/assets/.mcp.json +12 -0
- package/lib/assets/CLAUDE.md +71 -230
- package/lib/assets/README.md +38 -3
- package/lib/assets/docs/reference//343/203/252/343/203/252/343/203/274/343/202/271/343/202/254/343/202/244/343/203/211.md +442 -0
- package/lib/assets/docs/reference//350/250/200/350/252/236/345/210/245/351/226/213/347/231/272/343/202/254/343/202/244/343/203/211.md +8 -7
- 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/350/250/210/347/224/273.md +205 -0
- package/lib/assets/docs/template//343/203/252/343/203/252/343/203/274/343/202/271/350/250/210/347/224/273.md +280 -0
- package/lib/assets/ops/scripts/mkdocs.js +71 -105
- package/lib/assets/ops/scripts/release.js +431 -0
- package/lib/assets/ops/scripts/ssh.js +190 -0
- package/package.json +1 -1
- package/lib/assets/.claude/.mcp.json +0 -45
- package/lib/assets/.claude/COMMAND_TEMPLATE.md +0 -122
- package/lib/assets/.claude/commands/adr.md +0 -177
- package/lib/assets/.claude/commands/analysis-architecture.md +0 -98
- package/lib/assets/.claude/commands/analysis-data-model.md +0 -94
- package/lib/assets/.claude/commands/analysis-domain-model.md +0 -101
- package/lib/assets/.claude/commands/analysis-non-functional.md +0 -103
- package/lib/assets/.claude/commands/analysis-operation.md +0 -104
- package/lib/assets/.claude/commands/analysis-requirements.md +0 -100
- package/lib/assets/.claude/commands/analysis-tech-stack.md +0 -113
- package/lib/assets/.claude/commands/analysis-test-strategy.md +0 -101
- package/lib/assets/.claude/commands/analysis-ui-design.md +0 -100
- package/lib/assets/.claude/commands/analysis-usecases.md +0 -100
- package/lib/assets/.claude/commands/analysis.md +0 -103
- package/lib/assets/.claude/commands/dev-backend.md +0 -144
- package/lib/assets/.claude/commands/dev-frontend.md +0 -126
- package/lib/assets/.claude/commands/docs.md +0 -335
- package/lib/assets/.claude/commands/git-commit.md +0 -47
- package/lib/assets/.claude/commands/kill.md +0 -109
- package/lib/assets/.claude/commands/ops.md +0 -508
- package/lib/assets/.claude/commands/plan.md +0 -238
- package/lib/assets/.claude/commands/progress.md +0 -245
|
@@ -1,103 +0,0 @@
|
|
|
1
|
-
## Analysis Command
|
|
2
|
-
|
|
3
|
-
分析フェーズ全体の作業を支援するコマンド。要件定義から非機能要件まで包括的な分析ワークフローを表示します。
|
|
4
|
-
|
|
5
|
-
### 使い方
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
/analysis
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
### 基本例
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
# 分析フェーズ全体のワークフロー表示
|
|
15
|
-
/analysis
|
|
16
|
-
「分析フェーズの全体的な進め方と各工程の説明」
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
### 詳細機能
|
|
20
|
-
|
|
21
|
-
#### 分析フェーズの全体像
|
|
22
|
-
|
|
23
|
-
分析フェーズは以下の工程で構成されます:
|
|
24
|
-
|
|
25
|
-
1. **要件定義** (`/analysis-requirements`)
|
|
26
|
-
- システム価値の明確化
|
|
27
|
-
- システム外部環境の分析
|
|
28
|
-
- システム境界の定義
|
|
29
|
-
|
|
30
|
-
2. **ユースケース作成** (`/analysis-usecases`)
|
|
31
|
-
- ビジネスユースケースの抽出
|
|
32
|
-
- システムユースケースの定義
|
|
33
|
-
- ユーザーストーリーの作成
|
|
34
|
-
|
|
35
|
-
3. **アーキテクチャ設計** (`/analysis-architecture`)
|
|
36
|
-
- バックエンドアーキテクチャ
|
|
37
|
-
- フロントエンドアーキテクチャ
|
|
38
|
-
- インフラストラクチャアーキテクチャ
|
|
39
|
-
|
|
40
|
-
4. **データモデル設計** (`/analysis-data-model`)
|
|
41
|
-
- ER 図の作成
|
|
42
|
-
- テーブル定義
|
|
43
|
-
|
|
44
|
-
5. **ドメインモデル設計** (`/analysis-domain-model`)
|
|
45
|
-
- エンティティ定義
|
|
46
|
-
- 値オブジェクト定義
|
|
47
|
-
- 集約の設計
|
|
48
|
-
|
|
49
|
-
6. **UI 設計** (`/analysis-ui-design`)
|
|
50
|
-
- 画面遷移図
|
|
51
|
-
- 画面イメージ
|
|
52
|
-
|
|
53
|
-
7. **テスト戦略** (`/analysis-test-strategy`)
|
|
54
|
-
- テストピラミッド設計
|
|
55
|
-
- テスト種別の定義
|
|
56
|
-
|
|
57
|
-
8. **非機能要件** (`/analysis-non-functional`)
|
|
58
|
-
- 性能要件
|
|
59
|
-
- セキュリティ要件
|
|
60
|
-
|
|
61
|
-
9. **運用要件** (`/analysis-operation`)
|
|
62
|
-
- 運用フロー
|
|
63
|
-
- 監視設計
|
|
64
|
-
|
|
65
|
-
10. **技術スタック** (`/analysis-tech-stack`)
|
|
66
|
-
- 技術選定
|
|
67
|
-
- バージョン管理
|
|
68
|
-
|
|
69
|
-
### Claude との連携
|
|
70
|
-
|
|
71
|
-
```bash
|
|
72
|
-
# プロジェクト情報の確認後に分析開始
|
|
73
|
-
ls -la docs/
|
|
74
|
-
cat README.md
|
|
75
|
-
/analysis
|
|
76
|
-
「プロジェクトの現状を踏まえた分析フェーズの進め方を提案」
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
### 注意事項
|
|
80
|
-
|
|
81
|
-
- **前提条件**: プロジェクトの基本的な背景情報の把握が必要
|
|
82
|
-
- **制限事項**: 分析結果は開発フェーズで継続的に見直し・改善が必要
|
|
83
|
-
- **推奨事項**: 各工程の成果物を文書化し、チーム内で共有することを推奨
|
|
84
|
-
|
|
85
|
-
### ベストプラクティス
|
|
86
|
-
|
|
87
|
-
1. **段階的分析**: 要件定義から始めて段階的に詳細化する
|
|
88
|
-
2. **チーム連携**: 分析結果をチーム全体で共有し、合意形成を行う
|
|
89
|
-
3. **継続的改善**: 開発フェーズでのフィードバックを基に分析結果を見直す
|
|
90
|
-
4. **文書化**: 分析結果は PlantUML や Markdown で視覚的に文書化する
|
|
91
|
-
|
|
92
|
-
### 関連コマンド
|
|
93
|
-
|
|
94
|
-
- `/analysis-requirements` : 要件定義関連の作業支援
|
|
95
|
-
- `/analysis-usecases` : ユースケース・ユーザーストーリー作成支援
|
|
96
|
-
- `/analysis-architecture` : アーキテクチャ設計支援
|
|
97
|
-
- `/analysis-data-model` : データモデル設計支援
|
|
98
|
-
- `/analysis-domain-model` : ドメインモデル設計支援
|
|
99
|
-
- `/analysis-ui-design` : UI 設計支援
|
|
100
|
-
- `/analysis-test-strategy` : テスト戦略策定支援
|
|
101
|
-
- `/analysis-non-functional` : 非機能要件定義支援
|
|
102
|
-
- `/analysis-operation` : 運用要件定義支援
|
|
103
|
-
- `/analysis-tech-stack` : 技術スタック選定支援
|
|
@@ -1,144 +0,0 @@
|
|
|
1
|
-
## Backend Development Guide Reference
|
|
2
|
-
|
|
3
|
-
バックエンド開発のためのコーディングとテストガイドを参照し、TDD サイクルに従った開発を支援します。
|
|
4
|
-
|
|
5
|
-
### 使い方
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
/dev-backend [オプション]
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
### オプション
|
|
12
|
-
|
|
13
|
-
- なし : ガイド全体の要約と TDD サイクルの説明
|
|
14
|
-
- `--tdd` : TDD の Red-Green-Refactor サイクルの詳細
|
|
15
|
-
- `--approach` : インサイドアウト/アウトサイドインアプローチの選択指針
|
|
16
|
-
- `--checklist` : コミット前の品質チェックリスト表示
|
|
17
|
-
- `--refactor` : リファクタリングパターンの一覧
|
|
18
|
-
- `--test` : テスト作成のベストプラクティス
|
|
19
|
-
|
|
20
|
-
### 基本例
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
# TDD サイクルの開始
|
|
24
|
-
/dev-backend --tdd
|
|
25
|
-
「現在のタスクに対して Red-Green-Refactor サイクルを開始」
|
|
26
|
-
|
|
27
|
-
# アプローチ戦略の確認
|
|
28
|
-
/dev-backend --approach
|
|
29
|
-
「実装アプローチ(インサイドアウト/アウトサイドイン)の選択を支援」
|
|
30
|
-
|
|
31
|
-
# 品質チェックの実行
|
|
32
|
-
/dev-backend --checklist
|
|
33
|
-
「コミット前の必須確認事項を順次実行」
|
|
34
|
-
|
|
35
|
-
# リファクタリング支援
|
|
36
|
-
/dev-backend --refactor
|
|
37
|
-
「現在のコードに適用可能なリファクタリングパターンを提案」
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
### 詳細機能
|
|
41
|
-
|
|
42
|
-
#### TDD サイクルの実践
|
|
43
|
-
|
|
44
|
-
Red-Green-Refactor サイクルを厳密に実行:
|
|
45
|
-
|
|
46
|
-
1. **Red フェーズ**: 失敗するテストを最初に書く
|
|
47
|
-
2. **Green フェーズ**: テストを通す最小限のコードを実装
|
|
48
|
-
3. **Refactor フェーズ**: 重複を除去し設計を改善
|
|
49
|
-
4. @docs/reference/コーディングとテストガイド.md のワークフローに従う
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
# 新機能の TDD 実装開始
|
|
53
|
-
/dev-backend --tdd
|
|
54
|
-
「User エンティティのテストから開始します」
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
#### 参照ドキュメント
|
|
58
|
-
|
|
59
|
-
- @docs/design/architecture_backend.md を参照
|
|
60
|
-
- @docs/design/data-model.md を参照
|
|
61
|
-
- @docs/design/domain-model.md を参照
|
|
62
|
-
- @docs/design/tech_stack.md を参照
|
|
63
|
-
- @docs/design/test_strategy.md を参照
|
|
64
|
-
- 作業完了後に対象のイテレーション @docs/development/iteration_plan-N.md の進捗を更新する
|
|
65
|
-
|
|
66
|
-
#### アプローチ戦略の選択
|
|
67
|
-
|
|
68
|
-
プロジェクトの状態に応じた最適なアプローチを選択:
|
|
69
|
-
|
|
70
|
-
- **インサイドアウト**: データ層から開始し上位層へ展開(推奨)
|
|
71
|
-
- **アウトサイドイン**: API から開始しドメインロジックを段階的に実装
|
|
72
|
-
|
|
73
|
-
### テストコマンド
|
|
74
|
-
|
|
75
|
-
```bash
|
|
76
|
-
# 全テスト実行
|
|
77
|
-
cd apps/backend && ./gradlew test
|
|
78
|
-
|
|
79
|
-
# 特定テストクラス実行
|
|
80
|
-
cd apps/backend && ./gradlew test --tests "UserServiceTest"
|
|
81
|
-
|
|
82
|
-
# テストカバレッジ確認
|
|
83
|
-
cd apps/backend && ./gradlew jacocoTestReport
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
### API ドキュメント
|
|
87
|
-
|
|
88
|
-
バックエンドには Swagger UI が組み込まれており、API ドキュメントをブラウザで確認できます。
|
|
89
|
-
|
|
90
|
-
```bash
|
|
91
|
-
# バックエンドを起動
|
|
92
|
-
cd apps/backend && ./gradlew bootRun
|
|
93
|
-
|
|
94
|
-
# ブラウザでアクセス
|
|
95
|
-
# Swagger UI: http://localhost:8080/swagger-ui.html
|
|
96
|
-
# OpenAPI JSON: http://localhost:8080/v3/api-docs
|
|
97
|
-
# OpenAPI YAML: http://localhost:8080/api-docs.yaml
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
#### Swagger UI の機能
|
|
101
|
-
|
|
102
|
-
- **API 仕様の確認**: 全エンドポイントの詳細を表示
|
|
103
|
-
- **リクエスト実行**: ブラウザから直接 API をテスト
|
|
104
|
-
- **認証サポート**: JWT トークンを設定して認証付き API をテスト
|
|
105
|
-
- **スキーマ確認**: リクエスト/レスポンスの型定義を確認
|
|
106
|
-
|
|
107
|
-
### Claude との連携
|
|
108
|
-
|
|
109
|
-
```bash
|
|
110
|
-
# 現在のコードを分析してリファクタリング提案
|
|
111
|
-
cat apps/backend/src/main/java/com/example/User.java
|
|
112
|
-
/dev-backend --refactor
|
|
113
|
-
「このクラスに適用可能なリファクタリングパターンを分析」
|
|
114
|
-
|
|
115
|
-
# テストカバレッジを確認してテスト追加
|
|
116
|
-
cd apps/backend && ./gradlew jacocoTestReport
|
|
117
|
-
/dev-backend --test
|
|
118
|
-
「カバレッジが低い箇所のテストを追加」
|
|
119
|
-
|
|
120
|
-
# コミット前の品質確認
|
|
121
|
-
git status
|
|
122
|
-
/dev-backend --checklist
|
|
123
|
-
「全ての品質基準を満たすまで確認を実行」
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
### 注意事項
|
|
127
|
-
|
|
128
|
-
- **前提条件**: Java/Gradle のテスト環境が設定済みであること
|
|
129
|
-
- **制限事項**: TDD の三原則を厳密に守る(テストなしでプロダクションコードを書かない)
|
|
130
|
-
- **推奨事項**: コミット前に必ず品質チェックリストを実行
|
|
131
|
-
|
|
132
|
-
### ベストプラクティス
|
|
133
|
-
|
|
134
|
-
1. **TODO 駆動開発**: タスクを細かい TODO に分割してから実装開始
|
|
135
|
-
2. **小さなサイクル**: Red-Green-Refactor を 10-15 分で完了させる
|
|
136
|
-
3. **継続的コミット**: 各サイクル完了時に動作する状態でコミット
|
|
137
|
-
4. **Rule of Three**: 同じコードが 3 回現れたらリファクタリング
|
|
138
|
-
|
|
139
|
-
### 関連コマンド
|
|
140
|
-
|
|
141
|
-
- `/dev-frontend` : フロントエンド開発ガイド
|
|
142
|
-
- `/task` : タスク管理と TODO リストの作成
|
|
143
|
-
- `/review` : コードレビューの実施
|
|
144
|
-
- `/test` : テスト実行と結果確認
|
|
@@ -1,126 +0,0 @@
|
|
|
1
|
-
## Frontend Development Guide Reference
|
|
2
|
-
|
|
3
|
-
フロントエンド開発のためのコーディングとテストガイドを参照し、TDD サイクルに従った開発を支援します。
|
|
4
|
-
|
|
5
|
-
### 使い方
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
/dev-frontend [オプション]
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
### オプション
|
|
12
|
-
|
|
13
|
-
- なし : ガイド全体の要約と TDD サイクルの説明
|
|
14
|
-
- `--tdd` : TDD の Red-Green-Refactor サイクルの詳細
|
|
15
|
-
- `--approach` : インサイドアウト/アウトサイドインアプローチの選択指針
|
|
16
|
-
- `--checklist` : コミット前の品質チェックリスト表示
|
|
17
|
-
- `--refactor` : リファクタリングパターンの一覧
|
|
18
|
-
- `--test` : テスト作成のベストプラクティス
|
|
19
|
-
|
|
20
|
-
### 基本例
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
# TDD サイクルの開始
|
|
24
|
-
/dev-frontend --tdd
|
|
25
|
-
「現在のタスクに対して Red-Green-Refactor サイクルを開始」
|
|
26
|
-
|
|
27
|
-
# アプローチ戦略の確認
|
|
28
|
-
/dev-frontend --approach
|
|
29
|
-
「実装アプローチ(インサイドアウト/アウトサイドイン)の選択を支援」
|
|
30
|
-
|
|
31
|
-
# 品質チェックの実行
|
|
32
|
-
/dev-frontend --checklist
|
|
33
|
-
「コミット前の必須確認事項を順次実行」
|
|
34
|
-
|
|
35
|
-
# リファクタリング支援
|
|
36
|
-
/dev-frontend --refactor
|
|
37
|
-
「現在のコードに適用可能なリファクタリングパターンを提案」
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
### 詳細機能
|
|
41
|
-
|
|
42
|
-
#### TDD サイクルの実践
|
|
43
|
-
|
|
44
|
-
Red-Green-Refactor サイクルを厳密に実行:
|
|
45
|
-
|
|
46
|
-
1. **Red フェーズ**: 失敗するテストを最初に書く
|
|
47
|
-
2. **Green フェーズ**: テストを通す最小限のコードを実装
|
|
48
|
-
3. **Refactor フェーズ**: 重複を除去し設計を改善
|
|
49
|
-
4. @docs/reference/コーディングとテストガイド.md のワークフローに従う
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
# 新機能の TDD 実装開始
|
|
53
|
-
/dev-frontend --tdd
|
|
54
|
-
「LoginForm コンポーネントのテストから開始します」
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
#### 参照ドキュメント
|
|
58
|
-
|
|
59
|
-
- @docs/design/architecture_frontend.md を参照
|
|
60
|
-
- @docs/design/ui-design.md を参照
|
|
61
|
-
- @docs/design/tech_stack.md を参照
|
|
62
|
-
- @docs/design/test_strategy.md を参照
|
|
63
|
-
- 作業完了後に対象のイテレーション @docs/development/iteration_plan-N.md の進捗を更新する
|
|
64
|
-
|
|
65
|
-
#### アプローチ戦略の選択
|
|
66
|
-
|
|
67
|
-
プロジェクトの状態に応じた最適なアプローチを選択:
|
|
68
|
-
|
|
69
|
-
- **アウトサイドイン**: UI から開始しロジックを段階的に実装(推奨)
|
|
70
|
-
- **インサイドアウト**: ユーティリティ/hooks から開始し上位層へ展開
|
|
71
|
-
|
|
72
|
-
### テストコマンド
|
|
73
|
-
|
|
74
|
-
```bash
|
|
75
|
-
# 全テスト実行
|
|
76
|
-
cd apps/frontend && npm run test
|
|
77
|
-
|
|
78
|
-
# ウォッチモードでテスト実行
|
|
79
|
-
cd apps/frontend && npm run test:watch
|
|
80
|
-
|
|
81
|
-
# テストカバレッジ確認
|
|
82
|
-
cd apps/frontend && npm run test:coverage
|
|
83
|
-
|
|
84
|
-
# E2E テスト実行
|
|
85
|
-
cd apps/frontend && npm run test:e2e
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
### Claude との連携
|
|
89
|
-
|
|
90
|
-
```bash
|
|
91
|
-
# 現在のコードを分析してリファクタリング提案
|
|
92
|
-
cat apps/frontend/src/components/User.tsx
|
|
93
|
-
/dev-frontend --refactor
|
|
94
|
-
「このコンポーネントに適用可能なリファクタリングパターンを分析」
|
|
95
|
-
|
|
96
|
-
# テストカバレッジを確認してテスト追加
|
|
97
|
-
cd apps/frontend && npm run test:coverage
|
|
98
|
-
/dev-frontend --test
|
|
99
|
-
「カバレッジが低い箇所のテストを追加」
|
|
100
|
-
|
|
101
|
-
# コミット前の品質確認
|
|
102
|
-
git status
|
|
103
|
-
/dev-frontend --checklist
|
|
104
|
-
「全ての品質基準を満たすまで確認を実行」
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
### 注意事項
|
|
108
|
-
|
|
109
|
-
- **前提条件**: Node.js/npm のテスト環境が設定済みであること
|
|
110
|
-
- **制限事項**: TDD の三原則を厳密に守る(テストなしでプロダクションコードを書かない)
|
|
111
|
-
- **推奨事項**: コミット前に必ず品質チェックリストを実行
|
|
112
|
-
|
|
113
|
-
### ベストプラクティス
|
|
114
|
-
|
|
115
|
-
1. **TODO 駆動開発**: タスクを細かい TODO に分割してから実装開始
|
|
116
|
-
2. **小さなサイクル**: Red-Green-Refactor を 10-15 分で完了させる
|
|
117
|
-
3. **継続的コミット**: 各サイクル完了時に動作する状態でコミット
|
|
118
|
-
4. **Rule of Three**: 同じコードが 3 回現れたらリファクタリング
|
|
119
|
-
5. **コンポーネント分割**: 単一責任の原則に従いコンポーネントを小さく保つ
|
|
120
|
-
|
|
121
|
-
### 関連コマンド
|
|
122
|
-
|
|
123
|
-
- `/dev-backend` : バックエンド開発ガイド
|
|
124
|
-
- `/task` : タスク管理と TODO リストの作成
|
|
125
|
-
- `/review` : コードレビューの実施
|
|
126
|
-
- `/test` : テスト実行と結果確認
|
|
@@ -1,335 +0,0 @@
|
|
|
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
|
-
- `--lint` : Markdown フォーマットをチェックし、違反を自動修正
|
|
22
|
-
|
|
23
|
-
### 基本例
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
# ドキュメント一覧と進捗確認
|
|
27
|
-
/docs
|
|
28
|
-
「設計ドキュメントの一覧と作成状況を確認」
|
|
29
|
-
|
|
30
|
-
# 一覧のみ表示
|
|
31
|
-
/docs --list
|
|
32
|
-
「docs/design/ と docs/requirements/ のファイル一覧を表示」
|
|
33
|
-
|
|
34
|
-
# 詳細な進捗状況
|
|
35
|
-
/docs --status
|
|
36
|
-
「各ドキュメントの完成度や更新日時を含む詳細情報を表示」
|
|
37
|
-
|
|
38
|
-
# 特定ドキュメントの参照
|
|
39
|
-
/docs --read tech_stack
|
|
40
|
-
「技術スタック選定ドキュメントの内容を表示」
|
|
41
|
-
|
|
42
|
-
# 全ドキュメントの概要
|
|
43
|
-
/docs --summary
|
|
44
|
-
「全ドキュメントの目的と主要な内容を要約表示」
|
|
45
|
-
|
|
46
|
-
# docs/index.md と mkdocs.yml を更新
|
|
47
|
-
/docs --update
|
|
48
|
-
「現在のドキュメント構成に合わせて両ファイルを更新」
|
|
49
|
-
|
|
50
|
-
# docs/index.md のみ更新
|
|
51
|
-
/docs --update-index
|
|
52
|
-
「docs/index.md を現在のドキュメント構成に合わせて更新」
|
|
53
|
-
|
|
54
|
-
# mkdocs.yml のみ更新
|
|
55
|
-
/docs --update-mkdocs
|
|
56
|
-
「mkdocs.yml の nav セクションを現在のドキュメント構成に合わせて更新」
|
|
57
|
-
|
|
58
|
-
# Markdown フォーマットをチェック・修正
|
|
59
|
-
/docs --lint
|
|
60
|
-
「タスク項目の前に空行がないなどのフォーマット違反を検出し自動修正」
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
### 詳細機能
|
|
64
|
-
|
|
65
|
-
#### ドキュメント構成
|
|
66
|
-
|
|
67
|
-
本プロジェクトのドキュメントは以下の構成で管理されています:
|
|
68
|
-
|
|
69
|
-
**要件定義ドキュメント** (`docs/requirements/`)
|
|
70
|
-
- `requirements_definition.md` : 要件定義書(RDRA 2.0)
|
|
71
|
-
- `business_usecase.md` : ビジネスユースケース
|
|
72
|
-
- `system_usecase.md` : システムユースケース
|
|
73
|
-
- `user_story.md` : ユーザーストーリー
|
|
74
|
-
|
|
75
|
-
**設計ドキュメント** (`docs/design/`)
|
|
76
|
-
- `architecture_backend.md` : バックエンドアーキテクチャ
|
|
77
|
-
- `architecture_frontend.md` : フロントエンドアーキテクチャ
|
|
78
|
-
- `architecture_infrastructure.md` : インフラストラクチャ
|
|
79
|
-
- `data-model.md` : データモデル設計
|
|
80
|
-
- `domain-model.md` : ドメインモデル設計
|
|
81
|
-
- `ui-design.md` : UI 設計
|
|
82
|
-
- `test_strategy.md` : テスト戦略
|
|
83
|
-
- `non_functional.md` : 非機能要件
|
|
84
|
-
- `operation.md` : 運用要件
|
|
85
|
-
- `tech_stack.md` : 技術スタック選定
|
|
86
|
-
|
|
87
|
-
#### ドキュメント参照
|
|
88
|
-
|
|
89
|
-
以下のコマンドで特定のドキュメントを参照できます:
|
|
90
|
-
|
|
91
|
-
```bash
|
|
92
|
-
# 技術スタックを参照
|
|
93
|
-
/docs --read tech_stack
|
|
94
|
-
|
|
95
|
-
# アーキテクチャを参照
|
|
96
|
-
/docs --read architecture_backend
|
|
97
|
-
|
|
98
|
-
# 要件定義を参照
|
|
99
|
-
/docs --read requirements_definition
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
#### ドキュメント更新機能
|
|
103
|
-
|
|
104
|
-
`--update` オプションを使用すると、現在のドキュメント構成に合わせて `docs/index.md` と `mkdocs.yml` を自動更新できます。
|
|
105
|
-
|
|
106
|
-
**docs/index.md の更新内容**:
|
|
107
|
-
- ドキュメント一覧をカテゴリ別に整理
|
|
108
|
-
- 各ドキュメントへのリンクと説明を生成
|
|
109
|
-
- 「まずこれを読もうリスト」形式で構成
|
|
110
|
-
|
|
111
|
-
**mkdocs.yml の更新内容**:
|
|
112
|
-
- `nav` セクションを現在のドキュメント構成に合わせて更新
|
|
113
|
-
- 要件定義、設計、開発、運用などのカテゴリで階層化
|
|
114
|
-
- 新しいドキュメントを自動的にナビゲーションに追加
|
|
115
|
-
|
|
116
|
-
```bash
|
|
117
|
-
# 更新前に差分を確認
|
|
118
|
-
/docs --status
|
|
119
|
-
「現在のドキュメント構成を確認」
|
|
120
|
-
|
|
121
|
-
# 両ファイルを更新
|
|
122
|
-
/docs --update
|
|
123
|
-
「docs/index.md と mkdocs.yml を更新」
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
#### Lint 機能
|
|
127
|
-
|
|
128
|
-
`--lint` オプションを使用すると、Markdown ドキュメントのフォーマットをチェックし、違反を自動修正できます。
|
|
129
|
-
|
|
130
|
-
**チェックルール**:
|
|
131
|
-
|
|
132
|
-
- タスク項目(リスト)の前には空行が必要
|
|
133
|
-
- 番号付きリストのサブリスト前にも空行が必要
|
|
134
|
-
- コロンで終わる行の直後にリストがある場合も空行が必要
|
|
135
|
-
- 太字ラベル(半角・全角コロン両方)の直後にリストがある場合も空行が必要
|
|
136
|
-
|
|
137
|
-
**NG 例 1** - ラベルの直後にリスト:
|
|
138
|
-
|
|
139
|
-
```markdown
|
|
140
|
-
**受入条件**:
|
|
141
|
-
- [ ] ログアウトボタンをクリックするとログアウトできる
|
|
142
|
-
- [ ] ログアウト後、ログイン画面に遷移する
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
**OK 例 1**:
|
|
146
|
-
|
|
147
|
-
```markdown
|
|
148
|
-
**受入条件**:
|
|
149
|
-
|
|
150
|
-
- [ ] ログアウトボタンをクリックするとログアウトできる
|
|
151
|
-
- [ ] ログアウト後、ログイン画面に遷移する
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
**NG 例 2** - 番号付きリストの直後にサブリスト:
|
|
155
|
-
|
|
156
|
-
```markdown
|
|
157
|
-
1. **対処**: SMB バージョンを確認
|
|
158
|
-
- コントロールパネル > ファイルサービス > SMB で設定
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
**OK 例 2**:
|
|
162
|
-
|
|
163
|
-
```markdown
|
|
164
|
-
1. **対処**: SMB バージョンを確認
|
|
165
|
-
|
|
166
|
-
- コントロールパネル > ファイルサービス > SMB で設定
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
**NG 例 3** - コロンで終わる行の直後にリスト:
|
|
170
|
-
|
|
171
|
-
```markdown
|
|
172
|
-
PMD はカスタム設定で以下をチェック:
|
|
173
|
-
- マジックナンバーの使用
|
|
174
|
-
- 空の catch ブロック
|
|
175
|
-
- 循環複雑度が 7 を超えるメソッド
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
**OK 例 3**:
|
|
179
|
-
|
|
180
|
-
```markdown
|
|
181
|
-
PMD はカスタム設定で以下をチェック:
|
|
182
|
-
|
|
183
|
-
- マジックナンバーの使用
|
|
184
|
-
- 空の catch ブロック
|
|
185
|
-
- 循環複雑度が 7 を超えるメソッド
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
**NG 例 4** - 太字ラベル(全角コロン)の直後にリスト:
|
|
189
|
-
|
|
190
|
-
```markdown
|
|
191
|
-
**タイプの種類:**
|
|
192
|
-
- `feat`: 新機能の追加
|
|
193
|
-
- `fix`: バグ修正
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
**OK 例 4**:
|
|
197
|
-
|
|
198
|
-
```markdown
|
|
199
|
-
**タイプの種類:**
|
|
200
|
-
|
|
201
|
-
- `feat`: 新機能の追加
|
|
202
|
-
- `fix`: バグ修正
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
**実行手順**:
|
|
206
|
-
|
|
207
|
-
1. `docs/` 配下の全 Markdown ファイルをスキャン
|
|
208
|
-
2. 上記ルールに違反する箇所を検出
|
|
209
|
-
3. 違反箇所を自動修正
|
|
210
|
-
4. 修正結果を報告
|
|
211
|
-
|
|
212
|
-
```bash
|
|
213
|
-
# Lint を実行
|
|
214
|
-
/docs --lint
|
|
215
|
-
「docs/ 配下の Markdown ファイルをチェックし、フォーマット違反を修正」
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
### 出力例
|
|
219
|
-
|
|
220
|
-
```
|
|
221
|
-
設計ドキュメント一覧
|
|
222
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
223
|
-
|
|
224
|
-
📁 docs/requirements/
|
|
225
|
-
├─ ✅ requirements_definition.md (要件定義書)
|
|
226
|
-
├─ ✅ business_usecase.md (ビジネスユースケース)
|
|
227
|
-
├─ ✅ system_usecase.md (システムユースケース)
|
|
228
|
-
└─ ✅ user_story.md (ユーザーストーリー)
|
|
229
|
-
|
|
230
|
-
📁 docs/design/
|
|
231
|
-
├─ ✅ architecture_backend.md (バックエンドアーキテクチャ)
|
|
232
|
-
├─ ✅ architecture_frontend.md (フロントエンドアーキテクチャ)
|
|
233
|
-
├─ ✅ architecture_infrastructure.md (インフラストラクチャ)
|
|
234
|
-
├─ ✅ data-model.md (データモデル設計)
|
|
235
|
-
├─ ✅ domain-model.md (ドメインモデル設計)
|
|
236
|
-
├─ ✅ ui-design.md (UI 設計)
|
|
237
|
-
├─ ✅ test_strategy.md (テスト戦略)
|
|
238
|
-
├─ ✅ non_functional.md (非機能要件)
|
|
239
|
-
├─ ✅ operation.md (運用要件)
|
|
240
|
-
└─ ✅ tech_stack.md (技術スタック選定)
|
|
241
|
-
|
|
242
|
-
進捗: 14/14 ドキュメント完成 (100%)
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
#### --update 実行時の出力例
|
|
246
|
-
|
|
247
|
-
```
|
|
248
|
-
ドキュメント更新
|
|
249
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
250
|
-
|
|
251
|
-
📝 docs/index.md を更新しています...
|
|
252
|
-
✅ 要件定義セクションを追加
|
|
253
|
-
✅ 設計ドキュメントセクションを追加
|
|
254
|
-
✅ 開発ドキュメントセクションを追加
|
|
255
|
-
✅ 運用ドキュメントセクションを追加
|
|
256
|
-
|
|
257
|
-
📝 mkdocs.yml を更新しています...
|
|
258
|
-
✅ nav セクションを更新
|
|
259
|
-
✅ 14 件のドキュメントをナビゲーションに追加
|
|
260
|
-
|
|
261
|
-
更新完了!
|
|
262
|
-
```
|
|
263
|
-
|
|
264
|
-
#### --lint 実行時の出力例
|
|
265
|
-
|
|
266
|
-
```
|
|
267
|
-
Markdown Lint
|
|
268
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
269
|
-
|
|
270
|
-
🔍 docs/ 配下をスキャン中...
|
|
271
|
-
|
|
272
|
-
📄 docs/development/iteration_plan-1.md
|
|
273
|
-
⚠️ Line 52: リストの前に空行がありません
|
|
274
|
-
✅ 修正しました
|
|
275
|
-
|
|
276
|
-
📄 docs/requirements/user_story.md
|
|
277
|
-
⚠️ Line 128: リストの前に空行がありません
|
|
278
|
-
⚠️ Line 156: リストの前に空行がありません
|
|
279
|
-
✅ 2 箇所を修正しました
|
|
280
|
-
|
|
281
|
-
結果: 14 ファイルをスキャン、2 ファイルで 3 箇所を修正
|
|
282
|
-
```
|
|
283
|
-
|
|
284
|
-
### Claude との連携
|
|
285
|
-
|
|
286
|
-
```bash
|
|
287
|
-
# ドキュメント状況確認後に分析
|
|
288
|
-
/docs --status
|
|
289
|
-
「不足しているドキュメントがあれば作成を提案」
|
|
290
|
-
|
|
291
|
-
# 特定ドキュメントを参照して修正
|
|
292
|
-
/docs --read tech_stack
|
|
293
|
-
「技術スタックの内容を確認して改善点を提案」
|
|
294
|
-
|
|
295
|
-
# 全体概要を確認してレビュー
|
|
296
|
-
/docs --summary
|
|
297
|
-
「ドキュメント全体の整合性をレビュー」
|
|
298
|
-
|
|
299
|
-
# 新しいドキュメント作成後にインデックスを更新
|
|
300
|
-
/docs --update
|
|
301
|
-
「docs/index.md と mkdocs.yml を最新のドキュメント構成に同期」
|
|
302
|
-
|
|
303
|
-
# MkDocs でドキュメントサイトをプレビュー
|
|
304
|
-
/docs --update-mkdocs
|
|
305
|
-
「mkdocs.yml を更新後、mkdocs serve でプレビュー確認」
|
|
306
|
-
|
|
307
|
-
# ドキュメントのフォーマットをチェック・修正
|
|
308
|
-
/docs --lint
|
|
309
|
-
「Markdown フォーマットの一貫性を確保」
|
|
310
|
-
```
|
|
311
|
-
|
|
312
|
-
### 注意事項
|
|
313
|
-
|
|
314
|
-
- **前提条件**: `docs/` ディレクトリが存在すること
|
|
315
|
-
- **制限事項**: Markdown 形式のドキュメントのみ対応
|
|
316
|
-
- **推奨事項**: 定期的にドキュメントの進捗を確認し、最新の状態を維持すること
|
|
317
|
-
- **更新時の注意**: `--update` 実行前に現在の `docs/index.md` と `mkdocs.yml` をバックアップすることを推奨
|
|
318
|
-
- **MkDocs 依存**: `--update-mkdocs` を使用する場合、MkDocs がインストールされている必要がある
|
|
319
|
-
|
|
320
|
-
### ベストプラクティス
|
|
321
|
-
|
|
322
|
-
1. **定期確認**: 開発フェーズ移行前にドキュメントの完成度を確認する
|
|
323
|
-
2. **整合性維持**: コード変更時は関連ドキュメントも更新する
|
|
324
|
-
3. **レビュー活用**: チームレビュー前にドキュメント概要を共有する
|
|
325
|
-
4. **バージョン管理**: ドキュメントの変更は Git でコミットする
|
|
326
|
-
5. **インデックス同期**: 新しいドキュメント作成後は `--update` でインデックスを同期する
|
|
327
|
-
6. **プレビュー確認**: `--update-mkdocs` 後は `mkdocs serve` でナビゲーションを確認する
|
|
328
|
-
7. **フォーマット統一**: コミット前に `--lint` でフォーマットの一貫性を確保する
|
|
329
|
-
|
|
330
|
-
### 関連コマンド
|
|
331
|
-
|
|
332
|
-
- `/analysis` : 分析フェーズ全体の作業支援
|
|
333
|
-
- `/analysis-requirements` : 要件定義関連の作業支援
|
|
334
|
-
- `/analysis-architecture` : アーキテクチャ設計支援
|
|
335
|
-
- `/progress` : プロジェクト全体の進捗確認
|