@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
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: creating-adr
|
|
3
|
+
description: Architecture Decision Record の作成を支援。技術的意思決定の記録フォーマットとベストプラクティス。アーキテクチャ上の意思決定を記録する際に使用。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# ADR (Architecture Decision Record) 作成支援
|
|
7
|
+
|
|
8
|
+
アーキテクチャ決定記録(ADR)の作成・管理を支援します。
|
|
9
|
+
|
|
10
|
+
## Instructions
|
|
11
|
+
|
|
12
|
+
### 1. ADR ファイル構造
|
|
13
|
+
|
|
14
|
+
ADR は `docs/adr/` ディレクトリに以下の命名規則で保存:
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
docs/adr/
|
|
18
|
+
├── 001-backend-architecture-pattern.md
|
|
19
|
+
├── 002-backend-framework.md
|
|
20
|
+
├── 003-frontend-framework.md
|
|
21
|
+
└── 004-database.md
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### 2. ADR テンプレート
|
|
25
|
+
|
|
26
|
+
```markdown
|
|
27
|
+
# ADR-NNN: タイトル
|
|
28
|
+
|
|
29
|
+
簡潔な説明(1行で決定内容を要約)。
|
|
30
|
+
|
|
31
|
+
日付: YYYY-MM-DD
|
|
32
|
+
|
|
33
|
+
## ステータス
|
|
34
|
+
|
|
35
|
+
提案中 | 承認済み | 廃止 | 置換(ADR-XXX で置換)
|
|
36
|
+
|
|
37
|
+
## コンテキスト
|
|
38
|
+
|
|
39
|
+
この決定が必要になった背景・状況を説明。
|
|
40
|
+
|
|
41
|
+
- 現在の課題や制約
|
|
42
|
+
- 関連するシステムやサービス
|
|
43
|
+
- ビジネス要件
|
|
44
|
+
|
|
45
|
+
## 決定
|
|
46
|
+
|
|
47
|
+
**何を決定したか** を明確に記述。
|
|
48
|
+
|
|
49
|
+
### 変更箇所
|
|
50
|
+
|
|
51
|
+
具体的な実装変更がある場合は記載。
|
|
52
|
+
|
|
53
|
+
### 代替案
|
|
54
|
+
|
|
55
|
+
検討した代替案とその却下理由。
|
|
56
|
+
|
|
57
|
+
## 影響
|
|
58
|
+
|
|
59
|
+
### ポジティブ
|
|
60
|
+
|
|
61
|
+
- 良い影響
|
|
62
|
+
|
|
63
|
+
### ネガティブ
|
|
64
|
+
|
|
65
|
+
- 悪い影響や注意点
|
|
66
|
+
|
|
67
|
+
## コンプライアンス
|
|
68
|
+
|
|
69
|
+
決定が正しく実装されていることを確認する方法。
|
|
70
|
+
|
|
71
|
+
## 備考
|
|
72
|
+
|
|
73
|
+
- 著者: 担当者名
|
|
74
|
+
- 関連コミット: コミットハッシュ
|
|
75
|
+
- 関連 ADR: ADR-XXX
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### 3. ステータスの種類
|
|
79
|
+
|
|
80
|
+
| ステータス | 説明 |
|
|
81
|
+
|-----------|------|
|
|
82
|
+
| 提案中 | レビュー待ちの ADR |
|
|
83
|
+
| 承認済み | 採用された決定 |
|
|
84
|
+
| 廃止 | 無効になった決定 |
|
|
85
|
+
| 置換 | 別の ADR で置き換えられた |
|
|
86
|
+
|
|
87
|
+
### 4. 注意事項
|
|
88
|
+
|
|
89
|
+
- **採番規則**: ADR 番号は 001 から連番で管理。既存の最大番号 + 1 で採番
|
|
90
|
+
- **ファイル名**: `NNN-kebab-case-title.md` 形式(例: `006-cache-strategy.md`)
|
|
91
|
+
- **配置場所**: 必ず `docs/adr/` ディレクトリに配置
|
|
92
|
+
- **ドキュメント更新**: 新規 ADR 作成時は `docs/index.md` と `mkdocs.yml` も更新が必要
|
|
93
|
+
- **コミット禁止**: ユーザーの指示があるまでコミットしない
|
|
94
|
+
|
|
95
|
+
### 5. ベストプラクティス
|
|
96
|
+
|
|
97
|
+
1. **簡潔な要約**: タイトル直下に 1 行で決定内容を要約する
|
|
98
|
+
2. **コンテキストの明確化**: なぜこの決定が必要なのか背景を説明
|
|
99
|
+
3. **代替案の記録**: 検討した選択肢と却下理由を残す
|
|
100
|
+
4. **影響の両面記載**: ポジティブ・ネガティブ両方の影響を記載
|
|
101
|
+
5. **コンプライアンス項目**: 決定が守られていることを確認する方法を記載
|
|
102
|
+
|
|
103
|
+
## Examples
|
|
104
|
+
|
|
105
|
+
### 新しい ADR の作成
|
|
106
|
+
|
|
107
|
+
1. `docs/adr/` ディレクトリ内の既存 ADR の最大番号を確認
|
|
108
|
+
2. 次の連番でテンプレートに基づいて ADR を作成
|
|
109
|
+
3. `docs/index.md` と `mkdocs.yml` を更新
|
|
110
|
+
|
|
111
|
+
### 既存設計からの ADR 抽出
|
|
112
|
+
|
|
113
|
+
1. アーキテクチャ設計ドキュメントを読み込む
|
|
114
|
+
2. 主要な技術的意思決定を識別
|
|
115
|
+
3. 各決定を ADR として記録
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: developing-backend
|
|
3
|
+
description: バックエンド開発の TDD ワークフロー。Red-Green-Refactor サイクル、インサイドアウトアプローチ、品質チェックリスト。Java/Spring Boot のバックエンド実装時に使用。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# バックエンド開発ガイド
|
|
7
|
+
|
|
8
|
+
TDD サイクルに従ったバックエンド開発を支援します。
|
|
9
|
+
|
|
10
|
+
## Instructions
|
|
11
|
+
|
|
12
|
+
### 1. 参照ドキュメント
|
|
13
|
+
|
|
14
|
+
- @docs/reference/コーディングとテストガイド.md - ワークフロー
|
|
15
|
+
- @docs/design/architecture_backend.md - バックエンドアーキテクチャ
|
|
16
|
+
- @docs/design/data-model.md - データモデル
|
|
17
|
+
- @docs/design/domain-model.md - ドメインモデル
|
|
18
|
+
- @docs/design/tech_stack.md - 技術スタック
|
|
19
|
+
- @docs/design/test_strategy.md - テスト戦略
|
|
20
|
+
|
|
21
|
+
### 2. TDD サイクルの実践
|
|
22
|
+
|
|
23
|
+
Red-Green-Refactor サイクルを厳密に実行:
|
|
24
|
+
|
|
25
|
+
1. **Red フェーズ**: 失敗するテストを最初に書く
|
|
26
|
+
2. **Green フェーズ**: テストを通す最小限のコードを実装
|
|
27
|
+
3. **Refactor フェーズ**: 重複を除去し設計を改善
|
|
28
|
+
|
|
29
|
+
### 3. アプローチ戦略の選択
|
|
30
|
+
|
|
31
|
+
- **インサイドアウト**: データ層から開始し上位層へ展開(推奨)
|
|
32
|
+
- **アウトサイドイン**: API から開始しドメインロジックを段階的に実装
|
|
33
|
+
|
|
34
|
+
### 4. テストコマンド
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
# 全テスト実行
|
|
38
|
+
cd apps/backend && ./gradlew test
|
|
39
|
+
|
|
40
|
+
# 特定テストクラス実行
|
|
41
|
+
cd apps/backend && ./gradlew test --tests "UserServiceTest"
|
|
42
|
+
|
|
43
|
+
# テストカバレッジ確認
|
|
44
|
+
cd apps/backend && ./gradlew jacocoTestReport
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### 5. API ドキュメント
|
|
48
|
+
|
|
49
|
+
バックエンドには Swagger UI が組み込まれています。
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# バックエンドを起動
|
|
53
|
+
cd apps/backend && ./gradlew bootRun
|
|
54
|
+
|
|
55
|
+
# Swagger UI: http://localhost:8080/swagger-ui.html
|
|
56
|
+
# OpenAPI JSON: http://localhost:8080/v3/api-docs
|
|
57
|
+
# OpenAPI YAML: http://localhost:8080/api-docs.yaml
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### 6. 品質チェックリスト
|
|
61
|
+
|
|
62
|
+
- [ ] すべてのテストがパス
|
|
63
|
+
- [ ] ESLint/コンパイラの警告がゼロ
|
|
64
|
+
- [ ] テストカバレッジが目標を満たしている
|
|
65
|
+
- [ ] 単一の論理的作業単位を表現
|
|
66
|
+
- [ ] コミットメッセージが変更内容を明確に説明
|
|
67
|
+
|
|
68
|
+
### 7. 注意事項
|
|
69
|
+
|
|
70
|
+
- **前提条件**: Java/Gradle のテスト環境が設定済みであること
|
|
71
|
+
- **制限事項**: TDD の三原則を厳密に守る(テストなしでプロダクションコードを書かない)
|
|
72
|
+
- **推奨事項**: コミット前に必ず品質チェックリストを実行
|
|
73
|
+
- 作業完了後に対象のイテレーション @docs/development/iteration_plan-N.md の進捗を更新する
|
|
74
|
+
|
|
75
|
+
## Examples
|
|
76
|
+
|
|
77
|
+
### 新機能の TDD 実装
|
|
78
|
+
|
|
79
|
+
1. 失敗するテストを書く(Red)
|
|
80
|
+
2. テストを通す最小限のコードを実装(Green)
|
|
81
|
+
3. 重複を排除し設計を改善(Refactor)
|
|
82
|
+
4. 品質チェックリストを実行してコミット
|
|
83
|
+
|
|
84
|
+
### ベストプラクティス
|
|
85
|
+
|
|
86
|
+
1. **TODO 駆動開発**: タスクを細かい TODO に分割してから実装開始
|
|
87
|
+
2. **小さなサイクル**: Red-Green-Refactor を 10-15 分で完了させる
|
|
88
|
+
3. **継続的コミット**: 各サイクル完了時に動作する状態でコミット
|
|
89
|
+
4. **Rule of Three**: 同じコードが 3 回現れたらリファクタリング
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: developing-frontend
|
|
3
|
+
description: フロントエンド開発の TDD ワークフロー。Red-Green-Refactor サイクル、アウトサイドインアプローチ、コンポーネント設計。React/TypeScript のフロントエンド実装時に使用。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# フロントエンド開発ガイド
|
|
7
|
+
|
|
8
|
+
TDD サイクルに従ったフロントエンド開発を支援します。
|
|
9
|
+
|
|
10
|
+
## Instructions
|
|
11
|
+
|
|
12
|
+
### 1. 参照ドキュメント
|
|
13
|
+
|
|
14
|
+
- @docs/reference/コーディングとテストガイド.md - ワークフロー
|
|
15
|
+
- @docs/design/architecture_frontend.md - フロントエンドアーキテクチャ
|
|
16
|
+
- @docs/design/ui-design.md - UI 設計
|
|
17
|
+
- @docs/design/tech_stack.md - 技術スタック
|
|
18
|
+
- @docs/design/test_strategy.md - テスト戦略
|
|
19
|
+
|
|
20
|
+
### 2. TDD サイクルの実践
|
|
21
|
+
|
|
22
|
+
Red-Green-Refactor サイクルを厳密に実行:
|
|
23
|
+
|
|
24
|
+
1. **Red フェーズ**: 失敗するテストを最初に書く
|
|
25
|
+
2. **Green フェーズ**: テストを通す最小限のコードを実装
|
|
26
|
+
3. **Refactor フェーズ**: 重複を除去し設計を改善
|
|
27
|
+
|
|
28
|
+
### 3. アプローチ戦略の選択
|
|
29
|
+
|
|
30
|
+
- **アウトサイドイン**: UI から開始しロジックを段階的に実装(推奨)
|
|
31
|
+
- **インサイドアウト**: ユーティリティ/hooks から開始し上位層へ展開
|
|
32
|
+
|
|
33
|
+
### 4. テストコマンド
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
# 全テスト実行
|
|
37
|
+
cd apps/frontend && npm run test
|
|
38
|
+
|
|
39
|
+
# ウォッチモードでテスト実行
|
|
40
|
+
cd apps/frontend && npm run test:watch
|
|
41
|
+
|
|
42
|
+
# テストカバレッジ確認
|
|
43
|
+
cd apps/frontend && npm run test:coverage
|
|
44
|
+
|
|
45
|
+
# E2E テスト実行
|
|
46
|
+
cd apps/frontend && npm run test:e2e
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### 5. 品質チェックリスト
|
|
50
|
+
|
|
51
|
+
- [ ] すべてのテストがパス
|
|
52
|
+
- [ ] ESLint の警告がゼロ
|
|
53
|
+
- [ ] テストカバレッジが目標を満たしている
|
|
54
|
+
- [ ] 単一の論理的作業単位を表現
|
|
55
|
+
- [ ] コミットメッセージが変更内容を明確に説明
|
|
56
|
+
|
|
57
|
+
### 6. 注意事項
|
|
58
|
+
|
|
59
|
+
- **前提条件**: Node.js/npm のテスト環境が設定済みであること
|
|
60
|
+
- **制限事項**: TDD の三原則を厳密に守る(テストなしでプロダクションコードを書かない)
|
|
61
|
+
- **推奨事項**: コミット前に必ず品質チェックリストを実行
|
|
62
|
+
- 作業完了後に対象のイテレーション @docs/development/iteration_plan-N.md の進捗を更新する
|
|
63
|
+
|
|
64
|
+
## Examples
|
|
65
|
+
|
|
66
|
+
### 新コンポーネントの TDD 実装
|
|
67
|
+
|
|
68
|
+
1. 失敗するテストを書く(Red)
|
|
69
|
+
2. テストを通す最小限のコードを実装(Green)
|
|
70
|
+
3. 重複を排除し設計を改善(Refactor)
|
|
71
|
+
4. 品質チェックリストを実行してコミット
|
|
72
|
+
|
|
73
|
+
### ベストプラクティス
|
|
74
|
+
|
|
75
|
+
1. **TODO 駆動開発**: タスクを細かい TODO に分割してから実装開始
|
|
76
|
+
2. **小さなサイクル**: Red-Green-Refactor を 10-15 分で完了させる
|
|
77
|
+
3. **継続的コミット**: 各サイクル完了時に動作する状態でコミット
|
|
78
|
+
4. **Rule of Three**: 同じコードが 3 回現れたらリファクタリング
|
|
79
|
+
5. **コンポーネント分割**: 単一責任の原則に従いコンポーネントを小さく保つ
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: killing-processes
|
|
3
|
+
description: 開発サーバーや Node.js プロセスを強制終了。ポート競合の解決やプロセスリセット時に使用。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Kill Development Processes
|
|
7
|
+
|
|
8
|
+
開発サーバーや Node.js プロセスを強制終了するスキル。複数ポートで起動している開発プロセスを一括で停止できます。
|
|
9
|
+
|
|
10
|
+
## Instructions
|
|
11
|
+
|
|
12
|
+
### 1. オプション
|
|
13
|
+
|
|
14
|
+
- なし : すべての Node.js 開発プロセスを強制終了
|
|
15
|
+
- `--port <ポート番号>` : 特定のポートのプロセスのみ終了
|
|
16
|
+
- `--check` : プロセス状況の確認のみ(終了せず)
|
|
17
|
+
|
|
18
|
+
### 2. 基本例
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
# 全開発プロセスを強制終了
|
|
22
|
+
# 「すべての Node.js 開発サーバー(npm run dev 等)を停止」
|
|
23
|
+
|
|
24
|
+
# ポート 3000 番のプロセスのみ終了
|
|
25
|
+
# --port 3000
|
|
26
|
+
# 「ポート 3000 で動作中のプロセスを終了」
|
|
27
|
+
|
|
28
|
+
# プロセス状況の確認
|
|
29
|
+
# --check
|
|
30
|
+
# 「現在起動中の開発プロセスを一覧表示」
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### 3. 詳細機能
|
|
34
|
+
|
|
35
|
+
#### 一括プロセス終了
|
|
36
|
+
|
|
37
|
+
Windows 環境で複数の開発サーバーが起動している場合の一括終了処理。
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# ポート範囲でのプロセス検索・終了
|
|
41
|
+
netstat -ano | findstr ":300[0-9]" | findstr LISTENING
|
|
42
|
+
taskkill //F //PID <PID1> && taskkill //F //PID <PID2>
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
#### 個別ポート指定終了
|
|
46
|
+
|
|
47
|
+
特定のポートで起動しているプロセスのみを終了する。
|
|
48
|
+
|
|
49
|
+
- **安全性**: 指定ポートのみ終了で他に影響しない
|
|
50
|
+
- **精密性**: 必要最小限のプロセス停止
|
|
51
|
+
- **確認**: 終了前にプロセス情報を表示
|
|
52
|
+
|
|
53
|
+
### 4. 出力例
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
現在起動中の開発プロセス:
|
|
57
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
58
|
+
|
|
59
|
+
ポート 3000: PID 34348 (Node.js)
|
|
60
|
+
ポート 3001: PID 16676 (Node.js)
|
|
61
|
+
ポート 3002: PID 25696 (Node.js)
|
|
62
|
+
|
|
63
|
+
プロセス終了中...
|
|
64
|
+
PID 34348 を終了しました
|
|
65
|
+
PID 16676 を終了しました
|
|
66
|
+
PID 25696 を終了しました
|
|
67
|
+
|
|
68
|
+
すべての開発プロセスを停止しました。
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 5. 連携シナリオ
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
# 開発中のエラー修正後にプロセスリセット
|
|
75
|
+
npm run dev
|
|
76
|
+
# 「エラーが発生」→ kill → 「全プロセス停止して再起動準備」
|
|
77
|
+
|
|
78
|
+
# ポート競合の解決
|
|
79
|
+
npm start
|
|
80
|
+
# 「Port 3000 is already in use」→ kill --port 3000
|
|
81
|
+
|
|
82
|
+
# 開発環境のクリーンアップ
|
|
83
|
+
git checkout main
|
|
84
|
+
# → kill → 「ブランチ切り替え前に開発プロセスをクリーンアップ」
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### 6. 注意事項
|
|
88
|
+
|
|
89
|
+
- **前提条件**: Windows 環境(taskkill コマンド使用)
|
|
90
|
+
- **制限事項**: 管理者権限が必要な場合があります
|
|
91
|
+
- **推奨事項**: 重要な作業中は事前にファイル保存を行う
|
|
92
|
+
|
|
93
|
+
### 7. ベストプラクティス
|
|
94
|
+
|
|
95
|
+
1. **安全な終了**: 作業中のファイルは事前に保存する
|
|
96
|
+
2. **段階的終了**: まず `--check` で状況確認してから終了
|
|
97
|
+
3. **ポート指定**: 必要に応じて特定ポートのみ終了
|
|
98
|
+
4. **再起動準備**: プロセス終了後は適切にサーバーを再起動
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: managing-docs
|
|
3
|
+
description: 設計ドキュメントの一覧表示、進捗確認、内容参照、インデックス更新、Markdown Lint を実行。ドキュメント管理や整備時に使用。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# ドキュメント管理ガイド
|
|
7
|
+
|
|
8
|
+
設計ドキュメントの一覧表示、進捗確認、内容参照を行います。
|
|
9
|
+
|
|
10
|
+
## Instructions
|
|
11
|
+
|
|
12
|
+
### 1. オプション
|
|
13
|
+
|
|
14
|
+
- なし : ドキュメント一覧と進捗状況を表示
|
|
15
|
+
- `--list` : ドキュメント一覧のみを表示
|
|
16
|
+
- `--status` : ドキュメントの作成状況を詳細表示
|
|
17
|
+
- `--read <ファイル名>` : 指定したドキュメントの内容を表示
|
|
18
|
+
- `--summary` : 全ドキュメントの概要を表示
|
|
19
|
+
- `--update` : `docs/index.md` と `mkdocs.yml` を現在のドキュメント構成に合わせて更新
|
|
20
|
+
- `--update-index` : `docs/index.md` のみを更新
|
|
21
|
+
- `--update-mkdocs` : `mkdocs.yml` のみを更新
|
|
22
|
+
- `--lint` : Markdown フォーマットをチェックし、違反を自動修正
|
|
23
|
+
|
|
24
|
+
### 2. 基本例
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# ドキュメント一覧と進捗確認
|
|
28
|
+
# 「設計ドキュメントの一覧と作成状況を確認」
|
|
29
|
+
|
|
30
|
+
# 特定ドキュメントの参照
|
|
31
|
+
# --read tech_stack
|
|
32
|
+
# 「技術スタック選定ドキュメントの内容を表示」
|
|
33
|
+
|
|
34
|
+
# docs/index.md と mkdocs.yml を更新
|
|
35
|
+
# --update
|
|
36
|
+
# 「現在のドキュメント構成に合わせて両ファイルを更新」
|
|
37
|
+
|
|
38
|
+
# Markdown フォーマットをチェック・修正
|
|
39
|
+
# --lint
|
|
40
|
+
# 「タスク項目の前に空行がないなどのフォーマット違反を検出し自動修正」
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### 3. ドキュメント構成
|
|
44
|
+
|
|
45
|
+
本プロジェクトのドキュメントは以下の構成で管理されています:
|
|
46
|
+
|
|
47
|
+
**要件定義ドキュメント** (`docs/requirements/`)
|
|
48
|
+
|
|
49
|
+
- `requirements_definition.md` : 要件定義書(RDRA 2.0)
|
|
50
|
+
- `business_usecase.md` : ビジネスユースケース
|
|
51
|
+
- `system_usecase.md` : システムユースケース
|
|
52
|
+
- `user_story.md` : ユーザーストーリー
|
|
53
|
+
|
|
54
|
+
**設計ドキュメント** (`docs/design/`)
|
|
55
|
+
|
|
56
|
+
- `architecture_backend.md` : バックエンドアーキテクチャ
|
|
57
|
+
- `architecture_frontend.md` : フロントエンドアーキテクチャ
|
|
58
|
+
- `architecture_infrastructure.md` : インフラストラクチャ
|
|
59
|
+
- `data-model.md` : データモデル設計
|
|
60
|
+
- `domain-model.md` : ドメインモデル設計
|
|
61
|
+
- `ui-design.md` : UI 設計
|
|
62
|
+
- `test_strategy.md` : テスト戦略
|
|
63
|
+
- `non_functional.md` : 非機能要件
|
|
64
|
+
- `operation.md` : 運用要件
|
|
65
|
+
- `tech_stack.md` : 技術スタック選定
|
|
66
|
+
|
|
67
|
+
### 4. ドキュメント更新機能
|
|
68
|
+
|
|
69
|
+
`--update` オプションを使用すると、現在のドキュメント構成に合わせて `docs/index.md` と `mkdocs.yml` を自動更新できます。
|
|
70
|
+
|
|
71
|
+
**docs/index.md の更新内容**:
|
|
72
|
+
|
|
73
|
+
- ドキュメント一覧をカテゴリ別に整理
|
|
74
|
+
- 各ドキュメントへのリンクと説明を生成
|
|
75
|
+
- 「まずこれを読もうリスト」形式で構成
|
|
76
|
+
|
|
77
|
+
**mkdocs.yml の更新内容**:
|
|
78
|
+
|
|
79
|
+
- `nav` セクションを現在のドキュメント構成に合わせて更新
|
|
80
|
+
- 要件定義、設計、開発、運用などのカテゴリで階層化
|
|
81
|
+
- 新しいドキュメントを自動的にナビゲーションに追加
|
|
82
|
+
|
|
83
|
+
### 5. Lint 機能
|
|
84
|
+
|
|
85
|
+
`--lint` オプションを使用すると、Markdown ドキュメントのフォーマットをチェックし、違反を自動修正できます。
|
|
86
|
+
|
|
87
|
+
**チェックルール**:
|
|
88
|
+
|
|
89
|
+
- タスク項目(リスト)の前には空行が必要
|
|
90
|
+
- 番号付きリストのサブリスト前にも空行が必要
|
|
91
|
+
- コロンで終わる行の直後にリストがある場合も空行が必要
|
|
92
|
+
- 太字ラベル(半角・全角コロン両方)の直後にリストがある場合も空行が必要
|
|
93
|
+
|
|
94
|
+
**NG 例** - ラベルの直後にリスト:
|
|
95
|
+
|
|
96
|
+
```markdown
|
|
97
|
+
**受入条件**:
|
|
98
|
+
- [ ] ログアウトボタンをクリックするとログアウトできる
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
**OK 例**:
|
|
102
|
+
|
|
103
|
+
```markdown
|
|
104
|
+
**受入条件**:
|
|
105
|
+
|
|
106
|
+
- [ ] ログアウトボタンをクリックするとログアウトできる
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
**NG 例** - 番号付きリストの直後にサブリスト:
|
|
110
|
+
|
|
111
|
+
```markdown
|
|
112
|
+
1. **対処**: SMB バージョンを確認
|
|
113
|
+
- コントロールパネル > ファイルサービス > SMB で設定
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
**OK 例**:
|
|
117
|
+
|
|
118
|
+
```markdown
|
|
119
|
+
1. **対処**: SMB バージョンを確認
|
|
120
|
+
|
|
121
|
+
- コントロールパネル > ファイルサービス > SMB で設定
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
**NG 例** - コロンで終わる行の直後にリスト:
|
|
125
|
+
|
|
126
|
+
```markdown
|
|
127
|
+
PMD はカスタム設定で以下をチェック:
|
|
128
|
+
- マジックナンバーの使用
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
**OK 例**:
|
|
132
|
+
|
|
133
|
+
```markdown
|
|
134
|
+
PMD はカスタム設定で以下をチェック:
|
|
135
|
+
|
|
136
|
+
- マジックナンバーの使用
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
**実行手順**:
|
|
140
|
+
|
|
141
|
+
1. `docs/` 配下の全 Markdown ファイルをスキャン
|
|
142
|
+
2. 上記ルールに違反する箇所を検出
|
|
143
|
+
3. 違反箇所を自動修正
|
|
144
|
+
4. 修正結果を報告
|
|
145
|
+
|
|
146
|
+
### 6. 出力例
|
|
147
|
+
|
|
148
|
+
```
|
|
149
|
+
設計ドキュメント一覧
|
|
150
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
151
|
+
|
|
152
|
+
docs/requirements/
|
|
153
|
+
├─ requirements_definition.md (要件定義書)
|
|
154
|
+
├─ business_usecase.md (ビジネスユースケース)
|
|
155
|
+
├─ system_usecase.md (システムユースケース)
|
|
156
|
+
└─ user_story.md (ユーザーストーリー)
|
|
157
|
+
|
|
158
|
+
docs/design/
|
|
159
|
+
├─ architecture_backend.md (バックエンドアーキテクチャ)
|
|
160
|
+
├─ architecture_frontend.md (フロントエンドアーキテクチャ)
|
|
161
|
+
├─ data-model.md (データモデル設計)
|
|
162
|
+
├─ domain-model.md (ドメインモデル設計)
|
|
163
|
+
├─ ui-design.md (UI 設計)
|
|
164
|
+
├─ test_strategy.md (テスト戦略)
|
|
165
|
+
├─ non_functional.md (非機能要件)
|
|
166
|
+
├─ operation.md (運用要件)
|
|
167
|
+
└─ tech_stack.md (技術スタック選定)
|
|
168
|
+
|
|
169
|
+
進捗: 14/14 ドキュメント完成 (100%)
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### 7. 注意事項
|
|
173
|
+
|
|
174
|
+
- **前提条件**: `docs/` ディレクトリが存在すること
|
|
175
|
+
- **制限事項**: Markdown 形式のドキュメントのみ対応
|
|
176
|
+
- **推奨事項**: 定期的にドキュメントの進捗を確認し、最新の状態を維持すること
|
|
177
|
+
- **更新時の注意**: `--update` 実行前に現在の `docs/index.md` と `mkdocs.yml` をバックアップすることを推奨
|
|
178
|
+
- **MkDocs 依存**: `--update-mkdocs` を使用する場合、MkDocs がインストールされている必要がある
|
|
179
|
+
|
|
180
|
+
### 8. ベストプラクティス
|
|
181
|
+
|
|
182
|
+
1. **定期確認**: 開発フェーズ移行前にドキュメントの完成度を確認する
|
|
183
|
+
2. **整合性維持**: コード変更時は関連ドキュメントも更新する
|
|
184
|
+
3. **レビュー活用**: チームレビュー前にドキュメント概要を共有する
|
|
185
|
+
4. **バージョン管理**: ドキュメントの変更は Git でコミットする
|
|
186
|
+
5. **インデックス同期**: 新しいドキュメント作成後は `--update` でインデックスを同期する
|
|
187
|
+
6. **プレビュー確認**: `--update-mkdocs` 後は `mkdocs serve` でナビゲーションを確認する
|
|
188
|
+
7. **フォーマット統一**: コミット前に `--lint` でフォーマットの一貫性を確保する
|
|
189
|
+
|
|
190
|
+
### 関連スキル
|
|
191
|
+
|
|
192
|
+
- `orchestrating-analysis` : 分析フェーズ全体の作業支援
|
|
193
|
+
- `analyzing-requirements` : 要件定義関連の作業支援
|
|
194
|
+
- `analyzing-architecture` : アーキテクチャ設計支援
|
|
195
|
+
- `tracking-progress` : プロジェクト全体の進捗確認
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# デプロイメント管理・運用監視・バックアップ
|
|
2
|
+
|
|
3
|
+
## デプロイメント管理
|
|
4
|
+
|
|
5
|
+
ゼロダウンタイムデプロイとブルーグリーンデプロイメント。
|
|
6
|
+
|
|
7
|
+
### 環境別デプロイ戦略
|
|
8
|
+
|
|
9
|
+
- **Development**: 即座デプロイ・自動テスト実行
|
|
10
|
+
- **Staging**: 統合テスト・パフォーマンステスト
|
|
11
|
+
- **Production**: ブルーグリーンデプロイ・段階的ロールアウト
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# ステージング環境への自動デプロイ
|
|
15
|
+
# --deploy staging
|
|
16
|
+
|
|
17
|
+
# 本番環境への慎重なデプロイ
|
|
18
|
+
# --deploy production --strategy blue-green
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## 運用監視とログ管理
|
|
22
|
+
|
|
23
|
+
リアルタイム監視とプロアクティブなアラート。
|
|
24
|
+
|
|
25
|
+
### 監視項目
|
|
26
|
+
|
|
27
|
+
- **パフォーマンス**: CPU・メモリ・ディスク・ネットワーク使用率
|
|
28
|
+
- **アプリケーション**: レスポンス時間・エラー率・スループット
|
|
29
|
+
- **インフラ**: サーバー・データベース・外部 API の稼働状況
|
|
30
|
+
- **ビジネス**: ユーザーアクティビティ・売上・KPI 指標
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# 特定サービスのリアルタイムログ
|
|
34
|
+
# --logs backend --follow
|
|
35
|
+
|
|
36
|
+
# システム全体の統合ダッシュボード
|
|
37
|
+
# --health --dashboard
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## バックアップと災害復旧
|
|
41
|
+
|
|
42
|
+
自動バックアップと迅速な災害復旧。
|
|
43
|
+
|
|
44
|
+
### バックアップ対象
|
|
45
|
+
|
|
46
|
+
- **データベース**: 完全バックアップ・増分バックアップ
|
|
47
|
+
- **アプリケーション**: 設定ファイル・静的リソース・ログ
|
|
48
|
+
- **インフラ**: 環境設定・SSL 証明書・監視設定
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
# 自動バックアップの実行
|
|
52
|
+
# --backup --schedule daily
|
|
53
|
+
|
|
54
|
+
# 緊急時の完全復元
|
|
55
|
+
# --restore backup-2024-09-12-003000
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## 連携シナリオ
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
# システム状況と組み合わせた総合分析
|
|
62
|
+
ps aux | grep -E "(java|node|postgres)"
|
|
63
|
+
netstat -tlnp | grep -E ":3000|:5432|:8080"
|
|
64
|
+
# → --health
|
|
65
|
+
# 「実行中プロセスとポート使用状況を含めた運用状況の総合分析」
|
|
66
|
+
|
|
67
|
+
# Git 状況と組み合わせたデプロイ準備
|
|
68
|
+
git log --oneline -5
|
|
69
|
+
git status
|
|
70
|
+
# → --deploy staging
|
|
71
|
+
# 「最新コミットを含めたステージング環境へのデプロイ実行」
|
|
72
|
+
|
|
73
|
+
# ログ分析と組み合わせた障害対応
|
|
74
|
+
tail -100 /var/log/apps.log
|
|
75
|
+
# → --rollback production
|
|
76
|
+
# 「エラーログ分析に基づく緊急ロールバック実行」
|
|
77
|
+
```
|