@k2works/claude-code-booster 0.21.4 → 0.23.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.
@@ -0,0 +1,177 @@
1
+ ## ADR (Architecture Decision Record)
2
+
3
+ アーキテクチャ決定記録(ADR)の作成・管理を行うコマンド。
4
+
5
+ ### 使い方
6
+
7
+ ```bash
8
+ /adr [オプション] [引数]
9
+ ```
10
+
11
+ ### オプション
12
+
13
+ - なし : ADR 一覧を表示
14
+ - `--create <タイトル>` : 新しい ADR を作成
15
+ - `--update <番号>` : 既存の ADR を更新
16
+ - `--status <番号> <ステータス>` : ADR のステータスを更新
17
+ - `<番号>` : 指定した ADR の内容を表示
18
+
19
+ ### 基本例
20
+
21
+ ```bash
22
+ # ADR 一覧を表示
23
+ /adr
24
+ 「現在のADR一覧を表示してください」
25
+
26
+ # 新しい ADR を作成
27
+ /adr --create バックエンドキャッシュ戦略の選択
28
+ 「Redis をキャッシュとして採用する ADR を作成してください」
29
+
30
+ # 特定の ADR を表示
31
+ /adr 005
32
+ 「ADR-005 の内容を表示してください」
33
+
34
+ # ADR のステータスを更新
35
+ /adr --status 003 deprecated
36
+ 「ADR-003 を deprecated に変更してください」
37
+ ```
38
+
39
+ ### 詳細機能
40
+
41
+ #### ADR ファイル構造
42
+
43
+ ADR は `docs/adr/` ディレクトリに以下の命名規則で保存される:
44
+
45
+ ```
46
+ docs/adr/
47
+ ├── 001-backend-architecture-pattern.md
48
+ ├── 002-backend-framework.md
49
+ ├── 003-frontend-framework.md
50
+ └── 004-database.md
51
+ ```
52
+
53
+ #### ADR テンプレート
54
+
55
+ 新しい ADR は以下のテンプレートで作成する:
56
+
57
+ ```markdown
58
+ # ADR-NNN: タイトル
59
+
60
+ 簡潔な説明(1行で決定内容を要約)。
61
+
62
+ 日付: YYYY-MM-DD
63
+
64
+ ## ステータス
65
+
66
+ 提案中 | 承認済み | 廃止 | 置換(ADR-XXX で置換)
67
+
68
+ ## コンテキスト
69
+
70
+ この決定が必要になった背景・状況を説明。
71
+
72
+ - 現在の課題や制約
73
+ - 関連するシステムやサービス
74
+ - ビジネス要件
75
+
76
+ ## 決定
77
+
78
+ **何を決定したか** を明確に記述。
79
+
80
+ ### 変更箇所
81
+
82
+ 具体的な実装変更がある場合は記載:
83
+
84
+ 1. **ファイル1**
85
+ ```
86
+ 変更内容
87
+ ```
88
+
89
+ 2. **ファイル2**
90
+ ```
91
+ 変更内容
92
+ ```
93
+
94
+ ### 代替案
95
+
96
+ 検討した代替案とその却下理由:
97
+
98
+ 1. **代替案1**
99
+ - 却下理由: ...
100
+
101
+ 2. **代替案2**
102
+ - 却下理由: ...
103
+
104
+ ## 影響
105
+
106
+ ### ポジティブ
107
+
108
+ - 良い影響1
109
+ - 良い影響2
110
+
111
+ ### ネガティブ
112
+
113
+ - 悪い影響や注意点1
114
+ - 悪い影響や注意点2
115
+
116
+ ## コンプライアンス
117
+
118
+ 決定が正しく実装されていることを確認する方法:
119
+
120
+ - チェック項目1
121
+ - チェック項目2
122
+
123
+ ## 備考
124
+
125
+ - 著者: 担当者名
126
+ - 関連コミット: コミットハッシュ
127
+ - 関連 ADR: ADR-XXX
128
+ ```
129
+
130
+ #### ステータスの種類
131
+
132
+ | ステータス | 説明 |
133
+ |-----------|------|
134
+ | 提案中 | レビュー待ちの ADR |
135
+ | 承認済み | 採用された決定 |
136
+ | 廃止 | 無効になった決定 |
137
+ | 置換 | 別の ADR で置き換えられた |
138
+
139
+ ### Claude との連携
140
+
141
+ ```bash
142
+ # 既存の設計からADRを抽出
143
+ cat docs/design/architecture.md
144
+ /adr --create
145
+ 「アーキテクチャ設計から主要な決定をADRとして抽出してください」
146
+
147
+ # 問題の背景を説明してADR作成
148
+ 「NAS環境でWikiサービスがポート3000を使用しているため、
149
+ バックエンドのポートを3001に変更したい」
150
+ /adr --create バックエンドAPIポート変更
151
+
152
+ # ADR作成後の関連ドキュメント更新
153
+ /adr --create 新機能の技術選定
154
+ 「ADR作成後、docs/index.md と mkdocs.yml も更新してください」
155
+ ```
156
+
157
+ ### 注意事項
158
+
159
+ - **採番規則**: ADR 番号は 001 から連番で管理。既存の最大番号 + 1 で採番
160
+ - **ファイル名**: `NNN-kebab-case-title.md` 形式(例: `006-cache-strategy.md`)
161
+ - **配置場所**: 必ず `docs/adr/` ディレクトリに配置
162
+ - **ドキュメント更新**: 新規 ADR 作成時は `docs/index.md` と `mkdocs.yml` も更新が必要
163
+ - **コミット禁止**: ユーザーの指示があるまでコミットしない
164
+
165
+ ### ベストプラクティス
166
+
167
+ 1. **簡潔な要約**: タイトル直下に 1 行で決定内容を要約する
168
+ 2. **コンテキストの明確化**: なぜこの決定が必要なのか背景を説明
169
+ 3. **代替案の記録**: 検討した選択肢と却下理由を残す
170
+ 4. **影響の両面記載**: ポジティブ・ネガティブ両方の影響を記載
171
+ 5. **コンプライアンス項目**: 決定が守られていることを確認する方法を記載
172
+
173
+ ### 関連コマンド
174
+
175
+ - `/docs` : ドキュメントの更新・管理
176
+ - `/analysis-architecture` : アーキテクチャ分析
177
+ - `/git-commit` : 変更のコミット