@k2works/claude-code-booster 1.9.0 → 1.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.
- package/LICENSE +21 -21
- package/README.md +42 -42
- package/bin/claude-code-booster +79 -79
- package/lib/assets/.claude/README.md +162 -162
- package/lib/assets/.claude/SKILLS_TEMPLATE.md +100 -100
- package/lib/assets/.claude/scripts/generate-inception-deck.mjs +911 -1024
- package/lib/assets/.claude/settings.json +11 -11
- package/lib/assets/.claude/skills/ai-agent-guidelines/SKILL.md +119 -119
- package/lib/assets/.claude/skills/analyzing-architecture/SKILL.md +87 -87
- package/lib/assets/.claude/skills/analyzing-business/SKILL.md +117 -117
- package/lib/assets/.claude/skills/analyzing-data-model/SKILL.md +80 -80
- package/lib/assets/.claude/skills/analyzing-domain-model/SKILL.md +88 -88
- package/lib/assets/.claude/skills/analyzing-inception-deck/SKILL.md +137 -137
- package/lib/assets/.claude/skills/analyzing-non-functional/SKILL.md +91 -91
- package/lib/assets/.claude/skills/analyzing-operation/SKILL.md +91 -91
- package/lib/assets/.claude/skills/analyzing-requirements/SKILL.md +87 -87
- package/lib/assets/.claude/skills/analyzing-tech-stack/SKILL.md +102 -102
- package/lib/assets/.claude/skills/analyzing-test-strategy/SKILL.md +87 -87
- package/lib/assets/.claude/skills/analyzing-ui-design/SKILL.md +86 -86
- package/lib/assets/.claude/skills/analyzing-usecases/SKILL.md +87 -87
- package/lib/assets/.claude/skills/creating-adr/SKILL.md +115 -115
- package/lib/assets/.claude/skills/developing-backend/SKILL.md +106 -106
- package/lib/assets/.claude/skills/developing-frontend/SKILL.md +96 -96
- package/lib/assets/.claude/skills/developing-release/SKILL.md +154 -154
- package/lib/assets/.claude/skills/generating-slides/SKILL.md +136 -106
- package/lib/assets/.claude/skills/git-commit/SKILL.md +106 -106
- package/lib/assets/.claude/skills/killing-processes/SKILL.md +98 -98
- package/lib/assets/.claude/skills/managing-docs/SKILL.md +200 -200
- package/lib/assets/.claude/skills/managing-operations/DEPLOY.md +77 -77
- package/lib/assets/.claude/skills/managing-operations/SETUP_CSHARP.md +80 -80
- package/lib/assets/.claude/skills/managing-operations/SETUP_FRONTEND.md +84 -84
- package/lib/assets/.claude/skills/managing-operations/SETUP_JAVA.md +75 -75
- package/lib/assets/.claude/skills/managing-operations/SKILL.md +156 -156
- package/lib/assets/.claude/skills/orchestrating-analysis/SKILL.md +134 -134
- package/lib/assets/.claude/skills/orchestrating-development/SKILL.md +243 -243
- package/lib/assets/.claude/skills/orchestrating-project/SKILL.md +193 -193
- package/lib/assets/.claude/skills/planning-releases/SKILL.md +222 -222
- package/lib/assets/.claude/skills/syncing-github-project/SKILL.md +181 -69
- package/lib/assets/.claude/skills/tracking-progress/SKILL.md +164 -164
- package/lib/assets/.devcontainer/devcontainer.json +34 -34
- package/lib/assets/.env.example +17 -17
- package/lib/assets/.gitattributes +4 -4
- 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 +162 -162
- package/lib/assets/README.md +269 -269
- 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/CodexCLIMCP/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/351/226/213/347/231/272/343/203/225/343/203/255/343/203/274.md +532 -532
- package/lib/assets/docs/reference/CodexCLIMCP/343/202/265/343/203/274/343/203/220/343/203/274/350/250/255/345/256/232/346/211/213/351/240/206.md +341 -341
- 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 +578 -578
- 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 +465 -465
- package/lib/assets/docs/reference/UI/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +448 -448
- 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 +242 -242
- 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 +2216 -2216
- 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 +705 -705
- 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 +1313 -1313
- 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/223/343/202/270/343/203/215/343/202/271/343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243/345/210/206/346/236/220/343/202/254/343/202/244/343/203/211.md +528 -528
- 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 +682 -682
- 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 -442
- 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 +558 -558
- package/lib/assets/docs/reference//347/222/260/345/242/203/345/244/211/346/225/260/347/256/241/347/220/206/343/202/254/343/202/244/343/203/211.md +663 -663
- 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 +1236 -1236
- 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//343/203/223/343/202/270/343/203/215/343/202/271/343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243.md +379 -379
- 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/gulpfile.js +23 -23
- package/lib/assets/mkdocs.yml +65 -65
- package/lib/assets/ops/docker/mkdoc/Dockerfile +19 -19
- package/lib/assets/ops/scripts/journal.js +180 -180
- package/lib/assets/ops/scripts/mkdocs.js +82 -82
- package/lib/assets/ops/scripts/release.js +431 -431
- package/lib/assets/ops/scripts/ssh.js +190 -190
- package/lib/assets/ops/scripts/vault.js +299 -299
- package/lib/assets/package-lock.json +1653 -1653
- package/lib/assets/package.json +40 -40
- package/lib/gulpfile.js +37 -37
- package/package.json +41 -41
|
@@ -1,200 +1,200 @@
|
|
|
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` と 各ディレクトリの `index.md` を自動更新できます。
|
|
70
|
-
|
|
71
|
-
**docs/index.md の更新内容**:
|
|
72
|
-
|
|
73
|
-
- ドキュメント一覧をカテゴリ別に整理
|
|
74
|
-
- 各ドキュメントへのリンクと説明を生成
|
|
75
|
-
- 「まずこれを読もうリスト」形式で構成
|
|
76
|
-
|
|
77
|
-
**mkdocs.yml の更新内容**:
|
|
78
|
-
|
|
79
|
-
- `nav` セクションを現在のドキュメント構成に合わせて更新
|
|
80
|
-
- 要件定義、設計、開発、運用などのカテゴリで階層化
|
|
81
|
-
- 新しいドキュメントを自動的にナビゲーションに追加
|
|
82
|
-
|
|
83
|
-
**各ディレクトリの index.md の更新内容**:
|
|
84
|
-
|
|
85
|
-
- ドキュメント一覧をカテゴリ別に整理
|
|
86
|
-
- 各ドキュメントへのリンクと説明を生成
|
|
87
|
-
|
|
88
|
-
### 5. Lint 機能
|
|
89
|
-
|
|
90
|
-
`--lint` オプションを使用すると、Markdown ドキュメントのフォーマットをチェックし、違反を自動修正できます。
|
|
91
|
-
|
|
92
|
-
**チェックルール**:
|
|
93
|
-
|
|
94
|
-
- タスク項目(リスト)の前には空行が必要
|
|
95
|
-
- 番号付きリストのサブリスト前にも空行が必要
|
|
96
|
-
- コロンで終わる行の直後にリストがある場合も空行が必要
|
|
97
|
-
- 太字ラベル(半角・全角コロン両方)の直後にリストがある場合も空行が必要
|
|
98
|
-
|
|
99
|
-
**NG 例** - ラベルの直後にリスト:
|
|
100
|
-
|
|
101
|
-
```markdown
|
|
102
|
-
**受入条件**:
|
|
103
|
-
- [ ] ログアウトボタンをクリックするとログアウトできる
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
**OK 例**:
|
|
107
|
-
|
|
108
|
-
```markdown
|
|
109
|
-
**受入条件**:
|
|
110
|
-
|
|
111
|
-
- [ ] ログアウトボタンをクリックするとログアウトできる
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
**NG 例** - 番号付きリストの直後にサブリスト:
|
|
115
|
-
|
|
116
|
-
```markdown
|
|
117
|
-
1. **対処**: SMB バージョンを確認
|
|
118
|
-
- コントロールパネル > ファイルサービス > SMB で設定
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
**OK 例**:
|
|
122
|
-
|
|
123
|
-
```markdown
|
|
124
|
-
1. **対処**: SMB バージョンを確認
|
|
125
|
-
|
|
126
|
-
- コントロールパネル > ファイルサービス > SMB で設定
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
**NG 例** - コロンで終わる行の直後にリスト:
|
|
130
|
-
|
|
131
|
-
```markdown
|
|
132
|
-
PMD はカスタム設定で以下をチェック:
|
|
133
|
-
- マジックナンバーの使用
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
**OK 例**:
|
|
137
|
-
|
|
138
|
-
```markdown
|
|
139
|
-
PMD はカスタム設定で以下をチェック:
|
|
140
|
-
|
|
141
|
-
- マジックナンバーの使用
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
**実行手順**:
|
|
145
|
-
|
|
146
|
-
1. `docs/` 配下の全 Markdown ファイルをスキャン
|
|
147
|
-
2. 上記ルールに違反する箇所を検出
|
|
148
|
-
3. 違反箇所を自動修正
|
|
149
|
-
4. 修正結果を報告
|
|
150
|
-
|
|
151
|
-
### 6. 出力例
|
|
152
|
-
|
|
153
|
-
```
|
|
154
|
-
設計ドキュメント一覧
|
|
155
|
-
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
156
|
-
|
|
157
|
-
docs/requirements/
|
|
158
|
-
├─ requirements_definition.md (要件定義書)
|
|
159
|
-
├─ business_usecase.md (ビジネスユースケース)
|
|
160
|
-
├─ system_usecase.md (システムユースケース)
|
|
161
|
-
└─ user_story.md (ユーザーストーリー)
|
|
162
|
-
|
|
163
|
-
docs/design/
|
|
164
|
-
├─ architecture_backend.md (バックエンドアーキテクチャ)
|
|
165
|
-
├─ architecture_frontend.md (フロントエンドアーキテクチャ)
|
|
166
|
-
├─ data-model.md (データモデル設計)
|
|
167
|
-
├─ domain-model.md (ドメインモデル設計)
|
|
168
|
-
├─ ui-design.md (UI 設計)
|
|
169
|
-
├─ test_strategy.md (テスト戦略)
|
|
170
|
-
├─ non_functional.md (非機能要件)
|
|
171
|
-
├─ operation.md (運用要件)
|
|
172
|
-
└─ tech_stack.md (技術スタック選定)
|
|
173
|
-
|
|
174
|
-
進捗: 14/14 ドキュメント完成 (100%)
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
### 7. 注意事項
|
|
178
|
-
|
|
179
|
-
- **前提条件**: `docs/` ディレクトリが存在すること
|
|
180
|
-
- **制限事項**: Markdown 形式のドキュメントのみ対応
|
|
181
|
-
- **推奨事項**: 定期的にドキュメントの進捗を確認し、最新の状態を維持すること
|
|
182
|
-
- **更新時の注意**: `--update` 実行前に現在の `docs/index.md` と `mkdocs.yml` をバックアップすることを推奨
|
|
183
|
-
- **MkDocs 依存**: `--update-mkdocs` を使用する場合、MkDocs がインストールされている必要がある
|
|
184
|
-
|
|
185
|
-
### 8. ベストプラクティス
|
|
186
|
-
|
|
187
|
-
1. **定期確認**: 開発フェーズ移行前にドキュメントの完成度を確認する
|
|
188
|
-
2. **整合性維持**: コード変更時は関連ドキュメントも更新する
|
|
189
|
-
3. **レビュー活用**: チームレビュー前にドキュメント概要を共有する
|
|
190
|
-
4. **バージョン管理**: ドキュメントの変更は Git でコミットする
|
|
191
|
-
5. **インデックス同期**: 新しいドキュメント作成後は `--update` でインデックスを同期する
|
|
192
|
-
6. **プレビュー確認**: `--update-mkdocs` 後は `mkdocs serve` でナビゲーションを確認する
|
|
193
|
-
7. **フォーマット統一**: コミット前に `--lint` でフォーマットの一貫性を確保する
|
|
194
|
-
|
|
195
|
-
### 関連スキル
|
|
196
|
-
|
|
197
|
-
- `orchestrating-analysis` : 分析フェーズ全体の作業支援
|
|
198
|
-
- `analyzing-requirements` : 要件定義関連の作業支援
|
|
199
|
-
- `analyzing-architecture` : アーキテクチャ設計支援
|
|
200
|
-
- `tracking-progress` : プロジェクト全体の進捗確認
|
|
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` と 各ディレクトリの `index.md` を自動更新できます。
|
|
70
|
+
|
|
71
|
+
**docs/index.md の更新内容**:
|
|
72
|
+
|
|
73
|
+
- ドキュメント一覧をカテゴリ別に整理
|
|
74
|
+
- 各ドキュメントへのリンクと説明を生成
|
|
75
|
+
- 「まずこれを読もうリスト」形式で構成
|
|
76
|
+
|
|
77
|
+
**mkdocs.yml の更新内容**:
|
|
78
|
+
|
|
79
|
+
- `nav` セクションを現在のドキュメント構成に合わせて更新
|
|
80
|
+
- 要件定義、設計、開発、運用などのカテゴリで階層化
|
|
81
|
+
- 新しいドキュメントを自動的にナビゲーションに追加
|
|
82
|
+
|
|
83
|
+
**各ディレクトリの index.md の更新内容**:
|
|
84
|
+
|
|
85
|
+
- ドキュメント一覧をカテゴリ別に整理
|
|
86
|
+
- 各ドキュメントへのリンクと説明を生成
|
|
87
|
+
|
|
88
|
+
### 5. Lint 機能
|
|
89
|
+
|
|
90
|
+
`--lint` オプションを使用すると、Markdown ドキュメントのフォーマットをチェックし、違反を自動修正できます。
|
|
91
|
+
|
|
92
|
+
**チェックルール**:
|
|
93
|
+
|
|
94
|
+
- タスク項目(リスト)の前には空行が必要
|
|
95
|
+
- 番号付きリストのサブリスト前にも空行が必要
|
|
96
|
+
- コロンで終わる行の直後にリストがある場合も空行が必要
|
|
97
|
+
- 太字ラベル(半角・全角コロン両方)の直後にリストがある場合も空行が必要
|
|
98
|
+
|
|
99
|
+
**NG 例** - ラベルの直後にリスト:
|
|
100
|
+
|
|
101
|
+
```markdown
|
|
102
|
+
**受入条件**:
|
|
103
|
+
- [ ] ログアウトボタンをクリックするとログアウトできる
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
**OK 例**:
|
|
107
|
+
|
|
108
|
+
```markdown
|
|
109
|
+
**受入条件**:
|
|
110
|
+
|
|
111
|
+
- [ ] ログアウトボタンをクリックするとログアウトできる
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
**NG 例** - 番号付きリストの直後にサブリスト:
|
|
115
|
+
|
|
116
|
+
```markdown
|
|
117
|
+
1. **対処**: SMB バージョンを確認
|
|
118
|
+
- コントロールパネル > ファイルサービス > SMB で設定
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
**OK 例**:
|
|
122
|
+
|
|
123
|
+
```markdown
|
|
124
|
+
1. **対処**: SMB バージョンを確認
|
|
125
|
+
|
|
126
|
+
- コントロールパネル > ファイルサービス > SMB で設定
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
**NG 例** - コロンで終わる行の直後にリスト:
|
|
130
|
+
|
|
131
|
+
```markdown
|
|
132
|
+
PMD はカスタム設定で以下をチェック:
|
|
133
|
+
- マジックナンバーの使用
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
**OK 例**:
|
|
137
|
+
|
|
138
|
+
```markdown
|
|
139
|
+
PMD はカスタム設定で以下をチェック:
|
|
140
|
+
|
|
141
|
+
- マジックナンバーの使用
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
**実行手順**:
|
|
145
|
+
|
|
146
|
+
1. `docs/` 配下の全 Markdown ファイルをスキャン
|
|
147
|
+
2. 上記ルールに違反する箇所を検出
|
|
148
|
+
3. 違反箇所を自動修正
|
|
149
|
+
4. 修正結果を報告
|
|
150
|
+
|
|
151
|
+
### 6. 出力例
|
|
152
|
+
|
|
153
|
+
```
|
|
154
|
+
設計ドキュメント一覧
|
|
155
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
156
|
+
|
|
157
|
+
docs/requirements/
|
|
158
|
+
├─ requirements_definition.md (要件定義書)
|
|
159
|
+
├─ business_usecase.md (ビジネスユースケース)
|
|
160
|
+
├─ system_usecase.md (システムユースケース)
|
|
161
|
+
└─ user_story.md (ユーザーストーリー)
|
|
162
|
+
|
|
163
|
+
docs/design/
|
|
164
|
+
├─ architecture_backend.md (バックエンドアーキテクチャ)
|
|
165
|
+
├─ architecture_frontend.md (フロントエンドアーキテクチャ)
|
|
166
|
+
├─ data-model.md (データモデル設計)
|
|
167
|
+
├─ domain-model.md (ドメインモデル設計)
|
|
168
|
+
├─ ui-design.md (UI 設計)
|
|
169
|
+
├─ test_strategy.md (テスト戦略)
|
|
170
|
+
├─ non_functional.md (非機能要件)
|
|
171
|
+
├─ operation.md (運用要件)
|
|
172
|
+
└─ tech_stack.md (技術スタック選定)
|
|
173
|
+
|
|
174
|
+
進捗: 14/14 ドキュメント完成 (100%)
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### 7. 注意事項
|
|
178
|
+
|
|
179
|
+
- **前提条件**: `docs/` ディレクトリが存在すること
|
|
180
|
+
- **制限事項**: Markdown 形式のドキュメントのみ対応
|
|
181
|
+
- **推奨事項**: 定期的にドキュメントの進捗を確認し、最新の状態を維持すること
|
|
182
|
+
- **更新時の注意**: `--update` 実行前に現在の `docs/index.md` と `mkdocs.yml` をバックアップすることを推奨
|
|
183
|
+
- **MkDocs 依存**: `--update-mkdocs` を使用する場合、MkDocs がインストールされている必要がある
|
|
184
|
+
|
|
185
|
+
### 8. ベストプラクティス
|
|
186
|
+
|
|
187
|
+
1. **定期確認**: 開発フェーズ移行前にドキュメントの完成度を確認する
|
|
188
|
+
2. **整合性維持**: コード変更時は関連ドキュメントも更新する
|
|
189
|
+
3. **レビュー活用**: チームレビュー前にドキュメント概要を共有する
|
|
190
|
+
4. **バージョン管理**: ドキュメントの変更は Git でコミットする
|
|
191
|
+
5. **インデックス同期**: 新しいドキュメント作成後は `--update` でインデックスを同期する
|
|
192
|
+
6. **プレビュー確認**: `--update-mkdocs` 後は `mkdocs serve` でナビゲーションを確認する
|
|
193
|
+
7. **フォーマット統一**: コミット前に `--lint` でフォーマットの一貫性を確保する
|
|
194
|
+
|
|
195
|
+
### 関連スキル
|
|
196
|
+
|
|
197
|
+
- `orchestrating-analysis` : 分析フェーズ全体の作業支援
|
|
198
|
+
- `analyzing-requirements` : 要件定義関連の作業支援
|
|
199
|
+
- `analyzing-architecture` : アーキテクチャ設計支援
|
|
200
|
+
- `tracking-progress` : プロジェクト全体の進捗確認
|
|
@@ -1,77 +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
|
-
```
|
|
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
|
+
```
|