@k2works/claude-code-booster 0.9.1 → 0.10.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.
Files changed (26) hide show
  1. package/lib/assets/.claude/README.md +57 -10
  2. package/lib/assets/.claude/commands/analysis-architecture.md +98 -0
  3. package/lib/assets/.claude/commands/analysis-data-model.md +94 -0
  4. package/lib/assets/.claude/commands/analysis-domain-model.md +101 -0
  5. package/lib/assets/.claude/commands/analysis-non-functional.md +103 -0
  6. package/lib/assets/.claude/commands/analysis-operation.md +104 -0
  7. package/lib/assets/.claude/commands/analysis-requirements.md +100 -0
  8. package/lib/assets/.claude/commands/analysis-tech-stack.md +113 -0
  9. package/lib/assets/.claude/commands/analysis-test-strategy.md +101 -0
  10. package/lib/assets/.claude/commands/analysis-ui-design.md +100 -0
  11. package/lib/assets/.claude/commands/analysis-usecases.md +100 -0
  12. package/lib/assets/.claude/commands/analysis.md +49 -177
  13. package/lib/assets/.claude/commands/dev-backend.md +144 -0
  14. package/lib/assets/.claude/commands/dev-frontend.md +126 -0
  15. package/lib/assets/.claude/commands/dev.md +39 -49
  16. package/lib/assets/.claude/commands/docs.md +213 -0
  17. package/lib/assets/.claude/commands/plan-github.md +212 -0
  18. package/lib/assets/.claude/commands/plan.md +17 -0
  19. package/lib/assets/.claude/settings.json +3 -160
  20. package/lib/assets/docker-compose.yml +2 -2
  21. package/lib/assets/gulpfile.js +2 -2
  22. package/lib/assets/mkdocs.yml +3 -0
  23. package/lib/assets/{scripts → ops/scripts}/mkdocs.js +21 -3
  24. package/package.json +1 -1
  25. /package/lib/assets/{docs → ops/docker/mkdoc}/Dockerfile +0 -0
  26. /package/lib/assets/{scripts → ops/scripts}/journal.js +0 -0
@@ -0,0 +1,144 @@
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` : テスト実行と結果確認
@@ -0,0 +1,126 @@
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,43 +1,36 @@
1
1
  ## Development Guide Reference
2
2
 
3
- コーディングとテストガイドを参照し、TDD サイクルに従った開発を支援します。
3
+ 開発フェーズ全体の作業を支援するコマンド。TDD サイクルに従った開発ワークフローを表示します。
4
4
 
5
5
  ### 使い方
6
6
 
7
7
  ```bash
8
- /dev [オプション]
8
+ /dev
9
9
  ```
10
10
 
11
- ### オプション
12
-
13
- - なし : ガイド全体の要約と TDD サイクルの説明
14
- - `--tdd` : TDD の Red-Green-Refactor サイクルの詳細
15
- - `--approach` : インサイドアウト/アウトサイドインアプローチの選択指針
16
- - `--checklist` : コミット前の品質チェックリスト表示
17
- - `--refactor` : リファクタリングパターンの一覧
18
- - `--test` : テスト作成のベストプラクティス
19
-
20
11
  ### 基本例
21
12
 
22
13
  ```bash
23
- # TDD サイクルの開始
24
- /dev --tdd
25
- 「現在のタスクに対して Red-Green-Refactor サイクルを開始」
14
+ # 開発フェーズ全体のワークフロー表示
15
+ /dev
16
+ 「開発フェーズの全体的な進め方と TDD サイクルの説明」
17
+ ```
26
18
 
27
- # アプローチ戦略の確認
28
- /dev --approach
29
- 「実装アプローチ(インサイドアウト/アウトサイドイン)の選択を支援」
19
+ ### 詳細機能
30
20
 
31
- # 品質チェックの実行
32
- /dev --checklist
33
- 「コミット前の必須確認事項を順次実行」
21
+ #### 開発フェーズの全体像
34
22
 
35
- # リファクタリング支援
36
- /dev --refactor
37
- 「現在のコードに適用可能なリファクタリングパターンを提案」
38
- ```
23
+ 開発フェーズは以下の工程で構成されます:
39
24
 
40
- ### 詳細機能
25
+ 1. **バックエンド開発** (`/dev-backend`)
26
+ - Java/Kotlin での実装
27
+ - Gradle によるビルド・テスト
28
+ - インサイドアウトアプローチ推奨
29
+
30
+ 2. **フロントエンド開発** (`/dev-frontend`)
31
+ - TypeScript/React での実装
32
+ - npm によるビルド・テスト
33
+ - アウトサイドインアプローチ推奨
41
34
 
42
35
  #### TDD サイクルの実践
43
36
 
@@ -48,42 +41,40 @@ Red-Green-Refactor サイクルを厳密に実行:
48
41
  3. **Refactor フェーズ**: 重複を除去し設計を改善
49
42
  4. @docs/reference/コーディングとテストガイド.md のワークフローに従う
50
43
 
51
- ```bash
52
- # 新機能の TDD 実装開始
53
- /dev --tdd
54
- 「User エンティティのテストから開始します」
55
- ```
44
+ #### 参照ドキュメント
45
+
56
46
  - @docs/design/architecture_backend.md を参照
57
47
  - @docs/design/architecture_frontend.md を参照
58
48
  - @docs/design/data-model.md を参照
59
49
  - @docs/design/domain-model.md を参照
60
50
  - @docs/design/tech_stack.md を参照
51
+ - @docs/design/ui-design.md を参照
52
+ - @docs/design/test_strategy.md を参照
61
53
  - 作業完了後に対象のイテレーション @docs/development/iteration_plan-N.md の進捗を更新する
62
54
 
63
55
  #### アプローチ戦略の選択
64
56
 
65
57
  プロジェクトの状態に応じた最適なアプローチを選択:
66
58
 
67
- - **インサイドアウト**: データ層から開始し上位層へ展開
68
- - **アウトサイドイン**: UI から開始しドメインロジックを段階的に実装
59
+ - **インサイドアウト**: データ層から開始し上位層へ展開(バックエンド推奨)
60
+ - **アウトサイドイン**: UI から開始しドメインロジックを段階的に実装(フロントエンド推奨)
69
61
 
70
62
  ### Claude との連携
71
63
 
72
64
  ```bash
73
- # 現在のコードを分析してリファクタリング提案
74
- cat src/User.java
75
- /dev --refactor
76
- 「このクラスに適用可能なリファクタリングパターンを分析」
77
-
78
- # テストカバレッジを確認してテスト追加
79
- npm run test:coverage
80
- /dev --test
81
- 「カバレッジが低い箇所のテストを追加」
82
-
83
- # コミット前の品質確認
84
- git status
85
- /dev --checklist
86
- 「全ての品質基準を満たすまで確認を実行」
65
+ # プロジェクト情報の確認後に開発開始
66
+ ls -la apps/
67
+ cat README.md
68
+ /dev
69
+ 「プロジェクトの現状を踏まえた開発フェーズの進め方を提案」
70
+
71
+ # バックエンド開発の開始
72
+ /dev-backend --tdd
73
+ 「User エンティティのテストから開始します」
74
+
75
+ # フロントエンド開発の開始
76
+ /dev-frontend --tdd
77
+ 「LoginForm コンポーネントのテストから開始します」
87
78
  ```
88
79
 
89
80
  ### 注意事項
@@ -101,6 +92,5 @@ git status
101
92
 
102
93
  ### 関連コマンド
103
94
 
104
- - `/task` : タスク管理と TODO リストの作成
105
- - `/review` : コードレビューの実施
106
- - `/test` : テスト実行と結果確認
95
+ - `/dev-backend` : バックエンド開発ガイド
96
+ - `/dev-frontend` : フロントエンド開発ガイド
@@ -0,0 +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` : プロジェクト全体の進捗確認